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

Interface VectorKnowledgeBaseConfiguration.Builder

All Superinterfaces:

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

Enclosing class:

VectorKnowledgeBaseConfiguration

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

Method Summary

Modifier and Type	Method	Description
VectorKnowledgeBaseConfiguration.Builder	embeddingModelArn(String embeddingModelArn)	The Amazon Resource Name (ARN) of the model used to create vector embeddings for the knowledge base.
default VectorKnowledgeBaseConfiguration.Builder	embeddingModelConfiguration(Consumer<EmbeddingModelConfiguration.Builder> embeddingModelConfiguration)	The embeddings model configuration details for the vector model used in Knowledge Base.
VectorKnowledgeBaseConfiguration.Builder	embeddingModelConfiguration(EmbeddingModelConfiguration embeddingModelConfiguration)	The embeddings model configuration details for the vector model used in Knowledge Base.
default VectorKnowledgeBaseConfiguration.Builder	supplementalDataStorageConfiguration(Consumer<SupplementalDataStorageConfiguration.Builder> supplementalDataStorageConfiguration)	If you include multimodal data from your data source, use this object to specify configurations for the storage location of the images extracted from your documents.
VectorKnowledgeBaseConfiguration.Builder	supplementalDataStorageConfiguration(SupplementalDataStorageConfiguration supplementalDataStorageConfiguration)	If you include multimodal data from your data source, use this object to specify configurations for the storage location of the images extracted from your documents.

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

embeddingModelArn

VectorKnowledgeBaseConfiguration.Builder embeddingModelArn(String embeddingModelArn)

The Amazon Resource Name (ARN) of the model used to create vector embeddings for the knowledge base.

Parameters:

embeddingModelArn - The Amazon Resource Name (ARN) of the model used to create vector embeddings for the knowledge base.

Returns:

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

embeddingModelConfiguration

VectorKnowledgeBaseConfiguration.Builder embeddingModelConfiguration(EmbeddingModelConfiguration embeddingModelConfiguration)

The embeddings model configuration details for the vector model used in Knowledge Base.

Parameters:

embeddingModelConfiguration - The embeddings model configuration details for the vector model used in Knowledge Base.

Returns:

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

embeddingModelConfiguration

default VectorKnowledgeBaseConfiguration.Builder embeddingModelConfiguration(Consumer<EmbeddingModelConfiguration.Builder> embeddingModelConfiguration)

The embeddings model configuration details for the vector model used in Knowledge Base.

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

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

Parameters:

embeddingModelConfiguration - a consumer that will call methods on EmbeddingModelConfiguration.Builder

Returns:

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

See Also:

• embeddingModelConfiguration(EmbeddingModelConfiguration)

supplementalDataStorageConfiguration

VectorKnowledgeBaseConfiguration.Builder supplementalDataStorageConfiguration(SupplementalDataStorageConfiguration supplementalDataStorageConfiguration)

If you include multimodal data from your data source, use this object to specify configurations for the storage location of the images extracted from your documents. These images can be retrieved and returned to the end user. They can also be used in generation when using RetrieveAndGenerate.

Parameters:

supplementalDataStorageConfiguration - If you include multimodal data from your data source, use this object to specify configurations for the storage location of the images extracted from your documents. These images can be retrieved and returned to the end user. They can also be used in generation when using RetrieveAndGenerate.

Returns:

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

supplementalDataStorageConfiguration

default VectorKnowledgeBaseConfiguration.Builder supplementalDataStorageConfiguration(Consumer<SupplementalDataStorageConfiguration.Builder> supplementalDataStorageConfiguration)

If you include multimodal data from your data source, use this object to specify configurations for the storage location of the images extracted from your documents. These images can be retrieved and returned to the end user. They can also be used in generation when using RetrieveAndGenerate.

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

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

Parameters:

supplementalDataStorageConfiguration - a consumer that will call methods on SupplementalDataStorageConfiguration.Builder

Returns:

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

See Also:

• supplementalDataStorageConfiguration(SupplementalDataStorageConfiguration)