software.amazon.awscdk.services.kendra

Interface CfnIndex.RelevanceProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnIndex.RelevanceProperty.Jsii$Proxy

Enclosing class:

CfnIndex

@Stability(value=Stable)
public static interface CfnIndex.RelevanceProperty
extends software.amazon.jsii.JsiiSerializable

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.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.kendra.*;
 RelevanceProperty relevanceProperty = RelevanceProperty.builder()
         .duration("duration")
         .freshness(false)
         .importance(123)
         .rankOrder("rankOrder")
         .valueImportanceItems(List.of(ValueImportanceItemProperty.builder()
                 .key("key")
                 .value(123)
                 .build()))
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	CfnIndex.RelevanceProperty.Builder A builder for CfnIndex.RelevanceProperty
static class	CfnIndex.RelevanceProperty.Jsii$Proxy An implementation for CfnIndex.RelevanceProperty

Method Summary

Modifier and Type	Method and Description
static CfnIndex.RelevanceProperty.Builder	builder()
default String	getDuration() Specifies the time period that the boost applies to.
default Object	getFreshness() Indicates that this field determines how "fresh" a document is.
default Number	getImportance() The relative importance of the field in the search.
default String	getRankOrder() Determines how values should be interpreted.
default Object	getValueImportanceItems() An array of key-value pairs that contains an array of values that should be given a different boost when they appear in the search result list.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getDuration

@Stability(value=Stable)
 @Nullable
default 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.

getFreshness

@Stability(value=Stable)
 @Nullable
default Object 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. You can only set the Freshness field on one DATE type field. Only applies to DATE fields.

getImportance

@Stability(value=Stable)
 @Nullable
default Number getImportance()

The relative importance of the field in the search.

Larger numbers provide more of a boost than smaller numbers.

getRankOrder

@Stability(value=Stable)
 @Nullable
default 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 and DOUBLE fields.

getValueImportanceItems

@Stability(value=Stable)
 @Nullable
default Object getValueImportanceItems()

An array of key-value pairs that contains an array of values that should be given a different boost when they appear in the search result list.

For example, if you are boosting query terms that match the department field in the result, query terms that match the department field are boosted in the result. 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.

builder

@Stability(value=Stable)
static CfnIndex.RelevanceProperty.Builder builder()

Returns:

a CfnIndex.RelevanceProperty.Builder of CfnIndex.RelevanceProperty