Package software.amazon.awscdk.services.bedrock

Interface CfnKnowledgeBase.VectorKnowledgeBaseConfigurationProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnKnowledgeBase.VectorKnowledgeBaseConfigurationProperty.Jsii$Proxy

Enclosing class:

CfnKnowledgeBase

@Stability(Stable)
public static interface CfnKnowledgeBase.VectorKnowledgeBaseConfigurationProperty
extends software.amazon.jsii.JsiiSerializable

Contains details about the model used to create vector embeddings for the knowledge base.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.bedrock.*;
 VectorKnowledgeBaseConfigurationProperty vectorKnowledgeBaseConfigurationProperty = VectorKnowledgeBaseConfigurationProperty.builder()
         .embeddingModelArn("embeddingModelArn")
         // the properties below are optional
         .embeddingModelConfiguration(EmbeddingModelConfigurationProperty.builder()
                 .bedrockEmbeddingModelConfiguration(BedrockEmbeddingModelConfigurationProperty.builder()
                         .dimensions(123)
                         .embeddingDataType("embeddingDataType")
                         .build())
                 .build())
         .supplementalDataStorageConfiguration(SupplementalDataStorageConfigurationProperty.builder()
                 .supplementalDataStorageLocations(List.of(SupplementalDataStorageLocationProperty.builder()
                         .supplementalDataStorageLocationType("supplementalDataStorageLocationType")
                         // the properties below are optional
                         .s3Location(S3LocationProperty.builder()
                                 .uri("uri")
                                 .build())
                         .build()))
                 .build())
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-knowledgebase-vectorknowledgebaseconfiguration.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnKnowledgeBase.VectorKnowledgeBaseConfigurationProperty.Builder	A builder for CfnKnowledgeBase.VectorKnowledgeBaseConfigurationProperty
static final class	CfnKnowledgeBase.VectorKnowledgeBaseConfigurationProperty.Jsii$Proxy	An implementation for CfnKnowledgeBase.VectorKnowledgeBaseConfigurationProperty

Method Summary

Modifier and Type	Method	Description
static CfnKnowledgeBase.VectorKnowledgeBaseConfigurationProperty.Builder	builder()
String	getEmbeddingModelArn()	The Amazon Resource Name (ARN) of the model used to create vector embeddings for the knowledge base.
default Object	getEmbeddingModelConfiguration()	The embeddings model configuration details for the vector model used in Knowledge Base.
default Object	getSupplementalDataStorageConfiguration()	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.jsii.JsiiSerializable

$jsii$toJson

Method Details

getEmbeddingModelArn

@Stability(Stable)
@NotNull
String getEmbeddingModelArn()

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-knowledgebase-vectorknowledgebaseconfiguration.html#cfn-bedrock-knowledgebase-vectorknowledgebaseconfiguration-embeddingmodelarn

getEmbeddingModelConfiguration

@Stability(Stable)
@Nullable
default Object getEmbeddingModelConfiguration()

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

Returns union: either IResolvable or CfnKnowledgeBase.EmbeddingModelConfigurationProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-knowledgebase-vectorknowledgebaseconfiguration.html#cfn-bedrock-knowledgebase-vectorknowledgebaseconfiguration-embeddingmodelconfiguration

getSupplementalDataStorageConfiguration

@Stability(Stable)
@Nullable
default Object getSupplementalDataStorageConfiguration()

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 union: either IResolvable or CfnKnowledgeBase.SupplementalDataStorageConfigurationProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-knowledgebase-vectorknowledgebaseconfiguration.html#cfn-bedrock-knowledgebase-vectorknowledgebaseconfiguration-supplementaldatastorageconfiguration

builder

@Stability(Stable)
static CfnKnowledgeBase.VectorKnowledgeBaseConfigurationProperty.Builder builder()

Returns:

a CfnKnowledgeBase.VectorKnowledgeBaseConfigurationProperty.Builder of CfnKnowledgeBase.VectorKnowledgeBaseConfigurationProperty