Package software.amazon.awssdk.services.comprehend.model

Interface DocumentClassifierProperties.Builder

All Superinterfaces:
Buildable, CopyableBuilder<DocumentClassifierProperties.Builder,DocumentClassifierProperties>, SdkBuilder<DocumentClassifierProperties.Builder,DocumentClassifierProperties>, SdkPojo
Enclosing class:
DocumentClassifierProperties
public static interface DocumentClassifierProperties.Builder extends SdkPojo, CopyableBuilder<DocumentClassifierProperties.Builder,DocumentClassifierProperties>

  • Method Details

    • documentClassifierArn

      DocumentClassifierProperties.Builder documentClassifierArn(String documentClassifierArn)

      The Amazon Resource Name (ARN) that identifies the document classifier.

      Parameters:
      documentClassifierArn - The Amazon Resource Name (ARN) that identifies the document classifier.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • languageCode

      DocumentClassifierProperties.Builder languageCode(String languageCode)

      The language code for the language of the documents that the classifier was trained on.

      Parameters:
      languageCode - The language code for the language of the documents that the classifier was trained on.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • languageCode

      DocumentClassifierProperties.Builder languageCode(LanguageCode languageCode)

      The language code for the language of the documents that the classifier was trained on.

      Parameters:
      languageCode - The language code for the language of the documents that the classifier was trained on.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • status

      DocumentClassifierProperties.Builder status(String status)

      The status of the document classifier. If the status is TRAINED the classifier is ready to use. If the status is TRAINED_WITH_WARNINGS the classifier training succeeded, but you should review the warnings returned in the CreateDocumentClassifier response.

      If the status is FAILED you can see additional information about why the classifier wasn't trained in the Message field.

      Parameters:
      status - The status of the document classifier. If the status is TRAINED the classifier is ready to use. If the status is TRAINED_WITH_WARNINGS the classifier training succeeded, but you should review the warnings returned in the CreateDocumentClassifier response.

      If the status is FAILED you can see additional information about why the classifier wasn't trained in the Message field.

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • status

      DocumentClassifierProperties.Builder status(ModelStatus status)

      The status of the document classifier. If the status is TRAINED the classifier is ready to use. If the status is TRAINED_WITH_WARNINGS the classifier training succeeded, but you should review the warnings returned in the CreateDocumentClassifier response.

      If the status is FAILED you can see additional information about why the classifier wasn't trained in the Message field.

      Parameters:
      status - The status of the document classifier. If the status is TRAINED the classifier is ready to use. If the status is TRAINED_WITH_WARNINGS the classifier training succeeded, but you should review the warnings returned in the CreateDocumentClassifier response.

      If the status is FAILED you can see additional information about why the classifier wasn't trained in the Message field.

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • message

      DocumentClassifierProperties.Builder message(String message)

      Additional information about the status of the classifier.

      Parameters:
      message - Additional information about the status of the classifier.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • submitTime

      DocumentClassifierProperties.Builder submitTime(Instant submitTime)

      The time that the document classifier was submitted for training.

      Parameters:
      submitTime - The time that the document classifier was submitted for training.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • endTime

      DocumentClassifierProperties.Builder endTime(Instant endTime)

      The time that training the document classifier completed.

      Parameters:
      endTime - The time that training the document classifier completed.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • trainingStartTime

      DocumentClassifierProperties.Builder trainingStartTime(Instant trainingStartTime)

      Indicates the time when the training starts on documentation classifiers. You are billed for the time interval between this time and the value of TrainingEndTime.

      Parameters:
      trainingStartTime - Indicates the time when the training starts on documentation classifiers. You are billed for the time interval between this time and the value of TrainingEndTime.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • trainingEndTime

      DocumentClassifierProperties.Builder trainingEndTime(Instant trainingEndTime)

      The time that training of the document classifier was completed. Indicates the time when the training completes on documentation classifiers. You are billed for the time interval between this time and the value of TrainingStartTime.

      Parameters:
      trainingEndTime - The time that training of the document classifier was completed. Indicates the time when the training completes on documentation classifiers. You are billed for the time interval between this time and the value of TrainingStartTime.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • inputDataConfig

      DocumentClassifierProperties.Builder inputDataConfig(DocumentClassifierInputDataConfig inputDataConfig)

      The input data configuration that you supplied when you created the document classifier for training.

      Parameters:
      inputDataConfig - The input data configuration that you supplied when you created the document classifier for training.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • inputDataConfig

      default DocumentClassifierProperties.Builder inputDataConfig(Consumer<DocumentClassifierInputDataConfig.Builder> inputDataConfig)

      The input data configuration that you supplied when you created the document classifier for training.

      This is a convenience method that creates an instance of the DocumentClassifierInputDataConfig.Builder avoiding the need to create one manually via DocumentClassifierInputDataConfig.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to inputDataConfig(DocumentClassifierInputDataConfig).

      Parameters:
      inputDataConfig - a consumer that will call methods on DocumentClassifierInputDataConfig.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • outputDataConfig

      DocumentClassifierProperties.Builder outputDataConfig(DocumentClassifierOutputDataConfig outputDataConfig)

      Provides output results configuration parameters for custom classifier jobs.

      Parameters:
      outputDataConfig - Provides output results configuration parameters for custom classifier jobs.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • outputDataConfig

      default DocumentClassifierProperties.Builder outputDataConfig(Consumer<DocumentClassifierOutputDataConfig.Builder> outputDataConfig)

      Provides output results configuration parameters for custom classifier jobs.

      This is a convenience method that creates an instance of the DocumentClassifierOutputDataConfig.Builder avoiding the need to create one manually via DocumentClassifierOutputDataConfig.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to outputDataConfig(DocumentClassifierOutputDataConfig).

      Parameters:
      outputDataConfig - a consumer that will call methods on DocumentClassifierOutputDataConfig.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • classifierMetadata

      DocumentClassifierProperties.Builder classifierMetadata(ClassifierMetadata classifierMetadata)

      Information about the document classifier, including the number of documents used for training the classifier, the number of documents used for test the classifier, and an accuracy rating.

      Parameters:
      classifierMetadata - Information about the document classifier, including the number of documents used for training the classifier, the number of documents used for test the classifier, and an accuracy rating.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • classifierMetadata

      default DocumentClassifierProperties.Builder classifierMetadata(Consumer<ClassifierMetadata.Builder> classifierMetadata)

      Information about the document classifier, including the number of documents used for training the classifier, the number of documents used for test the classifier, and an accuracy rating.

      This is a convenience method that creates an instance of the ClassifierMetadata.Builder avoiding the need to create one manually via ClassifierMetadata.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to classifierMetadata(ClassifierMetadata).

      Parameters:
      classifierMetadata - a consumer that will call methods on ClassifierMetadata.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • dataAccessRoleArn

      DocumentClassifierProperties.Builder dataAccessRoleArn(String dataAccessRoleArn)

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

      Parameters:
      dataAccessRoleArn - The Amazon Resource Name (ARN) of the IAM role that grants Amazon Comprehend read access to your input data.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • volumeKmsKeyId

      DocumentClassifierProperties.Builder volumeKmsKeyId(String 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"

      Parameters:
      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"

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • vpcConfig

      DocumentClassifierProperties.Builder vpcConfig(VpcConfig vpcConfig)

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

      Parameters:
      vpcConfig - Configuration parameters for a private Virtual Private Cloud (VPC) containing the resources you are using for your custom classifier. For more information, see Amazon VPC.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • vpcConfig

      default DocumentClassifierProperties.Builder vpcConfig(Consumer<VpcConfig.Builder> vpcConfig)

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

      This is a convenience method that creates an instance of the VpcConfig.Builder avoiding the need to create one manually via VpcConfig.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to vpcConfig(VpcConfig).

      Parameters:
      vpcConfig - a consumer that will call methods on VpcConfig.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • mode

      DocumentClassifierProperties.Builder mode(String mode)

      Indicates the mode in which the specific classifier was trained. This also indicates the format of input documents and the format of the confusion matrix. Each classifier can only be trained in one mode and this cannot be changed once the classifier is trained.

      Parameters:
      mode - Indicates the mode in which the specific classifier was trained. This also indicates the format of input documents and the format of the confusion matrix. Each classifier can only be trained in one mode and this cannot be changed once the classifier is trained.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • mode

      DocumentClassifierProperties.Builder mode(DocumentClassifierMode mode)

      Indicates the mode in which the specific classifier was trained. This also indicates the format of input documents and the format of the confusion matrix. Each classifier can only be trained in one mode and this cannot be changed once the classifier is trained.

      Parameters:
      mode - Indicates the mode in which the specific classifier was trained. This also indicates the format of input documents and the format of the confusion matrix. Each classifier can only be trained in one mode and this cannot be changed once the classifier is trained.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • modelKmsKeyId

      DocumentClassifierProperties.Builder modelKmsKeyId(String 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"

      Parameters:
      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"

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • versionName

      DocumentClassifierProperties.Builder versionName(String versionName)

      The version name that you assigned to the document classifier.

      Parameters:
      versionName - The version name that you assigned to the document classifier.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • sourceModelArn

      DocumentClassifierProperties.Builder sourceModelArn(String sourceModelArn)

      The Amazon Resource Name (ARN) of the source model. This model was imported from a different Amazon Web Services account to create the document classifier model in your Amazon Web Services account.

      Parameters:
      sourceModelArn - The Amazon Resource Name (ARN) of the source model. This model was imported from a different Amazon Web Services account to create the document classifier model in your Amazon Web Services account.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • flywheelArn

      DocumentClassifierProperties.Builder flywheelArn(String flywheelArn)

      The Amazon Resource Number (ARN) of the flywheel

      Parameters:
      flywheelArn - The Amazon Resource Number (ARN) of the flywheel
      Returns:
      Returns a reference to this object so that method calls can be chained together.