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

Interface KnowledgeBaseConfiguration.Builder

All Superinterfaces:

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

Enclosing class:

KnowledgeBaseConfiguration

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

Method Summary

Modifier and Type	Method	Description
KnowledgeBaseConfiguration.Builder	knowledgeBaseId(String knowledgeBaseId)	The unique identifier for a knowledge base attached to the agent.
default KnowledgeBaseConfiguration.Builder	retrievalConfiguration(Consumer<KnowledgeBaseRetrievalConfiguration.Builder> retrievalConfiguration)	The configurations to apply to the knowledge base during query.
KnowledgeBaseConfiguration.Builder	retrievalConfiguration(KnowledgeBaseRetrievalConfiguration retrievalConfiguration)	The configurations to apply to the knowledge base during 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, sdkFieldNameToField, sdkFields

Method Detail

knowledgeBaseId

KnowledgeBaseConfiguration.Builder knowledgeBaseId(String knowledgeBaseId)

The unique identifier for a knowledge base attached to the agent.

Parameters:

knowledgeBaseId - The unique identifier for a knowledge base attached to the agent.

Returns:

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

retrievalConfiguration

KnowledgeBaseConfiguration.Builder retrievalConfiguration(KnowledgeBaseRetrievalConfiguration retrievalConfiguration)

The configurations to apply to the knowledge base during query. For more information, see Query configurations.

Parameters:

retrievalConfiguration - The configurations to apply to the knowledge base during query. For more information, see Query configurations.

Returns:

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

retrievalConfiguration

default KnowledgeBaseConfiguration.Builder retrievalConfiguration(Consumer<KnowledgeBaseRetrievalConfiguration.Builder> retrievalConfiguration)

The configurations to apply to the knowledge base during query. For more information, see Query configurations.

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

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

Parameters:

retrievalConfiguration - a consumer that will call methods on KnowledgeBaseRetrievalConfiguration.Builder

Returns:

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

See Also:

retrievalConfiguration(KnowledgeBaseRetrievalConfiguration)