Package software.amazon.awscdk.services.bedrock

Interface CfnKnowledgeBase.KnowledgeBaseConfigurationProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnKnowledgeBase.KnowledgeBaseConfigurationProperty.Jsii$Proxy

Enclosing class:

CfnKnowledgeBase

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

Configurations to apply to a knowledge base attached to the agent during query.

For more information, see Knowledge base retrieval configurations .

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.*;
 KnowledgeBaseConfigurationProperty knowledgeBaseConfigurationProperty = KnowledgeBaseConfigurationProperty.builder()
         .type("type")
         .vectorKnowledgeBaseConfiguration(VectorKnowledgeBaseConfigurationProperty.builder()
                 .embeddingModelArn("embeddingModelArn")
                 // the properties below are optional
                 .embeddingModelConfiguration(EmbeddingModelConfigurationProperty.builder()
                         .bedrockEmbeddingModelConfiguration(BedrockEmbeddingModelConfigurationProperty.builder()
                                 .dimensions(123)
                                 .build())
                         .build())
                 .build())
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnKnowledgeBase.KnowledgeBaseConfigurationProperty.Builder	builder()
String	getType()	The type of data that the data source is converted into for the knowledge base.
Object	getVectorKnowledgeBaseConfiguration()	Contains details about the model that's used to convert the data source into vector embeddings.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getType

@Stability(Stable)
@NotNull
String getType()

The type of data that the data source is converted into for the knowledge base.

See Also:

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

getVectorKnowledgeBaseConfiguration

@Stability(Stable)
@NotNull
Object getVectorKnowledgeBaseConfiguration()

Contains details about the model that's used to convert the data source into vector embeddings.

See Also:

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

builder

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

Returns:

a CfnKnowledgeBase.KnowledgeBaseConfigurationProperty.Builder of CfnKnowledgeBase.KnowledgeBaseConfigurationProperty