Package software.amazon.awscdk.services.kendra

Class CfnIndex.RelevanceProperty.Jsii$Proxy

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.services.kendra.CfnIndex.RelevanceProperty.Jsii$Proxy

All Implemented Interfaces:

CfnIndex.RelevanceProperty, software.amazon.jsii.JsiiSerializable

Enclosing interface:

CfnIndex.RelevanceProperty

@Stability(Stable)
@Internal
public static final class CfnIndex.RelevanceProperty.Jsii$Proxy
extends software.amazon.jsii.JsiiObject
implements CfnIndex.RelevanceProperty

An implementation for CfnIndex.RelevanceProperty

Nested Class Summary

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.services.kendra.CfnIndex.RelevanceProperty

CfnIndex.RelevanceProperty.Builder, CfnIndex.RelevanceProperty.Jsii$Proxy

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Jsii$Proxy(CfnIndex.RelevanceProperty.Builder builder)	Constructor that initializes the object based on literal property values passed by the CfnIndex.RelevanceProperty.Builder.
protected	Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)	Constructor that initializes the object based on values retrieved from the JsiiObject.

Method Summary

Modifier and Type	Method	Description
com.fasterxml.jackson.databind.JsonNode	$jsii$toJson()
final boolean	equals(Object o)
final String	getDuration()	Specifies the time period that the boost applies to.
final Object	getFreshness()	Indicates that this field determines how "fresh" a document is.
final Number	getImportance()	The relative importance of the field in the search.
final String	getRankOrder()	Determines how values should be interpreted.
final Object	getValueImportanceItems()	An array of key-value pairs for different boosts when they appear in the search result list.
final int	hashCode()

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Details

Jsii$Proxy

protected Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)

Constructor that initializes the object based on values retrieved from the JsiiObject.

Parameters:

objRef - Reference to the JSII managed object.

Jsii$Proxy

protected Jsii$Proxy(CfnIndex.RelevanceProperty.Builder builder)

Constructor that initializes the object based on literal property values passed by the CfnIndex.RelevanceProperty.Builder.

Method Details

getDuration

public final String getDuration()

Description copied from interface: CfnIndex.RelevanceProperty

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.

Specified by:

getDuration in interface CfnIndex.RelevanceProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-index-relevance.html#cfn-kendra-index-relevance-duration

getFreshness

public final Object getFreshness()

Description copied from interface: CfnIndex.RelevanceProperty

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.

Specified by:

getFreshness in interface CfnIndex.RelevanceProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-index-relevance.html#cfn-kendra-index-relevance-freshness

getImportance

public final Number getImportance()

Description copied from interface: CfnIndex.RelevanceProperty

The relative importance of the field in the search.

Larger numbers provide more of a boost than smaller numbers.

Specified by:

getImportance in interface CfnIndex.RelevanceProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-index-relevance.html#cfn-kendra-index-relevance-importance

getRankOrder

public final String getRankOrder()

Description copied from interface: CfnIndex.RelevanceProperty

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.

Specified by:

getRankOrder in interface CfnIndex.RelevanceProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-index-relevance.html#cfn-kendra-index-relevance-rankorder

getValueImportanceItems

public final Object getValueImportanceItems()

Description copied from interface: CfnIndex.RelevanceProperty

An array of key-value pairs for different boosts when they appear in the search result list.

For example, if you want to boost query terms that match the "department" field in the result, query terms that match this 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.

Specified by:

getValueImportanceItems in interface CfnIndex.RelevanceProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-index-relevance.html#cfn-kendra-index-relevance-valueimportanceitems

$jsii$toJson

@Internal
public com.fasterxml.jackson.databind.JsonNode $jsii$toJson()

Specified by:

$jsii$toJson in interface software.amazon.jsii.JsiiSerializable

equals

public final boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public final int hashCode()

Overrides:

hashCode in class Object