Interface CfnIndex.IRelevanceProperty
Provides information for tuning the relevance of a field in a search.
Namespace: Amazon.CDK.AWS.Kendra
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public interface CfnIndex.IRelevancePropertySyntax (vb)
Public Interface CfnIndex.IRelevancePropertyRemarks
When a query includes terms that match the field, the results are given a boost in the response based on these tuning parameters.
ExampleMetadata: fixture=_generated
Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.Kendra;
var relevanceProperty = new RelevanceProperty {
Duration = "duration",
Freshness = false,
Importance = 123,
RankOrder = "rankOrder",
ValueImportanceItems = new [] { new ValueImportanceItemProperty {
Key = "key",
Value = 123
} }
};Synopsis
Properties
| Duration | Specifies the time period that the boost applies to. |
| Freshness | Indicates that this field determines how "fresh" a document is. |
| Importance | The relative importance of the field in the search. |
| RankOrder | Determines how values should be interpreted. |
| ValueImportanceItems | An array of key-value pairs for different boosts when they appear in the search result list. |
Properties
Duration
Specifies the time period that the boost applies to.
string? Duration { get; }Property Value
Remarks
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.
Freshness
Indicates that this field determines how "fresh" a document is.
object? Freshness { get; }Property Value
Remarks
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.
Importance
The relative importance of the field in the search.
double? Importance { get; }Property Value
Remarks
Larger numbers provide more of a boost than smaller numbers.
RankOrder
Determines how values should be interpreted.
string? RankOrder { get; }Property Value
Remarks
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.
ValueImportanceItems
An array of key-value pairs for different boosts when they appear in the search result list.
object? ValueImportanceItems { get; }Property Value
Remarks
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.