Package software.amazon.awscdk.cfnpropertymixins.services.bedrock

Interface CfnKnowledgeBasePropsMixin.RdsFieldMappingProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnKnowledgeBasePropsMixin.RdsFieldMappingProperty.Jsii$Proxy

Enclosing class:

CfnKnowledgeBasePropsMixin

@Stability(Stable)
public static interface CfnKnowledgeBasePropsMixin.RdsFieldMappingProperty
extends software.amazon.jsii.JsiiSerializable

Contains the names of the fields to which to map information about the vector store.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.cfnpropertymixins.services.bedrock.*;
 RdsFieldMappingProperty rdsFieldMappingProperty = RdsFieldMappingProperty.builder()
         .customMetadataField("customMetadataField")
         .metadataField("metadataField")
         .primaryKeyField("primaryKeyField")
         .textField("textField")
         .vectorField("vectorField")
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnKnowledgeBasePropsMixin.RdsFieldMappingProperty.Builder	builder()
default String	getCustomMetadataField()	Provide a name for the universal metadata field where Amazon Bedrock will store any custom metadata from your data source.
default String	getMetadataField()	The name of the field in which Amazon Bedrock stores metadata about the vector store.
default String	getPrimaryKeyField()	The name of the field in which Amazon Bedrock stores the ID for each entry.
default String	getTextField()	The name of the field in which Amazon Bedrock stores the raw text from your data.
default String	getVectorField()	The name of the field in which Amazon Bedrock stores the vector embeddings for your data sources.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getCustomMetadataField

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

Provide a name for the universal metadata field where Amazon Bedrock will store any custom metadata from your data source.

See Also:

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

getMetadataField

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

The name of the field in which Amazon Bedrock stores metadata about the vector store.

See Also:

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

getPrimaryKeyField

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

The name of the field in which Amazon Bedrock stores the ID for each entry.

See Also:

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

getTextField

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

The name of the field in which Amazon Bedrock stores the raw text from your data.

The text is split according to the chunking strategy you choose.

See Also:

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

getVectorField

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

The name of the field in which Amazon Bedrock stores the vector embeddings for your data sources.

See Also:

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

builder

@Stability(Stable)
static CfnKnowledgeBasePropsMixin.RdsFieldMappingProperty.Builder builder()

Returns:

a CfnKnowledgeBasePropsMixin.RdsFieldMappingProperty.Builder of CfnKnowledgeBasePropsMixin.RdsFieldMappingProperty