Copyright | (c) 2013-2023 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | Safe-Inferred |
Language | Haskell2010 |
Synopsis
- data Relevance = Relevance' {}
- newRelevance :: Relevance
- relevance_duration :: Lens' Relevance (Maybe Text)
- relevance_freshness :: Lens' Relevance (Maybe Bool)
- relevance_importance :: Lens' Relevance (Maybe Natural)
- relevance_rankOrder :: Lens' Relevance (Maybe Order)
- relevance_valueImportanceMap :: Lens' Relevance (Maybe (HashMap Text Natural))
Documentation
Provides information for 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: newRelevance
smart constructor.
Relevance' | |
|
Instances
newRelevance :: Relevance Source #
Create a value of Relevance
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:duration:Relevance'
, relevance_duration
- 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.
$sel:freshness:Relevance'
, relevance_freshness
- 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.
$sel:importance:Relevance'
, relevance_importance
- The relative importance of the field in the search. Larger numbers
provide more of a boost than smaller numbers.
$sel:rankOrder:Relevance'
, relevance_rankOrder
- 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.
$sel:valueImportanceMap:Relevance'
, relevance_valueImportanceMap
- 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.
relevance_duration :: Lens' Relevance (Maybe Text) Source #
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.
relevance_freshness :: Lens' Relevance (Maybe Bool) Source #
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.
relevance_importance :: Lens' Relevance (Maybe Natural) Source #
The relative importance of the field in the search. Larger numbers provide more of a boost than smaller numbers.
relevance_rankOrder :: Lens' Relevance (Maybe Order) Source #
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.
relevance_valueImportanceMap :: Lens' Relevance (Maybe (HashMap Text Natural)) Source #
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.