Interface KnowledgeBaseRetrieveAndGenerateConfiguration.Builder

All Superinterfaces:

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

Enclosing class:

KnowledgeBaseRetrieveAndGenerateConfiguration

@Mutable
@NotThreadSafe
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 details for response generation based on retrieved text chunks.
KnowledgeBaseRetrieveAndGenerateConfiguration.Builder	generationConfiguration(GenerationConfiguration generationConfiguration)	Contains configurations details for response generation based on retrieved text chunks.
KnowledgeBaseRetrieveAndGenerateConfiguration.Builder	knowledgeBaseId(String knowledgeBaseId)	The unique identifier of the knowledge base.
KnowledgeBaseRetrieveAndGenerateConfiguration.Builder	modelArn(String modelArn)	The Amazon Resource Name (ARN) of the foundation model or inference profile used to generate responses.
default KnowledgeBaseRetrieveAndGenerateConfiguration.Builder	orchestrationConfiguration(Consumer<OrchestrationConfiguration.Builder> orchestrationConfiguration)	Contains configuration details for the model to process the prompt prior to retrieval and response generation.
KnowledgeBaseRetrieveAndGenerateConfiguration.Builder	orchestrationConfiguration(OrchestrationConfiguration orchestrationConfiguration)	Contains configuration details for the model to process the prompt prior to retrieval and response generation.
default KnowledgeBaseRetrieveAndGenerateConfiguration.Builder	retrievalConfiguration(Consumer<KnowledgeBaseRetrievalConfiguration.Builder> retrievalConfiguration)	Contains configuration details for retrieving text chunks.
KnowledgeBaseRetrieveAndGenerateConfiguration.Builder	retrievalConfiguration(KnowledgeBaseRetrievalConfiguration retrievalConfiguration)	Contains configuration details for retrieving text chunks.

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

KnowledgeBaseRetrieveAndGenerateConfiguration.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.

modelArn

KnowledgeBaseRetrieveAndGenerateConfiguration.Builder modelArn(String modelArn)

The Amazon Resource Name (ARN) of the foundation model or inference profile used to generate responses.

Parameters:

modelArn - The Amazon Resource Name (ARN) of the foundation model or inference profile used to generate responses.

Returns:

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

retrievalConfiguration

KnowledgeBaseRetrieveAndGenerateConfiguration.Builder retrievalConfiguration(KnowledgeBaseRetrievalConfiguration retrievalConfiguration)

Contains configuration details for retrieving text chunks.

Parameters:

retrievalConfiguration - Contains configuration details for retrieving text chunks.

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 configuration details for retrieving text chunks.

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)

generationConfiguration

KnowledgeBaseRetrieveAndGenerateConfiguration.Builder generationConfiguration(GenerationConfiguration generationConfiguration)

Contains configurations details for response generation based on retrieved text chunks.

Parameters:

generationConfiguration - Contains configurations details for response generation based on retrieved text chunks.

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 details for response generation based on retrieved text chunks.

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)

orchestrationConfiguration

KnowledgeBaseRetrieveAndGenerateConfiguration.Builder orchestrationConfiguration(OrchestrationConfiguration orchestrationConfiguration)

Contains configuration details for the model to process the prompt prior to retrieval and response generation.

Parameters:

orchestrationConfiguration - Contains configuration details for the model to process the prompt prior to retrieval and response 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)

Contains configuration details for the model to process the prompt prior to retrieval and response 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)