Amazon Comprehend · JSON Structure

Openapi.Yml Dataset Document Classifier Input Data Config Structure

Describes the dataset input data configuration for a document classifier model.

For more information on how the input file is formatted, see Preparing training data in the Comprehend Developer Guide.

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

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

Properties

S3Uri LabelDelimiter

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-dataset-document-classifier-input-data-config-structure.json",
  "name": "DatasetDocumentClassifierInputDataConfig",
  "description": "<p>Describes the dataset input data configuration for a document classifier model.</p> <p>For more information on how the input file is formatted, see <a href=\"https://docs.aws.amazon.com/comprehend/latest/dg/prep-classifier-data.html\">Preparing training data</a> in the Comprehend Developer Guide. </p>",
  "type": "object",
  "properties": {
    "S3Uri": {
      "allOf": [
        {
          "$ref": "#/components/schemas/S3Uri"
        },
        {
          "description": "<p>The Amazon S3 URI for the input data. The S3 bucket must be in the 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 input 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> <p>This parameter is required if you set <code>DataFormat</code> to <code>COMPREHEND_CSV</code>.</p>"
        }
      ]
    },
    "LabelDelimiter": {
      "allOf": [
        {
          "$ref": "#/components/schemas/LabelDelimiter"
        },
        {
          "description": "Indicates the delimiter used to separate each label for training a multi-label classifier. The default delimiter between labels is a pipe (|). You can use a different character as a delimiter (if it's an allowed character) by specifying it under Delimiter for labels. If the training documents use a delimiter other than the default or the delimiter you specify, the labels on that line will be combined to make a single unique label, such as LABELLABELLABEL."
        }
      ]
    }
  },
  "required": [
    "S3Uri"
  ]
}