Class SearchAsYouTypeProperty

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.

Inheritance

object

PropertyBase

CorePropertyBase

SearchAsYouTypeProperty

Implements

IPropertyWithClrOrigin

ISearchAsYouTypeProperty

ICoreProperty

IProperty

IFieldMapping

Inherited Members

CorePropertyBase.CopyTo

CorePropertyBase.Fields

CorePropertyBase.Similarity

CorePropertyBase.Store

PropertyBase.LocalMetadata

PropertyBase.Meta

PropertyBase.Name

PropertyBase.DebugDisplay

PropertyBase.ToString()

PropertyBase.TypeOverride

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

Namespace: OpenSearch.Client

Assembly: OpenSearch.Client.dll

Syntax

public class SearchAsYouTypeProperty : CorePropertyBase, IPropertyWithClrOrigin, ISearchAsYouTypeProperty, ICoreProperty, IProperty, IFieldMapping

Constructors

SearchAsYouTypeProperty()

Declaration

public SearchAsYouTypeProperty()

Properties

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

public string Analyzer { get; set; }

Property Value

Type	Description
string

Index

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

Declaration

public bool? Index { get; set; }

Property Value

Type	Description
bool?

IndexOptions

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

Declaration

public IndexOptions? IndexOptions { get; set; }

Property Value

Type	Description
IndexOptions?

MaxShingleSize

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

Declaration

public int? MaxShingleSize { get; set; }

Property Value

Type	Description
int?

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

public bool? Norms { get; set; }

Property Value

Type	Description
bool?

SearchAnalyzer

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

Declaration

public string SearchAnalyzer { get; set; }

Property Value

Type	Description
string

SearchQuoteAnalyzer

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

Declaration

public string SearchQuoteAnalyzer { get; set; }

Property Value

Type	Description
string

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

public TermVectorOption? TermVector { get; set; }

Property Value

Type	Description
TermVectorOption?

Implements

IPropertyWithClrOrigin

ISearchAsYouTypeProperty

ICoreProperty

IProperty

IFieldMapping

Extension Methods

SuffixExtensions.Suffix(object, string)