Class: AWSCDK::Bedrock::CfnKnowledgeBase::OpenSearchServerlessFieldMappingProperty

Inherits:

Jsii::Struct

• Object
• Jsii::Struct
• AWSCDK::Bedrock::CfnKnowledgeBase::OpenSearchServerlessFieldMappingProperty

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:

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

Instance Attribute Summary

• #metadata_field ⇒ String readonly

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

• #text_field ⇒ String readonly

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

• #vector_field ⇒ String readonly

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

Class Method Summary

• .jsii_properties ⇒ Object

Instance Method Summary

• #initialize(metadata_field:, text_field:, vector_field:) ⇒ OpenSearchServerlessFieldMappingProperty constructor

  A new instance of OpenSearchServerlessFieldMappingProperty.

• #to_jsii ⇒ Object

Constructor Details

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

Returns a new instance of OpenSearchServerlessFieldMappingProperty.

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.

# File 'bedrock/cfn_knowledge_base.rb', line 1506

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:

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

# File 'bedrock/cfn_knowledge_base.rb', line 1519

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:

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

# File 'bedrock/cfn_knowledge_base.rb', line 1526

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:

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

# File 'bedrock/cfn_knowledge_base.rb', line 1531

def vector_field
  @vector_field
end

Class Method Details

.jsii_properties ⇒ Object

# File 'bedrock/cfn_knowledge_base.rb', line 1533

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

Instance Method Details

#to_jsii ⇒ Object

# File 'bedrock/cfn_knowledge_base.rb', line 1541

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