Relevance class

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.

Constructors

Relevance({String? duration, bool? freshness, int? importance, Order? rankOrder, Map<String, int>? valueImportanceMap})
Relevance.fromJson(Map<String, dynamic> json)
factory

Properties

duration → 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.
final
freshness → 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.
final
hashCode → int
The hash code for this object.
no setterinherited
importance → int?
The relative importance of the field in the search. Larger numbers provide more of a boost than smaller numbers.
final
rankOrder → Order?
Determines how values should be interpreted.
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
valueImportanceMap → Map<String, int>?
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.
final

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toJson() → Map<String, dynamic>
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited