Interface KnowledgeBaseRetrieveAndGenerateConfiguration.Builder

All Superinterfaces:

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

Enclosing class:

KnowledgeBaseRetrieveAndGenerateConfiguration

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

Method Summary

Modifier and Type	Method	Description
default KnowledgeBaseRetrieveAndGenerateConfiguration.Builder	generationConfiguration(Consumer<GenerationConfiguration.Builder> generationConfiguration)	Contains configurations for response generation based on the knowledge base query results.
KnowledgeBaseRetrieveAndGenerateConfiguration.Builder	generationConfiguration(GenerationConfiguration generationConfiguration)	Contains configurations for response generation based on the knowledge base query results.
KnowledgeBaseRetrieveAndGenerateConfiguration.Builder	knowledgeBaseId(String knowledgeBaseId)	The unique identifier of the knowledge base that is queried.
KnowledgeBaseRetrieveAndGenerateConfiguration.Builder	modelArn(String modelArn)	The ARN of the foundation model or inference profile used to generate a response.
default KnowledgeBaseRetrieveAndGenerateConfiguration.Builder	orchestrationConfiguration(Consumer<OrchestrationConfiguration.Builder> orchestrationConfiguration)	Settings for how the model processes the prompt prior to retrieval and generation.
KnowledgeBaseRetrieveAndGenerateConfiguration.Builder	orchestrationConfiguration(OrchestrationConfiguration orchestrationConfiguration)	Settings for how the model processes the prompt prior to retrieval and generation.
default KnowledgeBaseRetrieveAndGenerateConfiguration.Builder	retrievalConfiguration(Consumer<KnowledgeBaseRetrievalConfiguration.Builder> retrievalConfiguration)	Contains configurations for how to retrieve and return the knowledge base query.
KnowledgeBaseRetrieveAndGenerateConfiguration.Builder	retrievalConfiguration(KnowledgeBaseRetrievalConfiguration retrievalConfiguration)	Contains configurations for how to retrieve and return the knowledge base 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

generationConfiguration

KnowledgeBaseRetrieveAndGenerateConfiguration.Builder generationConfiguration(GenerationConfiguration generationConfiguration)

Contains configurations for response generation based on the knowledge base query results.

Parameters:

generationConfiguration - Contains configurations for response generation based on the knowledge base query results.

Returns:

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

generationConfiguration

default KnowledgeBaseRetrieveAndGenerateConfiguration.Builder generationConfiguration(Consumer<GenerationConfiguration.Builder> generationConfiguration)

Contains configurations for response generation based on the knowledge base query results.

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

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

Parameters:

generationConfiguration - a consumer that will call methods on GenerationConfiguration.Builder

Returns:

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

See Also:

• generationConfiguration(GenerationConfiguration)

knowledgeBaseId

KnowledgeBaseRetrieveAndGenerateConfiguration.Builder knowledgeBaseId(String knowledgeBaseId)

The unique identifier of the knowledge base that is queried.

Parameters:

knowledgeBaseId - The unique identifier of the knowledge base that is queried.

Returns:

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

modelArn

KnowledgeBaseRetrieveAndGenerateConfiguration.Builder modelArn(String modelArn)

The ARN of the foundation model or inference profile used to generate a response.

Parameters:

modelArn - The ARN of the foundation model or inference profile used to generate a response.

Returns:

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

orchestrationConfiguration

KnowledgeBaseRetrieveAndGenerateConfiguration.Builder orchestrationConfiguration(OrchestrationConfiguration orchestrationConfiguration)

Settings for how the model processes the prompt prior to retrieval and generation.

Parameters:

orchestrationConfiguration - Settings for how the model processes the prompt prior to retrieval and generation.

Returns:

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

orchestrationConfiguration

default KnowledgeBaseRetrieveAndGenerateConfiguration.Builder orchestrationConfiguration(Consumer<OrchestrationConfiguration.Builder> orchestrationConfiguration)

Settings for how the model processes the prompt prior to retrieval and generation.

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

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

Parameters:

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

Returns:

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

See Also:

• orchestrationConfiguration(OrchestrationConfiguration)

retrievalConfiguration

KnowledgeBaseRetrieveAndGenerateConfiguration.Builder retrievalConfiguration(KnowledgeBaseRetrievalConfiguration retrievalConfiguration)

Contains configurations for how to retrieve and return the knowledge base query.

Parameters:

retrievalConfiguration - Contains configurations for how to retrieve and return the knowledge base query.

Returns:

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

retrievalConfiguration

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

Contains configurations for how to retrieve and return the knowledge base query.

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)