Share via


SearchSuggester Class

Definition

Defines how the Suggest API should apply to a group of fields in the index.

public class SearchSuggester
public class SearchSuggester : System.ClientModel.Primitives.IJsonModel<Azure.Search.Documents.Indexes.Models.SearchSuggester>, System.ClientModel.Primitives.IPersistableModel<Azure.Search.Documents.Indexes.Models.SearchSuggester>
type SearchSuggester = class
type SearchSuggester = class
    interface IJsonModel<SearchSuggester>
    interface IPersistableModel<SearchSuggester>
Public Class SearchSuggester
Public Class SearchSuggester
Implements IJsonModel(Of SearchSuggester), IPersistableModel(Of SearchSuggester)
Inheritance
SearchSuggester
Implements

Constructors

SearchSuggester(String, IEnumerable<String>)

Creates a new instance of the SearchSuggester class.

SearchSuggester(String, String[])

Creates a new instance of the SearchSuggester class.

Properties

Name

The name of the suggester.

SourceFields

The list of field names to which the suggester applies. Each field must be searchable.

Methods

JsonModelWriteCore(Utf8JsonWriter, ModelReaderWriterOptions)

Explicit Interface Implementations

IJsonModel<SearchSuggester>.Create(Utf8JsonReader, ModelReaderWriterOptions)

Reads one JSON value (including objects or arrays) from the provided reader and converts it to a model.

IJsonModel<SearchSuggester>.Write(Utf8JsonWriter, ModelReaderWriterOptions)

Writes the model to the provided Utf8JsonWriter.

IPersistableModel<SearchSuggester>.Create(BinaryData, ModelReaderWriterOptions)

Converts the provided BinaryData into a model.

IPersistableModel<SearchSuggester>.GetFormatFromOptions(ModelReaderWriterOptions)

Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service.

IPersistableModel<SearchSuggester>.Write(ModelReaderWriterOptions)

Writes the model into a BinaryData.

Applies to