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 TypeMethodDescriptiondefault RerankResult.Builder
document
(Consumer<RerankDocument.Builder> document) Contains information about the document.document
(RerankDocument document) Contains information about the document.The ranking of the document.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 Details
-
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
Contains information about the document.
This is a convenience method that creates an instance of theRerankDocument.Builder
avoiding the need to create one manually viaRerankDocument.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed todocument(RerankDocument)
.- Parameters:
document
- a consumer that will call methods onRerankDocument.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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
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.
-