Skip to content
v2.275.0

RdsFieldMappingProperty Struct ​

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

Example ​

ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_bedrock as bedrock } from 'aws-cdk-lib';
const rdsFieldMappingProperty: bedrock.CfnKnowledgeBase.RdsFieldMappingProperty = {
  metadataField: 'metadataField',
  primaryKeyField: 'primaryKeyField',
  textField: 'textField',
  vectorField: 'vectorField',

  // the properties below are optional
  customMetadataField: 'customMetadataField',
};

Properties ​

customMetadataFieldoptionalstringcustom_metadata_fieldoptionalstrcustomMetadataFieldoptionalStringCustomMetadataFieldoptionalstringCustomMetadataFieldoptional*string#
Provide a name for the universal metadata field where Amazon Bedrock will store any custom metadata from your data source.
metadataFieldstringmetadata_fieldstrmetadataFieldStringMetadataFieldstringMetadataField*stringrequired#
The name of the field in which Amazon Bedrock stores metadata about the vector store.
primaryKeyFieldstringprimary_key_fieldstrprimaryKeyFieldStringPrimaryKeyFieldstringPrimaryKeyField*stringrequired#
The name of the field in which Amazon Bedrock stores the ID for each entry.
textFieldstringtext_fieldstrtextFieldStringTextFieldstringTextField*stringrequired#
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.

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