Interface RetrieveAndGenerateConfiguration.Builder

All Superinterfaces:

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

Enclosing class:

RetrieveAndGenerateConfiguration

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

Method Summary

Modifier and Type	Method	Description
default RetrieveAndGenerateConfiguration.Builder	externalSourcesConfiguration(Consumer<ExternalSourcesRetrieveAndGenerateConfiguration.Builder> externalSourcesConfiguration)	The configuration for the external source wrapper object in the retrieveAndGenerate function.
RetrieveAndGenerateConfiguration.Builder	externalSourcesConfiguration(ExternalSourcesRetrieveAndGenerateConfiguration externalSourcesConfiguration)	The configuration for the external source wrapper object in the retrieveAndGenerate function.
default RetrieveAndGenerateConfiguration.Builder	knowledgeBaseConfiguration(Consumer<KnowledgeBaseRetrieveAndGenerateConfiguration.Builder> knowledgeBaseConfiguration)	Contains configuration details for the knowledge base retrieval and response generation.
RetrieveAndGenerateConfiguration.Builder	knowledgeBaseConfiguration(KnowledgeBaseRetrieveAndGenerateConfiguration knowledgeBaseConfiguration)	Contains configuration details for the knowledge base retrieval and response generation.
RetrieveAndGenerateConfiguration.Builder	type(String type)	The type of resource that contains your data for retrieving information and generating responses.
RetrieveAndGenerateConfiguration.Builder	type(RetrieveAndGenerateType type)	The type of resource that contains your data for retrieving information and generating responses.

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

type

RetrieveAndGenerateConfiguration.Builder type(String type)

The type of resource that contains your data for retrieving information and generating responses.

If you choose to use EXTERNAL_SOURCES, then currently only Claude 3 Sonnet models for knowledge bases are supported.

Parameters:

type - The type of resource that contains your data for retrieving information and generating responses.

If you choose to use EXTERNAL_SOURCES, then currently only Claude 3 Sonnet models for knowledge bases are supported.

Returns:

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

See Also:

• RetrieveAndGenerateType
• RetrieveAndGenerateType

type

RetrieveAndGenerateConfiguration.Builder type(RetrieveAndGenerateType type)

The type of resource that contains your data for retrieving information and generating responses.

If you choose to use EXTERNAL_SOURCES, then currently only Claude 3 Sonnet models for knowledge bases are supported.

Parameters:

type - The type of resource that contains your data for retrieving information and generating responses.

If you choose to use EXTERNAL_SOURCES, then currently only Claude 3 Sonnet models for knowledge bases are supported.

Returns:

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

See Also:

• RetrieveAndGenerateType
• RetrieveAndGenerateType

knowledgeBaseConfiguration

RetrieveAndGenerateConfiguration.Builder knowledgeBaseConfiguration(KnowledgeBaseRetrieveAndGenerateConfiguration knowledgeBaseConfiguration)

Contains configuration details for the knowledge base retrieval and response generation.

Parameters:

knowledgeBaseConfiguration - Contains configuration details for the knowledge base retrieval and response generation.

Returns:

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

knowledgeBaseConfiguration

default RetrieveAndGenerateConfiguration.Builder knowledgeBaseConfiguration(Consumer<KnowledgeBaseRetrieveAndGenerateConfiguration.Builder> knowledgeBaseConfiguration)

Contains configuration details for the knowledge base retrieval and response generation.

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

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

Parameters:

knowledgeBaseConfiguration - a consumer that will call methods on KnowledgeBaseRetrieveAndGenerateConfiguration.Builder

Returns:

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

See Also:

• knowledgeBaseConfiguration(KnowledgeBaseRetrieveAndGenerateConfiguration)

externalSourcesConfiguration

RetrieveAndGenerateConfiguration.Builder externalSourcesConfiguration(ExternalSourcesRetrieveAndGenerateConfiguration externalSourcesConfiguration)

The configuration for the external source wrapper object in the retrieveAndGenerate function.

Parameters:

externalSourcesConfiguration - The configuration for the external source wrapper object in the retrieveAndGenerate function.

Returns:

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

externalSourcesConfiguration

default RetrieveAndGenerateConfiguration.Builder externalSourcesConfiguration(Consumer<ExternalSourcesRetrieveAndGenerateConfiguration.Builder> externalSourcesConfiguration)

The configuration for the external source wrapper object in the retrieveAndGenerate function.

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

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

Parameters:

externalSourcesConfiguration - a consumer that will call methods on ExternalSourcesRetrieveAndGenerateConfiguration.Builder

Returns:

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

See Also:

• externalSourcesConfiguration(ExternalSourcesRetrieveAndGenerateConfiguration)