Amazon Comprehend · Schema

BatchDetectKeyPhrasesResponse

BatchDetectKeyPhrasesResponse schema

Machine LearningNatural Language ProcessingNLPText Analysis

Properties

Name Type Description
ResultList object
ErrorList object
View JSON Schema on GitHub

JSON Schema

openapi.yml-batch-detect-key-phrases-response-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/amazon-comprehend/refs/heads/main/json-schema/openapi.yml-batch-detect-key-phrases-response-schema.json",
  "title": "BatchDetectKeyPhrasesResponse",
  "description": "BatchDetectKeyPhrasesResponse schema",
  "type": "object",
  "properties": {
    "ResultList": {
      "allOf": [
        {
          "$ref": "#/components/schemas/ListOfDetectKeyPhrasesResult"
        },
        {
          "description": "A list of objects containing the results of the operation. The results are sorted in ascending order by the <code>Index</code> field and match the order of the documents in the input list. If all of the documents contain an error, the <code>ResultList</code> is empty."
        }
      ]
    },
    "ErrorList": {
      "allOf": [
        {
          "$ref": "#/components/schemas/BatchItemErrorList"
        },
        {
          "description": "A list containing one object for each document that contained an error. The results are sorted in ascending order by the <code>Index</code> field and match the order of the documents in the input list. If there are no errors in the batch, the <code>ErrorList</code> is empty."
        }
      ]
    }
  },
  "required": [
    "ResultList",
    "ErrorList"
  ]
}