Interface CfnIndex.ISearchProperty
Provides information about how a custom index field is used during a search.
Namespace: Amazon.CDK.AWS.Kendra
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public interface ISearchProperty
Syntax (vb)
Public Interface ISearchProperty
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 searchProperty = new SearchProperty {
Displayable = false,
Facetable = false,
Searchable = false,
Sortable = false
};
Synopsis
Properties
Displayable | Determines whether the field is returned in the query response. |
Facetable | Indicates that the field can be used to create search facets, a count of results for each value in the field. |
Searchable | Determines whether the field is used in the search. |
Sortable | Determines whether the field can be used to sort the results of a query. |
Properties
Displayable
Determines whether the field is returned in the query response.
virtual object Displayable { get; }
Property Value
System.Object
Remarks
Facetable
Indicates that the field can be used to create search facets, a count of results for each value in the field.
virtual object Facetable { get; }
Property Value
System.Object
Remarks
Searchable
Determines whether the field is used in the search.
virtual object Searchable { get; }
Property Value
System.Object
Remarks
If the Searchable
field is true
, you can use relevance tuning to manually tune how Amazon Kendra weights the field in the search. The default is true
for string fields and false
for number and date fields.
Sortable
Determines whether the field can be used to sort the results of a query.
virtual object Sortable { get; }
Property Value
System.Object