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

Interface CreateEntityRecognizerRequest.Builder

    • Method Detail

      • recognizerName

        CreateEntityRecognizerRequest.Builder recognizerName​(String recognizerName)

        The name given to the newly created recognizer. Recognizer names can be a maximum of 256 characters. Alphanumeric characters, hyphens (-) and underscores (_) are allowed. The name must be unique in the account/Region.

        Parameters:
        recognizerName - The name given to the newly created recognizer. Recognizer names can be a maximum of 256 characters. Alphanumeric characters, hyphens (-) and underscores (_) are allowed. The name must be unique in the account/Region.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • versionName

        CreateEntityRecognizerRequest.Builder versionName​(String versionName)

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

        Parameters:
        versionName - The version name given to the newly created recognizer. Version names can be a maximum of 256 characters. Alphanumeric characters, hyphens (-) and underscores (_) are allowed. The version name must be unique among all models with the same recognizer name in the account/Region.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • dataAccessRoleArn

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

      • tags

        CreateEntityRecognizerRequest.Builder tags​(Collection<Tag> tags)

        Tags to associate with the entity recognizer. 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.

        Parameters:
        tags - Tags to associate with the entity recognizer. 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.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • tags

        CreateEntityRecognizerRequest.Builder tags​(Tag... tags)

        Tags to associate with the entity recognizer. 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.

        Parameters:
        tags - Tags to associate with the entity recognizer. 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.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • tags

        CreateEntityRecognizerRequest.Builder tags​(Consumer<Tag.Builder>... tags)

        Tags to associate with the entity recognizer. 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.

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

        When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to #tags(List).

        Parameters:
        tags - a consumer that will call methods on Tag.Builder
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        #tags(java.util.Collection)

      • inputDataConfig

        CreateEntityRecognizerRequest.Builder inputDataConfig​(EntityRecognizerInputDataConfig inputDataConfig)

        Specifies the format and location of the input data. The S3 bucket containing the input data must be located in the same Region as the entity recognizer being created.

        Parameters:
        inputDataConfig - Specifies the format and location of the input data. The S3 bucket containing the input data must be located in the same Region as the entity recognizer being created.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • clientRequestToken

        CreateEntityRecognizerRequest.Builder clientRequestToken​(String clientRequestToken)

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

        Parameters:
        clientRequestToken - A unique identifier for the request. If you don't set the client request token, Amazon Comprehend generates one.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • languageCode

        CreateEntityRecognizerRequest.Builder languageCode​(String languageCode)

        You can specify any of the following languages: English ("en"), Spanish ("es"), French ("fr"), Italian ("it"), German ("de"), or Portuguese ("pt"). If you plan to use this entity recognizer with PDF, Word, or image input files, you must specify English as the language. All training documents must be in the same language.

        Parameters:
        languageCode - You can specify any of the following languages: English ("en"), Spanish ("es"), French ("fr"), Italian ("it"), German ("de"), or Portuguese ("pt"). If you plan to use this entity recognizer with PDF, Word, or image input files, you must specify English as the language. All training documents must be in the same language.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        LanguageCode, LanguageCode

      • languageCode

        CreateEntityRecognizerRequest.Builder languageCode​(LanguageCode languageCode)

        You can specify any of the following languages: English ("en"), Spanish ("es"), French ("fr"), Italian ("it"), German ("de"), or Portuguese ("pt"). If you plan to use this entity recognizer with PDF, Word, or image input files, you must specify English as the language. All training documents must be in the same language.

        Parameters:
        languageCode - You can specify any of the following languages: English ("en"), Spanish ("es"), French ("fr"), Italian ("it"), German ("de"), or Portuguese ("pt"). If you plan to use this entity recognizer with PDF, Word, or image input files, you must specify English as the language. All training documents must be in the same language.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        LanguageCode, LanguageCode

      • volumeKmsKeyId

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

        CreateEntityRecognizerRequest.Builder vpcConfig​(VpcConfig vpcConfig)

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

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

      • modelKmsKeyId

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

      • modelPolicy

        CreateEntityRecognizerRequest.Builder modelPolicy​(String modelPolicy)

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

        Provide your JSON as a UTF-8 encoded string without line breaks. To provide valid JSON for your policy, 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"]}'

        Parameters:
        modelPolicy - The JSON resource-based policy to attach to your custom entity recognizer model. You can use this policy to allow another Amazon Web Services account to import your custom model.

        Provide your JSON as a UTF-8 encoded string without line breaks. To provide valid JSON for your policy, 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"]}'

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