Amazon Comprehend · JSON Structure

Openapi.Yml Entity Recognizer Documents Structure

Describes the training documents submitted with an entity recognizer.

Type: object Properties: 3 Required: 1
Machine LearningNatural Language ProcessingNLPText Analysis

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

Properties

S3Uri TestS3Uri InputFormat

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-entity-recognizer-documents-structure.json",
  "name": "EntityRecognizerDocuments",
  "description": "Describes the training documents submitted with an entity recognizer.",
  "type": "object",
  "properties": {
    "S3Uri": {
      "allOf": [
        {
          "$ref": "#/components/schemas/S3Uri"
        },
        {
          "description": " Specifies the Amazon S3 location where the training documents for an entity recognizer are located. The URI must be in the same Region as the API endpoint that you are calling."
        }
      ]
    },
    "TestS3Uri": {
      "allOf": [
        {
          "$ref": "#/components/schemas/S3Uri"
        },
        {
          "description": " Specifies the Amazon S3 location where the test documents for an entity recognizer are located. The URI must be in the same Amazon Web Services Region as the API endpoint that you are calling."
        }
      ]
    },
    "InputFormat": {
      "allOf": [
        {
          "$ref": "#/components/schemas/InputFormat"
        },
        {
          "description": " Specifies how the text in an input file should be processed. This is optional, and the default is ONE_DOC_PER_LINE. ONE_DOC_PER_FILE - Each file is considered a separate document. Use this option when you are processing large documents, such as newspaper articles or scientific papers. ONE_DOC_PER_LINE - Each line in a file is considered a separate document. Use this option when you are processing many short documents, such as text messages."
        }
      ]
    }
  },
  "required": [
    "S3Uri"
  ]
}