Struct rusoto_kendra::Relevance

pub struct Relevance {
    pub duration: Option<String>,
    pub freshness: Option<bool>,
    pub importance: Option<i64>,
    pub rank_order: Option<String>,
    pub value_importance_map: Option<HashMap<String, i64>>,
}

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.

Fields

duration: Option<String>

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.

freshness: Option<bool>

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 2. You can only set the Freshness field on one DATE type field. Only applies to DATE fields.

importance: Option<i64>

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

rank_order: Option<String>

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.

value_importance_map: Option<HashMap<String, i64>>

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.

Trait Implementations

impl Clone for Relevance

pub fn clone(&self) -> Relevance

Returns a copy of the value.

pub fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Relevance

pub fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for Relevance

pub fn default() -> Relevance

Returns the "default value" for a type.

impl<'de> Deserialize<'de> for Relevance

pub fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl PartialEq<Relevance> for Relevance

pub fn eq(&self, other: &Relevance) -> bool

This method tests for self and other values to be equal, and is used by ==.

pub fn ne(&self, other: &Relevance) -> bool

This method tests for !=.

impl Serialize for Relevance

pub fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error> where
    __S: Serializer, 

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for Relevance