Amazon Comprehend · JSON Structure

Openapi.Yml Batch Detect Sentiment Item Result Structure

The result of calling the operation. The operation returns one object for each document that is successfully processed by the operation.

Type: object Properties: 3
Machine LearningNatural Language ProcessingNLPText Analysis

BatchDetectSentimentItemResult is a JSON Structure definition published by Amazon Comprehend, describing 3 properties. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

Index Sentiment SentimentScore

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-sentiment-item-result-structure.json",
  "name": "BatchDetectSentimentItemResult",
  "description": "The result of calling the operation. The operation returns one object for each document that is successfully processed by the operation.",
  "type": "object",
  "properties": {
    "Index": {
      "allOf": [
        {
          "$ref": "#/components/schemas/Integer"
        },
        {
          "description": "The zero-based index of the document in the input list."
        }
      ]
    },
    "Sentiment": {
      "allOf": [
        {
          "$ref": "#/components/schemas/SentimentType"
        },
        {
          "description": "The sentiment detected in the document."
        }
      ]
    },
    "SentimentScore": {
      "allOf": [
        {
          "$ref": "#/components/schemas/SentimentScore"
        },
        {
          "description": "The level of confidence that Amazon Comprehend has in the accuracy of its sentiment detection."
        }
      ]
    }
  }
}