Amazon Comprehend · JSON Structure

Openapi.Yml Input Data Config Structure

The input properties for an inference job. The document reader config field applies only to non-text inputs for custom analysis.

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

InputDataConfig 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 InputFormat DocumentReaderConfig

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-input-data-config-structure.json",
  "name": "InputDataConfig",
  "description": "The input properties for an inference job. The document reader config field applies only to non-text inputs for custom analysis.",
  "type": "object",
  "properties": {
    "S3Uri": {
      "allOf": [
        {
          "$ref": "#/components/schemas/S3Uri"
        },
        {
          "description": "<p>The Amazon S3 URI for the input data. The URI must be in same Region as the API endpoint that you are calling. The URI can point to a single input file or it can provide the prefix for a collection of data files. </p> <p>For example, if you use the URI <code>S3://bucketName/prefix</code>, if the prefix is a single file, Amazon Comprehend uses that file as input. If more than one file begins with the prefix, Amazon Comprehend uses all of them as input.</p>"
        }
      ]
    },
    "InputFormat": {
      "allOf": [
        {
          "$ref": "#/components/schemas/InputFormat"
        },
        {
          "description": "<p>Specifies how the text in an input file should be processed:</p> <ul> <li> <p> <code>ONE_DOC_PER_FILE</code> - Each file is considered a separate document. Use this option when you are processing large documents, such as newspaper articles or scientific papers.</p> </li> <li> <p> <code>ONE_DOC_PER_LINE</code> - Each line in a file is considered a separate document. Use this option when you are processing many short documents, such as text messages.</p> </li> </ul>"
        }
      ]
    },
    "DocumentReaderConfig": {
      "allOf": [
        {
          "$ref": "#/components/schemas/DocumentReaderConfig"
        },
        {
          "description": "Provides configuration parameters to override the default actions for extracting text from PDF documents and image files."
        }
      ]
    }
  },
  "required": [
    "S3Uri"
  ]
}