Class: AWSCDK::Bedrock::CfnKnowledgeBase::RDSFieldMappingProperty

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:, primary_key_field:, text_field:, vector_field:, custom_metadata_field: nil) ⇒ RDSFieldMappingProperty

Returns a new instance of RDSFieldMappingProperty.

Parameters:

  • metadata_field (String) —

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

  • primary_key_field (String) —

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

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

  • custom_metadata_field (String, nil) (defaults to: nil) —

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



1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
 
# File 'bedrock/cfn_knowledge_base.rb', line 1956

def initialize(metadata_field:, primary_key_field:, text_field:, vector_field:, custom_metadata_field: nil)
  @metadata_field = metadata_field
  Jsii::Type.check_type(@metadata_field, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "metadataField")
  @primary_key_field = primary_key_field
  Jsii::Type.check_type(@primary_key_field, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "primaryKeyField")
  @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")
  @custom_metadata_field = custom_metadata_field
  Jsii::Type.check_type(@custom_metadata_field, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "customMetadataField") unless @custom_metadata_field.nil?
end

Instance Attribute Details

#custom_metadata_field ⇒ String? (readonly)

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

Returns:

  • (String, nil)

See Also:



1995
1996
1997
 
# File 'bedrock/cfn_knowledge_base.rb', line 1995

def custom_metadata_field
  @custom_metadata_field
end

#metadata_field ⇒ String (readonly)

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

Returns:

  • (String)

See Also:



1973
1974
1975
 
# File 'bedrock/cfn_knowledge_base.rb', line 1973

def metadata_field
  @metadata_field
end

#primary_key_field ⇒ String (readonly)

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

Returns:

  • (String)

See Also:



1978
1979
1980
 
# File 'bedrock/cfn_knowledge_base.rb', line 1978

def primary_key_field
  @primary_key_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:



1985
1986
1987
 
# File 'bedrock/cfn_knowledge_base.rb', line 1985

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:



1990
1991
1992
 
# File 'bedrock/cfn_knowledge_base.rb', line 1990

def vector_field
  @vector_field
end

Class Method Details

.jsii_properties ⇒ Object 



1997
1998
1999
2000
2001
2002
2003
2004
2005
 
# File 'bedrock/cfn_knowledge_base.rb', line 1997

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

Instance Method Details

#to_jsii ⇒ Object 



2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
 
# File 'bedrock/cfn_knowledge_base.rb', line 2007

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