Package software.amazon.awscdk.services.bedrock

Interface CfnKnowledgeBase.ManagedKnowledgeBaseConfigurationProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnKnowledgeBase.ManagedKnowledgeBaseConfigurationProperty.Jsii$Proxy

Enclosing class:

CfnKnowledgeBase

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

Contains details about the model used to create vector embeddings for a managed 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.*;
 ManagedKnowledgeBaseConfigurationProperty managedKnowledgeBaseConfigurationProperty = ManagedKnowledgeBaseConfigurationProperty.builder()
         .embeddingModelArn("embeddingModelArn")
         // the properties below are optional
         .embeddingModelConfiguration(EmbeddingModelConfigurationProperty.builder()
                 .bedrockEmbeddingModelConfiguration(BedrockEmbeddingModelConfigurationProperty.builder()
                         .audio(List.of(AudioConfigurationProperty.builder()
                                 .segmentationConfiguration(AudioSegmentationConfigurationProperty.builder()
                                         .fixedLengthDuration(123)
                                         .build())
                                 .build()))
                         .dimensions(123)
                         .embeddingDataType("embeddingDataType")
                         .video(List.of(VideoConfigurationProperty.builder()
                                 .segmentationConfiguration(VideoSegmentationConfigurationProperty.builder()
                                         .fixedLengthDuration(123)
                                         .build())
                                 .build()))
                         .build())
                 .build())
         .embeddingModelType("embeddingModelType")
         .serverSideEncryptionConfiguration(ManagedKnowledgeBaseServerSideEncryptionConfigurationProperty.builder()
                 .kmsKeyArn("kmsKeyArn")
                 .build())
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnKnowledgeBase.ManagedKnowledgeBaseConfigurationProperty.Builder	builder()
String	getEmbeddingModelArn()	The 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 String	getEmbeddingModelType()	The type of embedding model to use for the managed knowledge base.
default Object	getServerSideEncryptionConfiguration()	Contains details about the server-side encryption for the managed knowledge base.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getEmbeddingModelArn

@Stability(Stable)
@NotNull
String getEmbeddingModelArn()

The 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-managedknowledgebaseconfiguration.html#cfn-bedrock-knowledgebase-managedknowledgebaseconfiguration-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-managedknowledgebaseconfiguration.html#cfn-bedrock-knowledgebase-managedknowledgebaseconfiguration-embeddingmodelconfiguration

getEmbeddingModelType

@Stability(Stable)
@Nullable
default String getEmbeddingModelType()

The type of embedding model to use for the managed knowledge base.

See Also:

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

getServerSideEncryptionConfiguration

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

Contains details about the server-side encryption for the managed knowledge base.

Returns union: either IResolvable or CfnKnowledgeBase.ManagedKnowledgeBaseServerSideEncryptionConfigurationProperty

See Also:

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

builder

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

Returns:

a CfnKnowledgeBase.ManagedKnowledgeBaseConfigurationProperty.Builder of CfnKnowledgeBase.ManagedKnowledgeBaseConfigurationProperty