SearchClient.SuggestAsync<T> Método

Definição

Namespace:

Azure.Search.Documents

Assembly:

Azure.Search.Documents.dll

Pacote:

Azure.Search.Documents v11.5.1

Origem:

SearchClient.cs

Executa uma consulta "search-as-you-type" que consiste em uma entrada de texto parcial (mínimo de três caracteres). Ele retorna o texto correspondente encontrado em campos com reconhecimento de sugestão. Azure Cognitive Search procura valores correspondentes em campos predefinidos em um Sugestor. Por exemplo, se você habilitar sugestões em um campo da cidade, digitar "mar" produzirá documentos contendo "Seattle", "Sea Tac" e "Seaside" (todos os nomes reais da cidade) para esse campo. Sugestões

public virtual System.Threading.Tasks.Task<Azure.Response<Azure.Search.Documents.Models.SuggestResults<T>>> SuggestAsync<T> (string searchText, string suggesterName, Azure.Search.Documents.SuggestOptions options = default, System.Threading.CancellationToken cancellationToken = default);

abstract member SuggestAsync : string * string * Azure.Search.Documents.SuggestOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.Search.Documents.Models.SuggestResults<'T>>>
override this.SuggestAsync : string * string * Azure.Search.Documents.SuggestOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.Search.Documents.Models.SuggestResults<'T>>>

Public Overridable Function SuggestAsync(Of T) (searchText As String, suggesterName As String, Optional options As SuggestOptions = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response(Of SuggestResults(Of T)))

Parâmetros de tipo

T

O tipo .NET que mapeia para o esquema de índice. Instâncias desse tipo podem ser recuperadas como documentos do índice.

Parâmetros

searchText

String

O texto de pesquisa a ser usado para sugerir documentos. Deve ter pelo menos 1 e não mais que 100 caracteres.

suggesterName

String

O nome do sugestor conforme especificado na coleção de sugestores que faz parte da definição de índice.

options

SuggestOptions

Opções para filtragem, classificação e outros comportamentos de consulta de sugestões.

cancellationToken

CancellationToken

Opcional CancellationToken para propagar notificações de que a operação deve ser cancelada.

Retornos

Task<Response<SuggestResults<T>>>

Resposta que contém os resultados da consulta de sugestão de um índice.

Exceções

RequestFailedException

Gerado quando uma falha é retornada pelo Serviço de Pesquisa.

Comentários

Os métodos Suggest e SuggestAsync dão suporte ao mapeamento de tipos de campo de pesquisa para tipos .NET por meio do parâmetro de tipo T. Você pode fornecer seu próprio tipo T ou usar o dinâmico SearchDocument. Consulte GetDocumentAsync<T>(String, GetDocumentOptions, CancellationToken) para obter mais detalhes sobre o mapeamento de tipo.