SearchClient.AutocompleteAsync Method

Definition

Namespace:

Azure.Search.Documents

Assembly:

Azure.Search.Documents.dll

Package:

Azure.Search.Documents v11.6.0

Source:

SearchClient.cs

Suggests query terms based on input text and matching documents in the search index. Autocomplete

public virtual System.Threading.Tasks.Task<Azure.Response<Azure.Search.Documents.Models.AutocompleteResults>> AutocompleteAsync (string searchText, string suggesterName, Azure.Search.Documents.AutocompleteOptions options = default, System.Threading.CancellationToken cancellationToken = default);

abstract member AutocompleteAsync : string * string * Azure.Search.Documents.AutocompleteOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.Search.Documents.Models.AutocompleteResults>>
override this.AutocompleteAsync : string * string * Azure.Search.Documents.AutocompleteOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.Search.Documents.Models.AutocompleteResults>>

Public Overridable Function AutocompleteAsync (searchText As String, suggesterName As String, Optional options As AutocompleteOptions = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response(Of AutocompleteResults))

Parameters

searchText

String

The search text on which to base autocomplete results.

suggesterName

String

The name of the suggester as specified in the suggesters collection that's part of the index definition.

options

AutocompleteOptions

Options that allow specifying autocomplete behaviors, like fuzzy matching.

cancellationToken

CancellationToken

Optional CancellationToken to propagate notifications that the operation should be canceled.

Returns

Task<Response<AutocompleteResults>>

The result of Autocomplete query.

Exceptions

RequestFailedException

Thrown when a failure is returned by the Search Service.