Amazon Comprehend · JSON Structure

Openapi.Yml Key Phrase Structure

Describes a key noun phrase.

Type: object Properties: 4
Machine LearningNatural Language ProcessingNLPText Analysis

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

Properties

Score Text 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-key-phrase-structure.json",
  "name": "KeyPhrase",
  "description": "Describes a key noun phrase.",
  "type": "object",
  "properties": {
    "Score": {
      "allOf": [
        {
          "$ref": "#/components/schemas/Float"
        },
        {
          "description": "The level of confidence that Amazon Comprehend has in the accuracy of the detection."
        }
      ]
    },
    "Text": {
      "allOf": [
        {
          "$ref": "#/components/schemas/String"
        },
        {
          "description": "The text of a key noun phrase."
        }
      ]
    },
    "BeginOffset": {
      "allOf": [
        {
          "$ref": "#/components/schemas/Integer"
        },
        {
          "description": "The zero-based offset from the beginning of the source text to the first character in the key phrase."
        }
      ]
    },
    "EndOffset": {
      "allOf": [
        {
          "$ref": "#/components/schemas/Integer"
        },
        {
          "description": "The zero-based offset from the beginning of the source text to the last character in the key phrase."
        }
      ]
    }
  }
}