Class: Aws::Kendra::Types::DocumentMetadataConfiguration

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-kendra/types.rb

Overview

Note:

When making an API call, you may pass DocumentMetadataConfiguration data as a hash:

{
  name: "DocumentMetadataConfigurationName", # required
  type: "STRING_VALUE", # required, accepts STRING_VALUE, STRING_LIST_VALUE, LONG_VALUE, DATE_VALUE
  relevance: {
    freshness: false,
    importance: 1,
    duration: "Duration",
    rank_order: "ASCENDING", # accepts ASCENDING, DESCENDING
    value_importance_map: {
      "ValueImportanceMapKey" => 1,
    },
  },
  search: {
    facetable: false,
    searchable: false,
    displayable: false,
    sortable: false,
  },
}

Specifies the properties of a custom index field.

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#name ⇒ String

The name of the index field.

Returns:

  • (String) 

3433
3434
3435
3436
3437
3438
3439
3440
 
# File 'lib/aws-sdk-kendra/types.rb', line 3433

class DocumentMetadataConfiguration < Struct.new(
  :name,
  :type,
  :relevance,
  :search)
  SENSITIVE = []
  include Aws::Structure
end

#relevance ⇒ Types::Relevance

Provides manual tuning parameters to determine how the field affects the search results.

Returns:


3433
3434
3435
3436
3437
3438
3439
3440
 
# File 'lib/aws-sdk-kendra/types.rb', line 3433

class DocumentMetadataConfiguration < Struct.new(
  :name,
  :type,
  :relevance,
  :search)
  SENSITIVE = []
  include Aws::Structure
end

#search ⇒ Types::Search

Provides information about how the field is used during a search.

Returns:


3433
3434
3435
3436
3437
3438
3439
3440
 
# File 'lib/aws-sdk-kendra/types.rb', line 3433

class DocumentMetadataConfiguration < Struct.new(
  :name,
  :type,
  :relevance,
  :search)
  SENSITIVE = []
  include Aws::Structure
end

#type ⇒ String

The data type of the index field.

Returns:

  • (String) 

3433
3434
3435
3436
3437
3438
3439
3440
 
# File 'lib/aws-sdk-kendra/types.rb', line 3433

class DocumentMetadataConfiguration < Struct.new(
  :name,
  :type,
  :relevance,
  :search)
  SENSITIVE = []
  include Aws::Structure
end