Interface KnowledgeBaseRetrieverConfiguration.Builder

All Superinterfaces:

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

Enclosing class:

KnowledgeBaseRetrieverConfiguration

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

Method Summary

Modifier and Type	Method	Description
KnowledgeBaseRetrieverConfiguration.Builder	knowledgeBaseId(String knowledgeBaseId)	The unique identifier of the knowledge base.
default KnowledgeBaseRetrieverConfiguration.Builder	retrievalOverrides(Consumer<RetrievalOverrides.Builder> retrievalOverrides)	Overrides for retrieval behavior such as filters and result limits.
KnowledgeBaseRetrieverConfiguration.Builder	retrievalOverrides(RetrievalOverrides retrievalOverrides)	Overrides for retrieval behavior such as filters and result limits.

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

knowledgeBaseId

KnowledgeBaseRetrieverConfiguration.Builder knowledgeBaseId(String knowledgeBaseId)

The unique identifier of the knowledge base.

Parameters:

knowledgeBaseId - The unique identifier of the knowledge base.

Returns:

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

retrievalOverrides

KnowledgeBaseRetrieverConfiguration.Builder retrievalOverrides(RetrievalOverrides retrievalOverrides)

Overrides for retrieval behavior such as filters and result limits.

Parameters:

retrievalOverrides - Overrides for retrieval behavior such as filters and result limits.

Returns:

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

retrievalOverrides

default KnowledgeBaseRetrieverConfiguration.Builder retrievalOverrides(Consumer<RetrievalOverrides.Builder> retrievalOverrides)

Overrides for retrieval behavior such as filters and result limits.

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

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

Parameters:

retrievalOverrides - a consumer that will call methods on RetrievalOverrides.Builder

Returns:

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

See Also:

• retrievalOverrides(RetrievalOverrides)