Interface KnowledgeBaseRetrievalResult.Builder

All Superinterfaces:

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

Enclosing class:

KnowledgeBaseRetrievalResult

public static interface KnowledgeBaseRetrievalResult.Builder
extends SdkPojo, CopyableBuilder<KnowledgeBaseRetrievalResult.Builder,KnowledgeBaseRetrievalResult>

Method Summary

Modifier and Type	Method	Description
default KnowledgeBaseRetrievalResult.Builder	content(Consumer<RetrievalResultContent.Builder> content)	Contains a chunk of text from a data source in the knowledge base.
KnowledgeBaseRetrievalResult.Builder	content(RetrievalResultContent content)	Contains a chunk of text from a data source in the knowledge base.
default KnowledgeBaseRetrievalResult.Builder	location(Consumer<RetrievalResultLocation.Builder> location)	Contains information about the location of the data source.
KnowledgeBaseRetrievalResult.Builder	location(RetrievalResultLocation location)	Contains information about the location of the data source.
KnowledgeBaseRetrievalResult.Builder	metadata(Map<String,Document> metadata)	Contains metadata attributes and their values for the file in the data source.
KnowledgeBaseRetrievalResult.Builder	score(Double score)	The level of relevance of the result to the query.

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, sdkFields

Method Details

content

KnowledgeBaseRetrievalResult.Builder content(RetrievalResultContent content)

Contains a chunk of text from a data source in the knowledge base.

Parameters:

content - Contains a chunk of text from a data source in the knowledge base.

Returns:

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

content

default KnowledgeBaseRetrievalResult.Builder content(Consumer<RetrievalResultContent.Builder> content)

Contains a chunk of text from a data source in the knowledge base.

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

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

Parameters:

content - a consumer that will call methods on RetrievalResultContent.Builder

Returns:

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

See Also:

• content(RetrievalResultContent)

location

KnowledgeBaseRetrievalResult.Builder location(RetrievalResultLocation location)

Contains information about the location of the data source.

Parameters:

location - Contains information about the location of the data source.

Returns:

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

location

default KnowledgeBaseRetrievalResult.Builder location(Consumer<RetrievalResultLocation.Builder> location)

Contains information about the location of the data source.

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

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

Parameters:

location - a consumer that will call methods on RetrievalResultLocation.Builder

Returns:

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

See Also:

• location(RetrievalResultLocation)

metadata

KnowledgeBaseRetrievalResult.Builder metadata(Map<String,Document> metadata)

Contains metadata attributes and their values for the file in the data source. For more information, see Metadata and filtering.

Parameters:

metadata - Contains metadata attributes and their values for the file in the data source. For more information, see Metadata and filtering.

Returns:

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

score

KnowledgeBaseRetrievalResult.Builder score(Double score)

The level of relevance of the result to the query.

Parameters:

score - The level of relevance of the result to the query.

Returns:

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