You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

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

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing DocumentMetadataConfiguration as input to an Aws::Client method, you can use a vanilla 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:

Instance Attribute Summary collapse

Instance Attribute Details

#name ⇒ String

The name of the index field.

Returns:

  • (String) —

    The name of the index field.

#relevance ⇒ Types::Relevance

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

Returns:

  • (Types::Relevance) —

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

#search ⇒ Types::Search

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

Returns:

  • (Types::Search) —

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

#type ⇒ String

The data type of the index field.

Possible values:

  • STRING_VALUE
  • STRING_LIST_VALUE
  • LONG_VALUE
  • DATE_VALUE

Returns:

  • (String) —

    The data type of the index field.