createDocumentClassifier method

Future<CreateDocumentClassifierResponse> createDocumentClassifier({ required String dataAccessRoleArn, required String documentClassifierName, required DocumentClassifierInputDataConfig inputDataConfig, required LanguageCode languageCode, String? clientRequestToken, DocumentClassifierMode? mode, DocumentClassifierOutputDataConfig? outputDataConfig, List<Tag>? tags, String? volumeKmsKeyId, VpcConfig? vpcConfig, })

Creates a new document classifier that you can use to categorize documents. To create a classifier, you provide a set of training documents that labeled with the categories that you want to use. After the classifier is trained you can use it to categorize a set of labeled documents into the categories. For more information, see how-document-classification.

May throw InvalidRequestException. May throw ResourceInUseException. May throw TooManyTagsException. May throw TooManyRequestsException. May throw ResourceLimitExceededException. May throw UnsupportedLanguageException. May throw KmsKeyValidationException. May throw InternalServerException.

Parameter dataAccessRoleArn : The Amazon Resource Name (ARN) of the AWS Identity and Management (IAM) role that grants Amazon Comprehend read access to your input data.

Parameter documentClassifierName : The name of the document classifier.

Parameter inputDataConfig : Specifies the format and location of the input data for the job.

Parameter languageCode : The language of the input documents. You can specify any of the following languages supported by Amazon Comprehend: German ("de"), English ("en"), Spanish ("es"), French ("fr"), Italian ("it"), or Portuguese ("pt"). All documents must be in the same language.

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

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

Parameter outputDataConfig : Enables the addition of output results configuration parameters for custom classifier jobs.

Parameter tags : Tags to be associated with the document classifier being created. 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.

Parameter volumeKmsKeyId : ID for the AWS 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"

Parameter 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.

Implementation

Future<CreateDocumentClassifierResponse> createDocumentClassifier({
  required String dataAccessRoleArn,
  required String documentClassifierName,
  required DocumentClassifierInputDataConfig inputDataConfig,
  required LanguageCode languageCode,
  String? clientRequestToken,
  DocumentClassifierMode? mode,
  DocumentClassifierOutputDataConfig? outputDataConfig,
  List<Tag>? tags,
  String? volumeKmsKeyId,
  VpcConfig? vpcConfig,
}) async {
  ArgumentError.checkNotNull(dataAccessRoleArn, 'dataAccessRoleArn');
  _s.validateStringLength(
    'dataAccessRoleArn',
    dataAccessRoleArn,
    20,
    2048,
    isRequired: true,
  );
  ArgumentError.checkNotNull(
      documentClassifierName, 'documentClassifierName');
  _s.validateStringLength(
    'documentClassifierName',
    documentClassifierName,
    0,
    63,
    isRequired: true,
  );
  ArgumentError.checkNotNull(inputDataConfig, 'inputDataConfig');
  ArgumentError.checkNotNull(languageCode, 'languageCode');
  _s.validateStringLength(
    'clientRequestToken',
    clientRequestToken,
    1,
    64,
  );
  _s.validateStringLength(
    'volumeKmsKeyId',
    volumeKmsKeyId,
    0,
    2048,
  );
  final headers = <String, String>{
    'Content-Type': 'application/x-amz-json-1.1',
    'X-Amz-Target': 'Comprehend_20171127.CreateDocumentClassifier'
  };
  final jsonResponse = await _protocol.send(
    method: 'POST',
    requestUri: '/',
    exceptionFnMap: _exceptionFns,
    // TODO queryParams
    headers: headers,
    payload: {
      'DataAccessRoleArn': dataAccessRoleArn,
      'DocumentClassifierName': documentClassifierName,
      'InputDataConfig': inputDataConfig,
      'LanguageCode': languageCode.toValue(),
      'ClientRequestToken':
          clientRequestToken ?? _s.generateIdempotencyToken(),
      if (mode != null) 'Mode': mode.toValue(),
      if (outputDataConfig != null) 'OutputDataConfig': outputDataConfig,
      if (tags != null) 'Tags': tags,
      if (volumeKmsKeyId != null) 'VolumeKmsKeyId': volumeKmsKeyId,
      if (vpcConfig != null) 'VpcConfig': vpcConfig,
    },
  );

  return CreateDocumentClassifierResponse.fromJson(jsonResponse.body);
}