Class: Aws::Kendra::Types::Relevance

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 Relevance data as a hash:

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

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.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#durationString

Specifies the time period that the boost applies to. For example, to make the boost apply to documents with the field value within the last month, you would use “2628000s”. Once the field value is beyond the specified range, the effect of the boost drops off. The higher the importance, the faster the effect drops off. If you don't specify a value, the default is 3 months. The value of the field is a numeric string followed by the character “s”, for example “86400s” for one day, or “604800s” for one week.

Only applies to `DATE` fields.

Returns:

  • (String)

4719
4720
4721
4722
4723
4724
4725
4726
4727
# File 'lib/aws-sdk-kendra/types.rb', line 4719

class Relevance < Struct.new(
  :freshness,
  :importance,
  :duration,
  :rank_order,
  :value_importance_map)
  SENSITIVE = []
  include Aws::Structure
end

#freshnessBoolean

Indicates that this field determines how “fresh” a document is. For example, if document 1 was created on November 5, and document 2 was created on October 31, document 1 is “fresher” than document

  1. You can only set the `Freshness` field on one `DATE` type field.

Only applies to `DATE` fields.

Returns:

  • (Boolean)

4719
4720
4721
4722
4723
4724
4725
4726
4727
# File 'lib/aws-sdk-kendra/types.rb', line 4719

class Relevance < Struct.new(
  :freshness,
  :importance,
  :duration,
  :rank_order,
  :value_importance_map)
  SENSITIVE = []
  include Aws::Structure
end

#importanceInteger

The relative importance of the field in the search. Larger numbers provide more of a boost than smaller numbers.

Returns:

  • (Integer)

4719
4720
4721
4722
4723
4724
4725
4726
4727
# File 'lib/aws-sdk-kendra/types.rb', line 4719

class Relevance < Struct.new(
  :freshness,
  :importance,
  :duration,
  :rank_order,
  :value_importance_map)
  SENSITIVE = []
  include Aws::Structure
end

#rank_orderString

Determines how values should be interpreted.

When the `RankOrder` field is `ASCENDING`, higher numbers are better. For example, a document with a rating score of 10 is higher ranking than a document with a rating score of 1.

When the `RankOrder` field is `DESCENDING`, lower numbers are better. For example, in a task tracking application, a priority 1 task is more important than a priority 5 task.

Only applies to `LONG` and `DOUBLE` fields.

Returns:

  • (String)

4719
4720
4721
4722
4723
4724
4725
4726
4727
# File 'lib/aws-sdk-kendra/types.rb', line 4719

class Relevance < Struct.new(
  :freshness,
  :importance,
  :duration,
  :rank_order,
  :value_importance_map)
  SENSITIVE = []
  include Aws::Structure
end

#value_importance_mapHash<String,Integer>

A list of values that should be given a different boost when they appear in the result list. For example, if you are boosting a field called “department,” query terms that match the department field are boosted in the result. However, you can add entries from the department field to boost documents with those values higher.

For example, you can add entries to the map with names of departments. If you add “HR”,5 and “Legal”,3 those departments are given special attention when they appear in the metadata of a document. When those terms appear they are given the specified importance instead of the regular importance for the boost.

Returns:

  • (Hash<String,Integer>)

4719
4720
4721
4722
4723
4724
4725
4726
4727
# File 'lib/aws-sdk-kendra/types.rb', line 4719

class Relevance < Struct.new(
  :freshness,
  :importance,
  :duration,
  :rank_order,
  :value_importance_map)
  SENSITIVE = []
  include Aws::Structure
end