Amazon Comprehend · JSON Structure

Openapi.Yml Targeted Sentiment Mention Structure

Information about one mention of an entity. The mention information includes the location of the mention in the text and the sentiment of the mention.

For more information about targeted sentiment, see Targeted sentiment.

Type: object Properties: 7
Machine LearningNatural Language ProcessingNLPText Analysis

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

Properties

Score GroupScore Text Type MentionSentiment BeginOffset EndOffset

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-targeted-sentiment-mention-structure.json",
  "name": "TargetedSentimentMention",
  "description": "<p>Information about one mention of an entity. The mention information includes the location of the mention in the text and the sentiment of the mention.</p> <p>For more information about targeted sentiment, see <a href=\"https://docs.aws.amazon.com/comprehend/latest/dg/how-targeted-sentiment.html\">Targeted sentiment</a>.</p>",
  "type": "object",
  "properties": {
    "Score": {
      "allOf": [
        {
          "$ref": "#/components/schemas/Float"
        },
        {
          "description": "Model confidence that the entity is relevant. Value range is zero to one, where one is highest confidence."
        }
      ]
    },
    "GroupScore": {
      "allOf": [
        {
          "$ref": "#/components/schemas/Float"
        },
        {
          "description": "The confidence that all the entities mentioned in the group relate to the same entity."
        }
      ]
    },
    "Text": {
      "allOf": [
        {
          "$ref": "#/components/schemas/String"
        },
        {
          "description": "The text in the document that identifies the entity."
        }
      ]
    },
    "Type": {
      "allOf": [
        {
          "$ref": "#/components/schemas/TargetedSentimentEntityType"
        },
        {
          "description": "The type of the entity. Amazon Comprehend supports a variety of <a href=\"https://docs.aws.amazon.com/comprehend/latest/dg/how-targeted-sentiment.html#how-targeted-sentiment-entities\">entity types</a>."
        }
      ]
    },
    "MentionSentiment": {
      "allOf": [
        {
          "$ref": "#/components/schemas/MentionSentiment"
        },
        {
          "description": "Contains the sentiment and sentiment score for the mention."
        }
      ]
    },
    "BeginOffset": {
      "allOf": [
        {
          "$ref": "#/components/schemas/Integer"
        },
        {
          "description": "The offset into the document text where the mention begins."
        }
      ]
    },
    "EndOffset": {
      "allOf": [
        {
          "$ref": "#/components/schemas/Integer"
        },
        {
          "description": "The offset into the document text where the mention ends."
        }
      ]
    }
  }
}