Amazon Comprehend · Schema

DatasetDocumentClassifierInputDataConfig

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.

Machine LearningNatural Language ProcessingNLPText Analysis

Properties

Name Type Description
S3Uri object
LabelDelimiter object
View JSON Schema on GitHub

JSON Schema

openapi.yml-dataset-document-classifier-input-data-config-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/amazon-comprehend/refs/heads/main/json-schema/openapi.yml-dataset-document-classifier-input-data-config-schema.json",
  "title": "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"
  ]
}