Interface CfnIndex.IDocumentMetadataConfigurationProperty
Specifies the properties, such as relevance tuning and searchability, of an index field.
Namespace: Amazon.CDK.AWS.Kendra
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public interface IDocumentMetadataConfigurationProperty
Syntax (vb)
Public Interface IDocumentMetadataConfigurationProperty
Remarks
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 documentMetadataConfigurationProperty = new DocumentMetadataConfigurationProperty {
Name = "name",
Type = "type",
// the properties below are optional
Relevance = new RelevanceProperty {
Duration = "duration",
Freshness = false,
Importance = 123,
RankOrder = "rankOrder",
ValueImportanceItems = new [] { new ValueImportanceItemProperty {
Key = "key",
Value = 123
} }
},
Search = new SearchProperty {
Displayable = false,
Facetable = false,
Searchable = false,
Sortable = false
}
};
Synopsis
Properties
Name | The name of the index field. |
Relevance | Provides tuning parameters to determine how the field affects the search results. |
Search | Provides information about how the field is used during a search. |
Type | The data type of the index field. |
Properties
Name
The name of the index field.
string Name { get; }
Property Value
System.String
Remarks
Relevance
Provides tuning parameters to determine how the field affects the search results.
virtual object Relevance { get; }
Property Value
System.Object
Remarks
Search
Provides information about how the field is used during a search.
virtual object Search { get; }
Property Value
System.Object
Remarks
Type
The data type of the index field.
string Type { get; }
Property Value
System.String