software.amazon.awssdk.services.comprehend.model

Interface DetectEntitiesResponse.Builder

All Superinterfaces:

AwsResponse.Builder, Buildable, ComprehendResponse.Builder, CopyableBuilder<DetectEntitiesResponse.Builder,DetectEntitiesResponse>, SdkBuilder<DetectEntitiesResponse.Builder,DetectEntitiesResponse>, SdkPojo, SdkResponse.Builder

Enclosing class:

DetectEntitiesResponse

public static interface DetectEntitiesResponse.Builder
extends ComprehendResponse.Builder, SdkPojo, CopyableBuilder<DetectEntitiesResponse.Builder,DetectEntitiesResponse>

Method Summary

Modifier and Type	Method and Description
DetectEntitiesResponse.Builder	blocks(Block... blocks) Information about each block of text in the input document.
DetectEntitiesResponse.Builder	blocks(Collection<Block> blocks) Information about each block of text in the input document.
DetectEntitiesResponse.Builder	blocks(Consumer<Block.Builder>... blocks) Information about each block of text in the input document.
default DetectEntitiesResponse.Builder	documentMetadata(Consumer<DocumentMetadata.Builder> documentMetadata) Information about the document, discovered during text extraction.
DetectEntitiesResponse.Builder	documentMetadata(DocumentMetadata documentMetadata) Information about the document, discovered during text extraction.
DetectEntitiesResponse.Builder	documentType(Collection<DocumentTypeListItem> documentType) The document type for each page in the input document.
DetectEntitiesResponse.Builder	documentType(Consumer<DocumentTypeListItem.Builder>... documentType) The document type for each page in the input document.
DetectEntitiesResponse.Builder	documentType(DocumentTypeListItem... documentType) The document type for each page in the input document.
DetectEntitiesResponse.Builder	entities(Collection<Entity> entities) A collection of entities identified in the input text.
DetectEntitiesResponse.Builder	entities(Consumer<Entity.Builder>... entities) A collection of entities identified in the input text.
DetectEntitiesResponse.Builder	entities(Entity... entities) A collection of entities identified in the input text.
DetectEntitiesResponse.Builder	errors(Collection<ErrorsListItem> errors) Page-level errors that the system detected while processing the input document.
DetectEntitiesResponse.Builder	errors(Consumer<ErrorsListItem.Builder>... errors) Page-level errors that the system detected while processing the input document.
DetectEntitiesResponse.Builder	errors(ErrorsListItem... errors) Page-level errors that the system detected while processing the input document.

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

build, responseMetadata, responseMetadata

Methods inherited from interface software.amazon.awssdk.core.SdkResponse.Builder

sdkHttpResponse, sdkHttpResponse

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

entities

DetectEntitiesResponse.Builder entities(Collection<Entity> entities)

A collection of entities identified in the input text. For each entity, the response provides the entity text, entity type, where the entity text begins and ends, and the level of confidence that Amazon Comprehend has in the detection.

If your request uses a custom entity recognition model, Amazon Comprehend detects the entities that the model is trained to recognize. Otherwise, it detects the default entity types. For a list of default entity types, see Entities in the Comprehend Developer Guide.

Parameters:

entities - A collection of entities identified in the input text. For each entity, the response provides the entity text, entity type, where the entity text begins and ends, and the level of confidence that Amazon Comprehend has in the detection.

If your request uses a custom entity recognition model, Amazon Comprehend detects the entities that the model is trained to recognize. Otherwise, it detects the default entity types. For a list of default entity types, see Entities in the Comprehend Developer Guide.

Returns:

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

entities

DetectEntitiesResponse.Builder entities(Entity... entities)

A collection of entities identified in the input text. For each entity, the response provides the entity text, entity type, where the entity text begins and ends, and the level of confidence that Amazon Comprehend has in the detection.

If your request uses a custom entity recognition model, Amazon Comprehend detects the entities that the model is trained to recognize. Otherwise, it detects the default entity types. For a list of default entity types, see Entities in the Comprehend Developer Guide.

Parameters:

entities - A collection of entities identified in the input text. For each entity, the response provides the entity text, entity type, where the entity text begins and ends, and the level of confidence that Amazon Comprehend has in the detection.

If your request uses a custom entity recognition model, Amazon Comprehend detects the entities that the model is trained to recognize. Otherwise, it detects the default entity types. For a list of default entity types, see Entities in the Comprehend Developer Guide.

Returns:

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

entities

DetectEntitiesResponse.Builder entities(Consumer<Entity.Builder>... entities)

A collection of entities identified in the input text. For each entity, the response provides the entity text, entity type, where the entity text begins and ends, and the level of confidence that Amazon Comprehend has in the detection.

If your request uses a custom entity recognition model, Amazon Comprehend detects the entities that the model is trained to recognize. Otherwise, it detects the default entity types. For a list of default entity types, see Entities in the Comprehend Developer Guide.

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

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

Parameters:

entities - a consumer that will call methods on Entity.Builder

Returns:

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

See Also:

#entities(java.util.Collection)

documentMetadata

DetectEntitiesResponse.Builder documentMetadata(DocumentMetadata documentMetadata)

Information about the document, discovered during text extraction. This field is present in the response only if your request used the Byte parameter.

Parameters:

documentMetadata - Information about the document, discovered during text extraction. This field is present in the response only if your request used the Byte parameter.

Returns:

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

documentMetadata

default DetectEntitiesResponse.Builder documentMetadata(Consumer<DocumentMetadata.Builder> documentMetadata)

Information about the document, discovered during text extraction. This field is present in the response only if your request used the Byte parameter.

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

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

Parameters:

documentMetadata - a consumer that will call methods on DocumentMetadata.Builder

Returns:

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

See Also:

documentMetadata(DocumentMetadata)

documentType

DetectEntitiesResponse.Builder documentType(Collection<DocumentTypeListItem> documentType)

The document type for each page in the input document. This field is present in the response only if your request used the Byte parameter.

Parameters:

documentType - The document type for each page in the input document. This field is present in the response only if your request used the Byte parameter.

Returns:

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

documentType

DetectEntitiesResponse.Builder documentType(DocumentTypeListItem... documentType)

The document type for each page in the input document. This field is present in the response only if your request used the Byte parameter.

Parameters:

documentType - The document type for each page in the input document. This field is present in the response only if your request used the Byte parameter.

Returns:

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

documentType

DetectEntitiesResponse.Builder documentType(Consumer<DocumentTypeListItem.Builder>... documentType)

The document type for each page in the input document. This field is present in the response only if your request used the Byte parameter.

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

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

Parameters:

documentType - a consumer that will call methods on DocumentTypeListItem.Builder

Returns:

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

See Also:

#documentType(java.util.Collection)

blocks

DetectEntitiesResponse.Builder blocks(Collection<Block> blocks)

Information about each block of text in the input document. Blocks are nested. A page block contains a block for each line of text, which contains a block for each word.

The Block content for a Word input document does not include a Geometry field.

The Block field is not present in the response for plain-text inputs.

Parameters:

blocks - Information about each block of text in the input document. Blocks are nested. A page block contains a block for each line of text, which contains a block for each word.

The Block content for a Word input document does not include a Geometry field.

The Block field is not present in the response for plain-text inputs.

Returns:

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

blocks

DetectEntitiesResponse.Builder blocks(Block... blocks)

Information about each block of text in the input document. Blocks are nested. A page block contains a block for each line of text, which contains a block for each word.

The Block content for a Word input document does not include a Geometry field.

The Block field is not present in the response for plain-text inputs.

Parameters:

blocks - Information about each block of text in the input document. Blocks are nested. A page block contains a block for each line of text, which contains a block for each word.

The Block content for a Word input document does not include a Geometry field.

The Block field is not present in the response for plain-text inputs.

Returns:

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

blocks

DetectEntitiesResponse.Builder blocks(Consumer<Block.Builder>... blocks)

Information about each block of text in the input document. Blocks are nested. A page block contains a block for each line of text, which contains a block for each word.

The Block content for a Word input document does not include a Geometry field.

The Block field is not present in the response for plain-text inputs.

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

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

Parameters:

blocks - a consumer that will call methods on Block.Builder

Returns:

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

See Also:

#blocks(java.util.Collection)

errors

DetectEntitiesResponse.Builder errors(Collection<ErrorsListItem> errors)

Page-level errors that the system detected while processing the input document. The field is empty if the system encountered no errors.

Parameters:

errors - Page-level errors that the system detected while processing the input document. The field is empty if the system encountered no errors.

Returns:

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

errors

DetectEntitiesResponse.Builder errors(ErrorsListItem... errors)

Page-level errors that the system detected while processing the input document. The field is empty if the system encountered no errors.

Parameters:

errors - Page-level errors that the system detected while processing the input document. The field is empty if the system encountered no errors.

Returns:

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

errors

DetectEntitiesResponse.Builder errors(Consumer<ErrorsListItem.Builder>... errors)

Page-level errors that the system detected while processing the input document. The field is empty if the system encountered no errors.

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

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

Parameters:

errors - a consumer that will call methods on ErrorsListItem.Builder

Returns:

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

See Also:

#errors(java.util.Collection)