AWS SDK for C++  1.9.1
AWS SDK for C++
Public Member Functions | List of all members
Aws::kendra::Model::Relevance Class Reference

#include <Relevance.h>

Public Member Functions

 Relevance ()
 
 Relevance (Aws::Utils::Json::JsonView jsonValue)
 
Relevanceoperator= (Aws::Utils::Json::JsonView jsonValue)
 
Aws::Utils::Json::JsonValue Jsonize () const
 
bool GetFreshness () const
 
bool FreshnessHasBeenSet () const
 
void SetFreshness (bool value)
 
RelevanceWithFreshness (bool value)
 
int GetImportance () const
 
bool ImportanceHasBeenSet () const
 
void SetImportance (int value)
 
RelevanceWithImportance (int value)
 
const Aws::StringGetDuration () const
 
bool DurationHasBeenSet () const
 
void SetDuration (const Aws::String &value)
 
void SetDuration (Aws::String &&value)
 
void SetDuration (const char *value)
 
RelevanceWithDuration (const Aws::String &value)
 
RelevanceWithDuration (Aws::String &&value)
 
RelevanceWithDuration (const char *value)
 
const OrderGetRankOrder () const
 
bool RankOrderHasBeenSet () const
 
void SetRankOrder (const Order &value)
 
void SetRankOrder (Order &&value)
 
RelevanceWithRankOrder (const Order &value)
 
RelevanceWithRankOrder (Order &&value)
 
const Aws::Map< Aws::String, int > & GetValueImportanceMap () const
 
bool ValueImportanceMapHasBeenSet () const
 
void SetValueImportanceMap (const Aws::Map< Aws::String, int > &value)
 
void SetValueImportanceMap (Aws::Map< Aws::String, int > &&value)
 
RelevanceWithValueImportanceMap (const Aws::Map< Aws::String, int > &value)
 
RelevanceWithValueImportanceMap (Aws::Map< Aws::String, int > &&value)
 
RelevanceAddValueImportanceMap (const Aws::String &key, int value)
 
RelevanceAddValueImportanceMap (Aws::String &&key, int value)
 
RelevanceAddValueImportanceMap (const char *key, int value)
 

Detailed Description

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.

See Also:

AWS API Reference

Definition at line 36 of file Relevance.h.

Constructor & Destructor Documentation

◆ Relevance() [1/2]

Aws::kendra::Model::Relevance::Relevance ( )

◆ Relevance() [2/2]

Aws::kendra::Model::Relevance::Relevance ( Aws::Utils::Json::JsonView  jsonValue)

Member Function Documentation

◆ AddValueImportanceMap() [1/3]

Relevance& Aws::kendra::Model::Relevance::AddValueImportanceMap ( Aws::String &&  key,
int  value 
)
inline

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.

Definition at line 379 of file Relevance.h.

◆ AddValueImportanceMap() [2/3]

Relevance& Aws::kendra::Model::Relevance::AddValueImportanceMap ( const Aws::String key,
int  value 
)
inline

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.

Definition at line 366 of file Relevance.h.

◆ AddValueImportanceMap() [3/3]

Relevance& Aws::kendra::Model::Relevance::AddValueImportanceMap ( const char *  key,
int  value 
)
inline

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.

Definition at line 392 of file Relevance.h.

◆ DurationHasBeenSet()

bool Aws::kendra::Model::Relevance::DurationHasBeenSet ( ) const
inline

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.

Definition at line 129 of file Relevance.h.

◆ FreshnessHasBeenSet()

bool Aws::kendra::Model::Relevance::FreshnessHasBeenSet ( ) const
inline

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.

Definition at line 61 of file Relevance.h.

◆ GetDuration()

const Aws::String& Aws::kendra::Model::Relevance::GetDuration ( ) const
inline

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.

Definition at line 117 of file Relevance.h.

◆ GetFreshness()

bool Aws::kendra::Model::Relevance::GetFreshness ( ) const
inline

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.

Definition at line 52 of file Relevance.h.

◆ GetImportance()

int Aws::kendra::Model::Relevance::GetImportance ( ) const
inline

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

Definition at line 86 of file Relevance.h.

◆ GetRankOrder()

const Order& Aws::kendra::Model::Relevance::GetRankOrder ( ) const
inline

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.

Definition at line 214 of file Relevance.h.

◆ GetValueImportanceMap()

const Aws::Map<Aws::String, int>& Aws::kendra::Model::Relevance::GetValueImportanceMap ( ) const
inline

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.

Definition at line 288 of file Relevance.h.

◆ ImportanceHasBeenSet()

bool Aws::kendra::Model::Relevance::ImportanceHasBeenSet ( ) const
inline

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

Definition at line 92 of file Relevance.h.

◆ Jsonize()

Aws::Utils::Json::JsonValue Aws::kendra::Model::Relevance::Jsonize ( ) const

◆ operator=()

Relevance& Aws::kendra::Model::Relevance::operator= ( Aws::Utils::Json::JsonView  jsonValue)

◆ RankOrderHasBeenSet()

bool Aws::kendra::Model::Relevance::RankOrderHasBeenSet ( ) const
inline

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.

Definition at line 226 of file Relevance.h.

◆ SetDuration() [1/3]

void Aws::kendra::Model::Relevance::SetDuration ( Aws::String &&  value)
inline

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.

Definition at line 153 of file Relevance.h.

◆ SetDuration() [2/3]

void Aws::kendra::Model::Relevance::SetDuration ( const Aws::String value)
inline

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.

Definition at line 141 of file Relevance.h.

◆ SetDuration() [3/3]

void Aws::kendra::Model::Relevance::SetDuration ( const char *  value)
inline

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.

Definition at line 165 of file Relevance.h.

◆ SetFreshness()

void Aws::kendra::Model::Relevance::SetFreshness ( bool  value)
inline

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.

Definition at line 70 of file Relevance.h.

◆ SetImportance()

void Aws::kendra::Model::Relevance::SetImportance ( int  value)
inline

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

Definition at line 98 of file Relevance.h.

◆ SetRankOrder() [1/2]

void Aws::kendra::Model::Relevance::SetRankOrder ( const Order value)
inline

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.

Definition at line 238 of file Relevance.h.

◆ SetRankOrder() [2/2]

void Aws::kendra::Model::Relevance::SetRankOrder ( Order &&  value)
inline

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.

Definition at line 250 of file Relevance.h.

◆ SetValueImportanceMap() [1/2]

void Aws::kendra::Model::Relevance::SetValueImportanceMap ( Aws::Map< Aws::String, int > &&  value)
inline

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.

Definition at line 327 of file Relevance.h.

◆ SetValueImportanceMap() [2/2]

void Aws::kendra::Model::Relevance::SetValueImportanceMap ( const Aws::Map< Aws::String, int > &  value)
inline

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.

Definition at line 314 of file Relevance.h.

◆ ValueImportanceMapHasBeenSet()

bool Aws::kendra::Model::Relevance::ValueImportanceMapHasBeenSet ( ) const
inline

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.

Definition at line 301 of file Relevance.h.

◆ WithDuration() [1/3]

Relevance& Aws::kendra::Model::Relevance::WithDuration ( Aws::String &&  value)
inline

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.

Definition at line 189 of file Relevance.h.

◆ WithDuration() [2/3]

Relevance& Aws::kendra::Model::Relevance::WithDuration ( const Aws::String value)
inline

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.

Definition at line 177 of file Relevance.h.

◆ WithDuration() [3/3]

Relevance& Aws::kendra::Model::Relevance::WithDuration ( const char *  value)
inline

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.

Definition at line 201 of file Relevance.h.

◆ WithFreshness()

Relevance& Aws::kendra::Model::Relevance::WithFreshness ( bool  value)
inline

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.

Definition at line 79 of file Relevance.h.

◆ WithImportance()

Relevance& Aws::kendra::Model::Relevance::WithImportance ( int  value)
inline

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

Definition at line 104 of file Relevance.h.

◆ WithRankOrder() [1/2]

Relevance& Aws::kendra::Model::Relevance::WithRankOrder ( const Order value)
inline

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.

Definition at line 262 of file Relevance.h.

◆ WithRankOrder() [2/2]

Relevance& Aws::kendra::Model::Relevance::WithRankOrder ( Order &&  value)
inline

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.

Definition at line 274 of file Relevance.h.

◆ WithValueImportanceMap() [1/2]

Relevance& Aws::kendra::Model::Relevance::WithValueImportanceMap ( Aws::Map< Aws::String, int > &&  value)
inline

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.

Definition at line 353 of file Relevance.h.

◆ WithValueImportanceMap() [2/2]

Relevance& Aws::kendra::Model::Relevance::WithValueImportanceMap ( const Aws::Map< Aws::String, int > &  value)
inline

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.

Definition at line 340 of file Relevance.h.


The documentation for this class was generated from the following file: