@Generated(value="software.amazon.awssdk:codegen") public final class Relevance extends Object implements SdkPojo, Serializable, ToCopyableBuilder<Relevance.Builder,Relevance>
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.
| Modifier and Type | Class and Description |
|---|---|
static interface |
Relevance.Builder |
| Modifier and Type | Method and Description |
|---|---|
static Relevance.Builder |
builder() |
String |
duration()
Specifies the time period that the boost applies to.
|
boolean |
equals(Object obj) |
boolean |
equalsBySdkFields(Object obj)
Indicates whether some other object is "equal to" this one by SDK fields.
|
Boolean |
freshness()
Indicates that this field determines how "fresh" a document is.
|
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz) |
int |
hashCode() |
boolean |
hasValueImportanceMap()
For responses, this returns true if the service returned a value for the ValueImportanceMap property.
|
Integer |
importance()
The relative importance of the field in the search.
|
Order |
rankOrder()
Determines how values should be interpreted.
|
String |
rankOrderAsString()
Determines how values should be interpreted.
|
List<SdkField<?>> |
sdkFields() |
static Class<? extends Relevance.Builder> |
serializableBuilderClass() |
Relevance.Builder |
toBuilder()
Take this object and create a builder that contains all of the current property values of this object.
|
String |
toString()
Returns a string representation of this object.
|
Map<String,Integer> |
valueImportanceMap()
A list of values that should be given a different boost when they appear in the result list.
|
copypublic final Boolean 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.
Freshness field on one DATE type field. Only applies to
DATE fields.public final Integer importance()
The relative importance of the field in the search. Larger numbers provide more of a boost than smaller numbers.
public final String 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.
Only applies to DATE fields.
public final Order 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.
If the service returns an enum value that is not available in the current SDK version, rankOrder will
return Order.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from
rankOrderAsString().
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.
Orderpublic final String rankOrderAsString()
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.
If the service returns an enum value that is not available in the current SDK version, rankOrder will
return Order.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from
rankOrderAsString().
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.
Orderpublic final boolean hasValueImportanceMap()
isEmpty() method on the property).
This is useful because the SDK will never return a null collection or map, but you may need to differentiate
between the service returning nothing (or null) and the service returning an empty collection or map. For
requests, this returns true if a value for the property was specified in the request builder, and false if a
value was not specified.public final Map<String,Integer> 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.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that
you can differentiate between null and empty), you can use the hasValueImportanceMap() method.
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.
public Relevance.Builder toBuilder()
ToCopyableBuildertoBuilder in interface ToCopyableBuilder<Relevance.Builder,Relevance>public static Relevance.Builder builder()
public static Class<? extends Relevance.Builder> serializableBuilderClass()
public final boolean equalsBySdkFields(Object obj)
SdkPojoSdkPojo class,
and is generated based on a service model.
If an SdkPojo class does not have any inherited fields, equalsBySdkFields
and equals are essentially the same.
equalsBySdkFields in interface SdkPojoobj - the object to be compared withpublic final String toString()