Package software.amazon.awssdk.services.bedrockagentruntime.model

Interface RerankResult.Builder

All Superinterfaces:

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

Enclosing class:

RerankResult

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

Method Summary

Modifier and Type	Method	Description
default RerankResult.Builder	document(Consumer<RerankDocument.Builder> document)	Contains information about the document.
RerankResult.Builder	document(RerankDocument document)	Contains information about the document.
RerankResult.Builder	index(Integer index)	The ranking of the document.
RerankResult.Builder	relevanceScore(Float relevanceScore)	The relevance score of the document.

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 Detail

document

RerankResult.Builder document(RerankDocument document)

Contains information about the document.

Parameters:

document - Contains information about the document.

Returns:

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

document

default RerankResult.Builder document(Consumer<RerankDocument.Builder> document)

Contains information about the document.

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

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

Parameters:

document - a consumer that will call methods on RerankDocument.Builder

Returns:

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

See Also:

document(RerankDocument)

index

RerankResult.Builder index(Integer index)

The ranking of the document. The lower a number, the higher the document is ranked.

Parameters:

index - The ranking of the document. The lower a number, the higher the document is ranked.

Returns:

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

relevanceScore

RerankResult.Builder relevanceScore(Float relevanceScore)

The relevance score of the document.

Parameters:

relevanceScore - The relevance score of the document.

Returns:

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