Amazon Comprehend · JSON Structure

Openapi.Yml Detect Key Phrases Request Structure

DetectKeyPhrasesRequest schema

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

DetectKeyPhrasesRequest 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

Text LanguageCode

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-detect-key-phrases-request-structure.json",
  "name": "DetectKeyPhrasesRequest",
  "description": "DetectKeyPhrasesRequest schema",
  "type": "object",
  "properties": {
    "Text": {
      "allOf": [
        {
          "$ref": "#/components/schemas/CustomerInputString"
        },
        {
          "description": "A UTF-8 text string. The string must contain less than 100 KB of UTF-8 encoded characters."
        }
      ]
    },
    "LanguageCode": {
      "allOf": [
        {
          "$ref": "#/components/schemas/LanguageCode"
        },
        {
          "description": "The language of the input documents. You can specify any of the primary languages supported by Amazon Comprehend. All documents must be in the same language."
        }
      ]
    }
  },
  "required": [
    "Text",
    "LanguageCode"
  ]
}