Interface ExternalSourcesRetrieveAndGenerateConfiguration.Builder

All Superinterfaces:

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

Enclosing class:

ExternalSourcesRetrieveAndGenerateConfiguration

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

Method Summary

Modifier and Type	Method	Description
default ExternalSourcesRetrieveAndGenerateConfiguration.Builder	generationConfiguration(Consumer<ExternalSourcesGenerationConfiguration.Builder> generationConfiguration)	Contains configurations details for response generation based on retrieved text chunks.
ExternalSourcesRetrieveAndGenerateConfiguration.Builder	generationConfiguration(ExternalSourcesGenerationConfiguration generationConfiguration)	Contains configurations details for response generation based on retrieved text chunks.
ExternalSourcesRetrieveAndGenerateConfiguration.Builder	modelArn(String modelArn)	The Amazon Resource Name (ARN) of the foundation model or inference profile used to generate responses.
ExternalSourcesRetrieveAndGenerateConfiguration.Builder	sources(Collection<ExternalSource> sources)	The document for the external source wrapper object in the retrieveAndGenerate function.
ExternalSourcesRetrieveAndGenerateConfiguration.Builder	sources(Consumer<ExternalSource.Builder>... sources)	The document for the external source wrapper object in the retrieveAndGenerate function.
ExternalSourcesRetrieveAndGenerateConfiguration.Builder	sources(ExternalSource... sources)	The document for the external source wrapper object in the retrieveAndGenerate function.

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

modelArn

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

sources

ExternalSourcesRetrieveAndGenerateConfiguration.Builder sources(Collection<ExternalSource> sources)

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

Parameters:

sources - The document 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.

sources

ExternalSourcesRetrieveAndGenerateConfiguration.Builder sources(ExternalSource... sources)

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

Parameters:

sources - The document 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.

sources

ExternalSourcesRetrieveAndGenerateConfiguration.Builder sources(Consumer<ExternalSource.Builder>... sources)

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

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

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to sources(List<ExternalSource>).

Parameters:

sources - a consumer that will call methods on ExternalSource.Builder

Returns:

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

See Also:

• sources(java.util.Collection<ExternalSource>)

generationConfiguration

ExternalSourcesRetrieveAndGenerateConfiguration.Builder generationConfiguration(ExternalSourcesGenerationConfiguration 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 ExternalSourcesRetrieveAndGenerateConfiguration.Builder generationConfiguration(Consumer<ExternalSourcesGenerationConfiguration.Builder> generationConfiguration)

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

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

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

Parameters:

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

Returns:

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

See Also:

• generationConfiguration(ExternalSourcesGenerationConfiguration)