software.amazon.awssdk.services.kendra.model

Class Relevance

java.lang.Object

software.amazon.awssdk.services.kendra.model.Relevance

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<Relevance.Builder,Relevance>

@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.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	Relevance.Builder

Method Summary

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() Returns true if the ValueImportanceMap property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
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.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

freshness

public 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.

Returns:

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.

importance

public final Integer importance()

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

Returns:

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

duration

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.

Returns:

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.

rankOrder

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().

Returns:

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.

See Also:

Order

rankOrderAsString

public 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().

Returns:

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.

See Also:

Order

hasValueImportanceMap

public final boolean hasValueImportanceMap()

Returns true if the ValueImportanceMap property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

valueImportanceMap

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.

You can use hasValueImportanceMap() to see if a value was sent in this field.

Returns:

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.

toBuilder

public Relevance.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Take this object and create a builder that contains all of the current property values of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<Relevance.Builder,Relevance>

Returns:

a builder for type T

builder

public static Relevance.Builder builder()

serializableBuilderClass

public static Class<? extends Relevance.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Description copied from interface: SdkPojo

Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo 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.

Specified by:

equalsBySdkFields in interface SdkPojo

Parameters:

obj - the object to be compared with

Returns:

true if the other object equals to this object by sdk fields, false otherwise.

toString

public final String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo

Returns:

List of SdkField in this POJO. May be empty list but should never be null.