Amazon Comprehend · JSON Structure

Openapi.Yml Batch Detect Syntax Response Structure

BatchDetectSyntaxResponse schema

Type: object Properties: 2 Required: 2
Machine LearningNatural Language ProcessingNLPText Analysis

BatchDetectSyntaxResponse is a JSON Structure definition published by Amazon Comprehend, describing 2 properties, of which 2 are required. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

ResultList ErrorList

Meta-schema: https://json-structure.org/meta/core/v0/#

JSON Structure

Raw ↑ 
{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/amazon-comprehend/refs/heads/main/json-structure/openapi.yml-batch-detect-syntax-response-structure.json",
  "name": "BatchDetectSyntaxResponse",
  "description": "BatchDetectSyntaxResponse schema",
  "type": "object",
  "properties": {
    "ResultList": {
      "allOf": [
        {
          "$ref": "#/components/schemas/ListOfDetectSyntaxResult"
        },
        {
          "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"
  ]
}