software.amazon.awssdk.services.comprehend.model

Interface DetectEntitiesRequest.Builder

All Superinterfaces:

AwsRequest.Builder, Buildable, ComprehendRequest.Builder, CopyableBuilder<DetectEntitiesRequest.Builder,DetectEntitiesRequest>, SdkBuilder<DetectEntitiesRequest.Builder,DetectEntitiesRequest>, SdkPojo, SdkRequest.Builder

Enclosing class:

DetectEntitiesRequest

public static interface DetectEntitiesRequest.Builder
extends ComprehendRequest.Builder, SdkPojo, CopyableBuilder<DetectEntitiesRequest.Builder,DetectEntitiesRequest>

Method Summary

Modifier and Type	Method and Description
DetectEntitiesRequest.Builder	endpointArn(String endpointArn) The Amazon Resource Name of an endpoint that is associated with a custom entity recognition model.
DetectEntitiesRequest.Builder	languageCode(LanguageCode languageCode) The language of the input documents.
DetectEntitiesRequest.Builder	languageCode(String languageCode) The language of the input documents.
DetectEntitiesRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.
DetectEntitiesRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.
DetectEntitiesRequest.Builder	text(String text) A UTF-8 text string.

Methods inherited from interface software.amazon.awssdk.services.comprehend.model.ComprehendRequest.Builder

build

Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder

overrideConfiguration

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Method Detail

text

DetectEntitiesRequest.Builder text(String text)

A UTF-8 text string. Each string must contain fewer that 5,000 bytes of UTF-8 encoded characters.

Parameters:

text - A UTF-8 text string. Each string must contain fewer that 5,000 bytes of UTF-8 encoded characters.

Returns:

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

languageCode

DetectEntitiesRequest.Builder languageCode(String languageCode)

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

If your request includes the endpoint for a custom entity recognition model, Amazon Comprehend uses the language of your custom model, and it ignores any language code that you specify here.

Parameters:

languageCode - The language of the input documents. You can specify any of the primary languages supported by Amazon Comprehend. All documents must be in the same language.

If your request includes the endpoint for a custom entity recognition model, Amazon Comprehend uses the language of your custom model, and it ignores any language code that you specify here.

Returns:

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

See Also:

LanguageCode, LanguageCode

languageCode

DetectEntitiesRequest.Builder languageCode(LanguageCode languageCode)

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

If your request includes the endpoint for a custom entity recognition model, Amazon Comprehend uses the language of your custom model, and it ignores any language code that you specify here.

Parameters:

languageCode - The language of the input documents. You can specify any of the primary languages supported by Amazon Comprehend. All documents must be in the same language.

If your request includes the endpoint for a custom entity recognition model, Amazon Comprehend uses the language of your custom model, and it ignores any language code that you specify here.

Returns:

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

See Also:

LanguageCode, LanguageCode

endpointArn

DetectEntitiesRequest.Builder endpointArn(String endpointArn)

The Amazon Resource Name of an endpoint that is associated with a custom entity recognition model. Provide an endpoint if you want to detect entities by using your own custom model instead of the default model that is used by Amazon Comprehend.

If you specify an endpoint, Amazon Comprehend uses the language of your custom model, and it ignores any language code that you provide in your request.

Parameters:

endpointArn - The Amazon Resource Name of an endpoint that is associated with a custom entity recognition model. Provide an endpoint if you want to detect entities by using your own custom model instead of the default model that is used by Amazon Comprehend.

If you specify an endpoint, Amazon Comprehend uses the language of your custom model, and it ignores any language code that you provide in your request.

Returns:

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

overrideConfiguration

DetectEntitiesRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

overrideConfiguration in interface AwsRequest.Builder

Parameters:

overrideConfiguration - The override configuration.

Returns:

This object for method chaining.

overrideConfiguration

DetectEntitiesRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

overrideConfiguration in interface AwsRequest.Builder

Parameters:

builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.

Returns:

This object for method chaining.