Class: AWSCDK::Bedrock::CfnKnowledgeBase::PineconeFieldMappingProperty

Inherits:

Jsii::Struct

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

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-pineconefieldmapping.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.

Class Method Summary

• .jsii_properties ⇒ Object

Instance Method Summary

• #initialize(metadata_field:, text_field:) ⇒ PineconeFieldMappingProperty constructor

  A new instance of PineconeFieldMappingProperty.

• #to_jsii ⇒ Object

Constructor Details

#initialize(metadata_field:, text_field:) ⇒ PineconeFieldMappingProperty

Returns a new instance of PineconeFieldMappingProperty.

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.

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

def initialize(metadata_field:, text_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")
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-pineconefieldmapping.html#cfn-bedrock-knowledgebase-pineconefieldmapping-metadatafield

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

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-pineconefieldmapping.html#cfn-bedrock-knowledgebase-pineconefieldmapping-textfield

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

def text_field
  @text_field
end

Class Method Details

.jsii_properties ⇒ Object

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

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

Instance Method Details

#to_jsii ⇒ Object

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

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