Skip to content

Create Document Classifier

comprehend_create_document_classifier R Documentation

Creates a new document classifier that you can use to categorize documents

Description

Creates a new document classifier that you can use to categorize documents. To create a classifier, you provide a set of training documents that are labeled with the categories that you want to use. For more information, see Training classifier models in the Comprehend Developer Guide.

Usage

comprehend_create_document_classifier(DocumentClassifierName,
  VersionName, DataAccessRoleArn, Tags, InputDataConfig, OutputDataConfig,
  ClientRequestToken, LanguageCode, VolumeKmsKeyId, VpcConfig, Mode,
  ModelKmsKeyId, ModelPolicy)

Arguments

DocumentClassifierName

[required] The name of the document classifier.

VersionName

The version name given to the newly created classifier. Version names can have a maximum of 256 characters. Alphanumeric characters, hyphens (-) and underscores (_) are allowed. The version name must be unique among all models with the same classifier name in the Amazon Web Services account/Amazon Web Services Region.

DataAccessRoleArn

[required] The Amazon Resource Name (ARN) of the IAM role that grants Amazon Comprehend read access to your input data.

Tags

Tags to associate with the document classifier. A tag is a key-value pair that adds as a metadata to a resource used by Amazon Comprehend. For example, a tag with "Sales" as the key might be added to a resource to indicate its use by the sales department.

InputDataConfig

[required] Specifies the format and location of the input data for the job.

OutputDataConfig

Specifies the location for the output files from a custom classifier job. This parameter is required for a request that creates a native document model.

ClientRequestToken

A unique identifier for the request. If you don't set the client request token, Amazon Comprehend generates one.

LanguageCode

[required] The language of the input documents. You can specify any of the languages supported by Amazon Comprehend. All documents must be in the same language.

VolumeKmsKeyId

ID for the Amazon Web Services Key Management Service (KMS) key that Amazon Comprehend uses to encrypt data on the storage volume attached to the ML compute instance(s) that process the analysis job. The VolumeKmsKeyId can be either of the following formats:

  • KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab"

  • Amazon Resource Name (ARN) of a KMS Key: "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"

VpcConfig

Configuration parameters for an optional private Virtual Private Cloud (VPC) containing the resources you are using for your custom classifier. For more information, see Amazon VPC.

Mode

Indicates the mode in which the classifier will be trained. The classifier can be trained in multi-class (single-label) mode or multi-label mode. Multi-class mode identifies a single class label for each document and multi-label mode identifies one or more class labels for each document. Multiple labels for an individual document are separated by a delimiter. The default delimiter between labels is a pipe (|).

ModelKmsKeyId

ID for the KMS key that Amazon Comprehend uses to encrypt trained custom models. The ModelKmsKeyId can be either of the following formats:

  • KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab"

  • Amazon Resource Name (ARN) of a KMS Key: "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"

ModelPolicy

The resource-based policy to attach to your custom document classifier model. You can use this policy to allow another Amazon Web Services account to import your custom model.

Provide your policy as a JSON body that you enter as a UTF-8 encoded string without line breaks. To provide valid JSON, enclose the attribute names and values in double quotes. If the JSON body is also enclosed in double quotes, then you must escape the double quotes that are inside the policy:

⁠"{\"attribute\": \"value\", \"attribute\": [\"value\"]}"⁠

To avoid escaping quotes, you can use single quotes to enclose the policy and double quotes to enclose the JSON names and values:

'{"attribute": "value", "attribute": ["value"]}'

Value

A list with the following syntax: 

list(
  DocumentClassifierArn = "string"
)

Request syntax

svc$create_document_classifier(
  DocumentClassifierName = "string",
  VersionName = "string",
  DataAccessRoleArn = "string",
  Tags = list(
    list(
      Key = "string",
      Value = "string"
    )
  ),
  InputDataConfig = list(
    DataFormat = "COMPREHEND_CSV"|"AUGMENTED_MANIFEST",
    S3Uri = "string",
    TestS3Uri = "string",
    LabelDelimiter = "string",
    AugmentedManifests = list(
      list(
        S3Uri = "string",
        Split = "TRAIN"|"TEST",
        AttributeNames = list(
          "string"
        ),
        AnnotationDataS3Uri = "string",
        SourceDocumentsS3Uri = "string",
        DocumentType = "PLAIN_TEXT_DOCUMENT"|"SEMI_STRUCTURED_DOCUMENT"
      )
    ),
    DocumentType = "PLAIN_TEXT_DOCUMENT"|"SEMI_STRUCTURED_DOCUMENT",
    Documents = list(
      S3Uri = "string",
      TestS3Uri = "string"
    ),
    DocumentReaderConfig = list(
      DocumentReadAction = "TEXTRACT_DETECT_DOCUMENT_TEXT"|"TEXTRACT_ANALYZE_DOCUMENT",
      DocumentReadMode = "SERVICE_DEFAULT"|"FORCE_DOCUMENT_READ_ACTION",
      FeatureTypes = list(
        "TABLES"|"FORMS"
      )
    )
  ),
  OutputDataConfig = list(
    S3Uri = "string",
    KmsKeyId = "string",
    FlywheelStatsS3Prefix = "string"
  ),
  ClientRequestToken = "string",
  LanguageCode = "en"|"es"|"fr"|"de"|"it"|"pt"|"ar"|"hi"|"ja"|"ko"|"zh"|"zh-TW",
  VolumeKmsKeyId = "string",
  VpcConfig = list(
    SecurityGroupIds = list(
      "string"
    ),
    Subnets = list(
      "string"
    )
  ),
  Mode = "MULTI_CLASS"|"MULTI_LABEL",
  ModelKmsKeyId = "string",
  ModelPolicy = "string"
)