Package software.amazon.awssdk.services.bedrockagent.model

Interface KnowledgeBaseFlowNodeConfiguration.Builder

All Superinterfaces:

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

Enclosing class:

KnowledgeBaseFlowNodeConfiguration

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

Method Summary

Modifier and Type	Method	Description
default KnowledgeBaseFlowNodeConfiguration.Builder	guardrailConfiguration(Consumer<GuardrailConfiguration.Builder> guardrailConfiguration)	Contains configurations for a guardrail to apply during query and response generation for the knowledge base in this configuration.
KnowledgeBaseFlowNodeConfiguration.Builder	guardrailConfiguration(GuardrailConfiguration guardrailConfiguration)	Contains configurations for a guardrail to apply during query and response generation for the knowledge base in this configuration.
default KnowledgeBaseFlowNodeConfiguration.Builder	inferenceConfiguration(Consumer<PromptInferenceConfiguration.Builder> inferenceConfiguration)	Contains inference configurations for the prompt.
KnowledgeBaseFlowNodeConfiguration.Builder	inferenceConfiguration(PromptInferenceConfiguration inferenceConfiguration)	Contains inference configurations for the prompt.
KnowledgeBaseFlowNodeConfiguration.Builder	knowledgeBaseId(String knowledgeBaseId)	The unique identifier of the knowledge base to query.
KnowledgeBaseFlowNodeConfiguration.Builder	modelId(String modelId)	The unique identifier of the model or inference profile to use to generate a response from the query results.
KnowledgeBaseFlowNodeConfiguration.Builder	numberOfResults(Integer numberOfResults)	The number of results to retrieve from the knowledge base.
default KnowledgeBaseFlowNodeConfiguration.Builder	orchestrationConfiguration(Consumer<KnowledgeBaseOrchestrationConfiguration.Builder> orchestrationConfiguration)	The configuration for orchestrating the retrieval and generation process in the knowledge base node.
KnowledgeBaseFlowNodeConfiguration.Builder	orchestrationConfiguration(KnowledgeBaseOrchestrationConfiguration orchestrationConfiguration)	The configuration for orchestrating the retrieval and generation process in the knowledge base node.
default KnowledgeBaseFlowNodeConfiguration.Builder	promptTemplate(Consumer<KnowledgeBasePromptTemplate.Builder> promptTemplate)	A custom prompt template to use with the knowledge base for generating responses.
KnowledgeBaseFlowNodeConfiguration.Builder	promptTemplate(KnowledgeBasePromptTemplate promptTemplate)	A custom prompt template to use with the knowledge base for generating responses.
default KnowledgeBaseFlowNodeConfiguration.Builder	rerankingConfiguration(Consumer<VectorSearchRerankingConfiguration.Builder> rerankingConfiguration)	The configuration for reranking the retrieved results from the knowledge base to improve relevance.
KnowledgeBaseFlowNodeConfiguration.Builder	rerankingConfiguration(VectorSearchRerankingConfiguration rerankingConfiguration)	The configuration for reranking the retrieved results from the knowledge base to improve relevance.

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

KnowledgeBaseFlowNodeConfiguration.Builder knowledgeBaseId(String knowledgeBaseId)

The unique identifier of the knowledge base to query.

Parameters:

knowledgeBaseId - The unique identifier of the knowledge base to query.

Returns:

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

modelId

KnowledgeBaseFlowNodeConfiguration.Builder modelId(String modelId)

The unique identifier of the model or inference profile to use to generate a response from the query results. Omit this field if you want to return the retrieved results as an array.

Parameters:

modelId - The unique identifier of the model or inference profile to use to generate a response from the query results. Omit this field if you want to return the retrieved results as an array.

Returns:

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

guardrailConfiguration

KnowledgeBaseFlowNodeConfiguration.Builder guardrailConfiguration(GuardrailConfiguration guardrailConfiguration)

Contains configurations for a guardrail to apply during query and response generation for the knowledge base in this configuration.

Parameters:

guardrailConfiguration - Contains configurations for a guardrail to apply during query and response generation for the knowledge base in this configuration.

Returns:

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

guardrailConfiguration

default KnowledgeBaseFlowNodeConfiguration.Builder guardrailConfiguration(Consumer<GuardrailConfiguration.Builder> guardrailConfiguration)

Contains configurations for a guardrail to apply during query and response generation for the knowledge base in this configuration.

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

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

Parameters:

guardrailConfiguration - a consumer that will call methods on GuardrailConfiguration.Builder

Returns:

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

See Also:

guardrailConfiguration(GuardrailConfiguration)

numberOfResults

KnowledgeBaseFlowNodeConfiguration.Builder numberOfResults(Integer numberOfResults)

The number of results to retrieve from the knowledge base.

Parameters:

numberOfResults - The number of results to retrieve from the knowledge base.

Returns:

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

promptTemplate

KnowledgeBaseFlowNodeConfiguration.Builder promptTemplate(KnowledgeBasePromptTemplate promptTemplate)

A custom prompt template to use with the knowledge base for generating responses.

Parameters:

promptTemplate - A custom prompt template to use with the knowledge base for generating responses.

Returns:

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

promptTemplate

default KnowledgeBaseFlowNodeConfiguration.Builder promptTemplate(Consumer<KnowledgeBasePromptTemplate.Builder> promptTemplate)

A custom prompt template to use with the knowledge base for generating responses.

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

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

Parameters:

promptTemplate - a consumer that will call methods on KnowledgeBasePromptTemplate.Builder

Returns:

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

See Also:

promptTemplate(KnowledgeBasePromptTemplate)

inferenceConfiguration

KnowledgeBaseFlowNodeConfiguration.Builder inferenceConfiguration(PromptInferenceConfiguration inferenceConfiguration)

Contains inference configurations for the prompt.

Parameters:

inferenceConfiguration - Contains inference configurations for the prompt.

Returns:

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

inferenceConfiguration

default KnowledgeBaseFlowNodeConfiguration.Builder inferenceConfiguration(Consumer<PromptInferenceConfiguration.Builder> inferenceConfiguration)

Contains inference configurations for the prompt.

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

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

Parameters:

inferenceConfiguration - a consumer that will call methods on PromptInferenceConfiguration.Builder

Returns:

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

See Also:

inferenceConfiguration(PromptInferenceConfiguration)

rerankingConfiguration

KnowledgeBaseFlowNodeConfiguration.Builder rerankingConfiguration(VectorSearchRerankingConfiguration rerankingConfiguration)

The configuration for reranking the retrieved results from the knowledge base to improve relevance.

Parameters:

rerankingConfiguration - The configuration for reranking the retrieved results from the knowledge base to improve relevance.

Returns:

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

rerankingConfiguration

default KnowledgeBaseFlowNodeConfiguration.Builder rerankingConfiguration(Consumer<VectorSearchRerankingConfiguration.Builder> rerankingConfiguration)

The configuration for reranking the retrieved results from the knowledge base to improve relevance.

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

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

Parameters:

rerankingConfiguration - a consumer that will call methods on VectorSearchRerankingConfiguration.Builder

Returns:

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

See Also:

rerankingConfiguration(VectorSearchRerankingConfiguration)

orchestrationConfiguration

KnowledgeBaseFlowNodeConfiguration.Builder orchestrationConfiguration(KnowledgeBaseOrchestrationConfiguration orchestrationConfiguration)

The configuration for orchestrating the retrieval and generation process in the knowledge base node.

Parameters:

orchestrationConfiguration - The configuration for orchestrating the retrieval and generation process in the knowledge base node.

Returns:

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

orchestrationConfiguration

default KnowledgeBaseFlowNodeConfiguration.Builder orchestrationConfiguration(Consumer<KnowledgeBaseOrchestrationConfiguration.Builder> orchestrationConfiguration)

The configuration for orchestrating the retrieval and generation process in the knowledge base node.

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

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

Parameters:

orchestrationConfiguration - a consumer that will call methods on KnowledgeBaseOrchestrationConfiguration.Builder

Returns:

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

See Also:

orchestrationConfiguration(KnowledgeBaseOrchestrationConfiguration)