Class: Aws::Kendra::Types::DocumentRelevanceConfiguration

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

Overview

Note:

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

{
  name: "DocumentMetadataConfigurationName", # required
  relevance: { # required
    freshness: false,
    importance: 1,
    duration: "Duration",
    rank_order: "ASCENDING", # accepts ASCENDING, DESCENDING
    value_importance_map: {
      "ValueImportanceMapKey" => 1,
    },
  },
}

Overrides the document relevance properties of a custom index field.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#nameString

The name of the tuning configuration to override document relevance at the index level.

Returns:

  • (String)


4533
4534
4535
4536
4537
4538
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 4533

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

#relevanceTypes::Relevance

Provides information for manually tuning the relevance of a field in a search. When a query includes terms that match the field, the results are given a boost in the response based on these tuning parameters.

Returns:



4533
4534
4535
4536
4537
4538
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 4533

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