Class: AWSCDK::Bedrock::CfnKnowledgeBase::MongoDBAtlasFieldMappingProperty

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
bedrock/cfn_knowledge_base.rb

Overview

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

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(metadata_field:, text_field:, vector_field:) ⇒ MongoDBAtlasFieldMappingProperty

Returns a new instance of MongoDBAtlasFieldMappingProperty.

Parameters:

  • metadata_field (String) —

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

  • text_field (String) —

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

  • vector_field (String) —

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



1186
1187
1188
1189
1190
1191
1192
1193
 
# File 'bedrock/cfn_knowledge_base.rb', line 1186

def initialize(metadata_field:, text_field:, vector_field:)
  @metadata_field = metadata_field
  Jsii::Type.check_type(@metadata_field, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "metadataField")
  @text_field = text_field
  Jsii::Type.check_type(@text_field, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "textField")
  @vector_field = vector_field
  Jsii::Type.check_type(@vector_field, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "vectorField")
end

Instance Attribute Details

#metadata_field ⇒ String (readonly)

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

Returns:

  • (String)

See Also:



1199
1200
1201
 
# File 'bedrock/cfn_knowledge_base.rb', line 1199

def metadata_field
  @metadata_field
end

#text_field ⇒ String (readonly)

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.

Returns:

  • (String)

See Also:



1206
1207
1208
 
# File 'bedrock/cfn_knowledge_base.rb', line 1206

def text_field
  @text_field
end

#vector_field ⇒ String (readonly)

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

Returns:

  • (String)

See Also:



1211
1212
1213
 
# File 'bedrock/cfn_knowledge_base.rb', line 1211

def vector_field
  @vector_field
end

Class Method Details

.jsii_properties ⇒ Object 



1213
1214
1215
1216
1217
1218
1219
 
# File 'bedrock/cfn_knowledge_base.rb', line 1213

def self.jsii_properties
  {
    :metadata_field => "metadataField",
    :text_field => "textField",
    :vector_field => "vectorField",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



1221
1222
1223
1224
1225
1226
1227
1228
1229
 
# File 'bedrock/cfn_knowledge_base.rb', line 1221

def to_jsii
  result = {}
  result.merge!({
    "metadataField" => @metadata_field,
    "textField" => @text_field,
    "vectorField" => @vector_field,
  })
  result.compact
end