Interface ISearchAsYouTypeProperty

A text-like field that is optimized to provide out-of-the-box support for the "search as you type" completion use case.

It creates a series of subfields that are analyzed to index terms that can be efficiently matched by a query that partially matches the entire indexed text value. Both prefix completion (i.e matching terms starting at the beginning of the input) and infix completion (i.e. matching terms at any position within the input) are supported.
Inherited Members
Namespace: OpenSearch.Client
Assembly: OpenSearch.Client.dll
Syntax
public interface ISearchAsYouTypeProperty : ICoreProperty, IProperty, IFieldMapping

Properties

| Edit this page View Source

Analyzer

The analyzer which should be used for analyzed string fields, both at index-time and at search-time (unless overridden by the search_analyzer). Defaults to the default index analyzer, or the standard analyzer.

Declaration
[DataMember(Name = "analyzer")]
string Analyzer { get; set; }
Property Value
Type Description
string
| Edit this page View Source

Index

Should the field be searchable? Accepts true (default) or false.

Declaration
[DataMember(Name = "index")]
bool? Index { get; set; }
Property Value
Type Description
bool?
| Edit this page View Source

IndexOptions

What information should be stored in the index, for search and highlighting purposes. Defaults to Positions.

Declaration
[DataMember(Name = "index_options")]
IndexOptions? IndexOptions { get; set; }
Property Value
Type Description
IndexOptions?
| Edit this page View Source

MaxShingleSize

The largest shingle size to index the input with and create subfields for.

Declaration
[DataMember(Name = "max_shingle_size")]
int? MaxShingleSize { get; set; }
Property Value
Type Description
int?
| Edit this page View Source

Norms

Whether field-length should be taken into account when scoring queries. Accepts true or false. This option configures the root field and shingle subfields, where its default is true. It does not configure the prefix subfield, where it it false.

Declaration
[DataMember(Name = "norms")]
bool? Norms { get; set; }
Property Value
Type Description
bool?
| Edit this page View Source

SearchAnalyzer

The analyzer that should be used at search time on analyzed fields. Defaults to the analyzer setting.

Declaration
[DataMember(Name = "search_analyzer")]
string SearchAnalyzer { get; set; }
Property Value
Type Description
string
| Edit this page View Source

SearchQuoteAnalyzer

The analyzer that should be used at search time when a phrase is encountered. Defaults to the search_analyzer setting.

Declaration
[DataMember(Name = "search_quote_analyzer")]
string SearchQuoteAnalyzer { get; set; }
Property Value
Type Description
string
| Edit this page View Source

TermVector

Whether term vectors should be stored for an analyzed field. Defaults to no. This option configures the root field and shingle subfields, but not the prefix subfield.

Declaration
[DataMember(Name = "term_vector")]
TermVectorOption? TermVector { get; set; }
Property Value
Type Description
TermVectorOption?

Extension Methods