@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class Relevance extends Object implements Serializable, Cloneable, StructuredPojo
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.
| Constructor and Description |
|---|
Relevance() |
| Modifier and Type | Method and Description |
|---|---|
Relevance |
addValueImportanceMapEntry(String key,
Integer value)
Add a single ValueImportanceMap entry
|
Relevance |
clearValueImportanceMapEntries()
Removes all the entries added into ValueImportanceMap.
|
Relevance |
clone() |
boolean |
equals(Object obj) |
String |
getDuration()
Specifies the time period that the boost applies to.
|
Boolean |
getFreshness()
Indicates that this field determines how "fresh" a document is.
|
Integer |
getImportance()
The relative importance of the field in the search.
|
String |
getRankOrder()
Determines how values should be interpreted.
|
Map<String,Integer> |
getValueImportanceMap()
A list of values that should be given a different boost when they appear in the result list.
|
int |
hashCode() |
Boolean |
isFreshness()
Indicates that this field determines how "fresh" a document is.
|
void |
marshall(ProtocolMarshaller protocolMarshaller)
Marshalls this structured data using the given
ProtocolMarshaller. |
void |
setDuration(String duration)
Specifies the time period that the boost applies to.
|
void |
setFreshness(Boolean freshness)
Indicates that this field determines how "fresh" a document is.
|
void |
setImportance(Integer importance)
The relative importance of the field in the search.
|
void |
setRankOrder(String rankOrder)
Determines how values should be interpreted.
|
void |
setValueImportanceMap(Map<String,Integer> valueImportanceMap)
A list of values that should be given a different boost when they appear in the result list.
|
String |
toString()
Returns a string representation of this object.
|
Relevance |
withDuration(String duration)
Specifies the time period that the boost applies to.
|
Relevance |
withFreshness(Boolean freshness)
Indicates that this field determines how "fresh" a document is.
|
Relevance |
withImportance(Integer importance)
The relative importance of the field in the search.
|
Relevance |
withRankOrder(Order rankOrder)
Determines how values should be interpreted.
|
Relevance |
withRankOrder(String rankOrder)
Determines how values should be interpreted.
|
Relevance |
withValueImportanceMap(Map<String,Integer> valueImportanceMap)
A list of values that should be given a different boost when they appear in the result list.
|
public void setFreshness(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. Only applies to
DATE fields.
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. Only
applies to DATE fields.public Boolean getFreshness()
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. Only applies to
DATE fields.
DATE fields.public Relevance withFreshness(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. Only applies to
DATE fields.
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. Only
applies to DATE fields.public Boolean isFreshness()
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. Only applies to
DATE fields.
DATE fields.public void setImportance(Integer importance)
The relative importance of the field in the search. Larger numbers provide more of a boost than smaller numbers.
importance - The relative importance of the field in the search. Larger numbers provide more of a boost than smaller
numbers.public Integer getImportance()
The relative importance of the field in the search. Larger numbers provide more of a boost than smaller numbers.
public Relevance withImportance(Integer importance)
The relative importance of the field in the search. Larger numbers provide more of a boost than smaller numbers.
importance - The relative importance of the field in the search. Larger numbers provide more of a boost than smaller
numbers.public void setDuration(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.
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.
public String getDuration()
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 Relevance withDuration(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.
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.
public void setRankOrder(String 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 fields.
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 fields.
Orderpublic String getRankOrder()
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 fields.
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 fields.
Orderpublic Relevance withRankOrder(String 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 fields.
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 fields.
Orderpublic Relevance withRankOrder(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 fields.
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 fields.
Orderpublic Map<String,Integer> getValueImportanceMap()
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.
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 void setValueImportanceMap(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.
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.
public Relevance withValueImportanceMap(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.
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.
public Relevance addValueImportanceMapEntry(String key, Integer value)
public Relevance clearValueImportanceMapEntries()
public String toString()
toString in class ObjectObject.toString()public void marshall(ProtocolMarshaller protocolMarshaller)
StructuredPojoProtocolMarshaller.marshall in interface StructuredPojoprotocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.