Class: Aws::Bedrock::Types::MetadataAttributeSchema

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/types.rb

Overview

Defines the schema for a metadata attribute used in Knowledge Base vector searches. Metadata attributes provide additional context for documents and can be used for filtering and reranking search results.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#descriptionString

An optional description of the metadata attribute that provides additional context about its purpose and usage.

Returns:

  • (String)


7377
7378
7379
7380
7381
7382
7383
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/types.rb', line 7377

class MetadataAttributeSchema < Struct.new(
  :key,
  :type,
  :description)
  SENSITIVE = []
  include Aws::Structure
end

#keyString

The unique identifier for the metadata attribute. This key is used to reference the attribute in filter expressions and reranking configurations.

Returns:

  • (String)


7377
7378
7379
7380
7381
7382
7383
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/types.rb', line 7377

class MetadataAttributeSchema < Struct.new(
  :key,
  :type,
  :description)
  SENSITIVE = []
  include Aws::Structure
end

#typeString

The data type of the metadata attribute. The type determines how the attribute can be used in filter expressions and reranking.

Returns:

  • (String)


7377
7378
7379
7380
7381
7382
7383
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/types.rb', line 7377

class MetadataAttributeSchema < Struct.new(
  :key,
  :type,
  :description)
  SENSITIVE = []
  include Aws::Structure
end