Interface RerankDocument.Builder

All Superinterfaces:

Buildable, CopyableBuilder<RerankDocument.Builder,RerankDocument>, SdkBuilder<RerankDocument.Builder,RerankDocument>, SdkPojo

Enclosing class:

RerankDocument

@Mutable
@NotThreadSafe
public static interface RerankDocument.Builder
extends SdkPojo, CopyableBuilder<RerankDocument.Builder,RerankDocument>

Method Summary

Modifier and Type	Method	Description
RerankDocument.Builder	jsonDocument(Document jsonDocument)	Contains a JSON document to rerank.
default RerankDocument.Builder	textDocument(Consumer<RerankTextDocument.Builder> textDocument)	Contains information about a text document to rerank.
RerankDocument.Builder	textDocument(RerankTextDocument textDocument)	Contains information about a text document to rerank.
RerankDocument.Builder	type(String type)	The type of document to rerank.
RerankDocument.Builder	type(RerankDocumentType type)	The type of document to rerank.

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

copy

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

applyMutation, build

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

equalsBySdkFields, sdkFieldNameToField, sdkFields

Method Details

type

RerankDocument.Builder type(String type)

The type of document to rerank.

Parameters:

type - The type of document to rerank.

Returns:

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

See Also:

• RerankDocumentType
• RerankDocumentType

type

RerankDocument.Builder type(RerankDocumentType type)

The type of document to rerank.

Parameters:

type - The type of document to rerank.

Returns:

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

See Also:

• RerankDocumentType
• RerankDocumentType

textDocument

RerankDocument.Builder textDocument(RerankTextDocument textDocument)

Contains information about a text document to rerank.

Parameters:

textDocument - Contains information about a text document to rerank.

Returns:

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

textDocument

default RerankDocument.Builder textDocument(Consumer<RerankTextDocument.Builder> textDocument)

Contains information about a text document to rerank.

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

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

Parameters:

textDocument - a consumer that will call methods on RerankTextDocument.Builder

Returns:

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

See Also:

• textDocument(RerankTextDocument)

jsonDocument

RerankDocument.Builder jsonDocument(Document jsonDocument)

Contains a JSON document to rerank.

Parameters:

jsonDocument - Contains a JSON document to rerank.

Returns:

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