Documents - Suggest Get

Serviço:: Search Service

Versão da API:: 2026-04-01

Sugere documentos no índice que correspondem ao texto de consulta parcial fornecido.

GET {endpoint}/indexes('{indexName}')/docs/search.suggest?api-version=2026-04-01&search={search}&suggesterName={suggesterName}

Com parâmetros opcionais:

GET {endpoint}/indexes('{indexName}')/docs/search.suggest?api-version=2026-04-01&search={search}&suggesterName={suggesterName}&$filter={$filter}&fuzzy={fuzzy}&highlightPostTag={highlightPostTag}&highlightPreTag={highlightPreTag}&minimumCoverage={minimumCoverage}&$orderby={$orderby}&searchFields={searchFields}&$select={$select}&$top={$top}

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
endpoint	path	True	string (uri)	A URL do ponto de extremidade do serviço de pesquisa.
indexName	path	True	string	O nome do índice.
api-version	query	True	string minLength: 1	A versão da API a ser usada para esta operação.
search	query	True	string	O texto de pesquisa a ser usado para sugerir documentos. Deve ter pelo menos 1 caractere e não mais do que 100 caracteres.
suggesterName	query	True	string	O nome do sugestor conforme especificado na coleção de sugestores que faz parte da definição de índice.
$filter	query		string	Uma expressão OData que filtra os documentos considerados para sugestões.
$orderby	query		string[]	A lista de expressões $orderby OData pelas quais classificar os resultados. Cada expressão pode ser um nome de campo ou uma chamada para as funções geo.distance() ou search.score(). Cada expressão pode ser seguida por asc para indicar crescente ou desc para indicar decrescente. O padrão é a ordem crescente. Os empates serão interrompidos pelas pontuações de correspondência de documentos. Se nenhuma $orderby for especificada, a ordem de classificação padrão será decrescente por pontuação de correspondência do documento. Pode haver no máximo 32 cláusulas $orderby.
$select	query		string[]	A lista de campos a serem recuperados. Se não for especificado, somente o campo-chave será incluído nos resultados.
$top	query		integer (int32)	O número de sugestões a serem recuperadas. O valor deve ser um número entre 1 e 100. O padrão é 5.
fuzzy	query		boolean	Um valor que indica se a correspondência difusa deve ser usada para a consulta de sugestões. O padrão é false. Quando definida como true, a consulta localizará termos mesmo que haja um caractere substituído ou ausente no texto da pesquisa. Embora isso forneça uma experiência melhor em alguns cenários, ele tem um custo de desempenho, pois as consultas de sugestões difusas são mais lentas e consomem mais recursos.
highlightPostTag	query		string	Uma marca de cadeia de caracteres que é acrescentada a realces de clique. Deve ser definido com highlightPreTag. Se omitido, o realce de sugestões é desativado.
highlightPreTag	query		string	Uma marca de cadeia de caracteres que é acrescentada a realces de clique. Deve ser definido com highlightPostTag. Se omitido, o realce de sugestões é desativado.
minimumCoverage	query		number (double)	Um número entre 0 e 100 que indica a porcentagem do índice que deve ser coberta por uma consulta de sugestões para que a consulta seja relatada como bem-sucedida. Esse parâmetro pode ser útil para garantir a disponibilidade de pesquisa mesmo para serviços com apenas uma réplica. O padrão é 80.
searchFields	query		string[]	A lista de nomes de campo para pesquisar o texto de pesquisa especificado. Os campos de destino devem ser incluídos no sugestor especificado.

Cabeçalho da solicitação

Nome	Obrigatório	Tipo	Description
Accept		Accept	O cabeçalho Aceitar.
x-ms-client-request-id		string (uuid)	Um identificador de cadeia de caracteres opaco, globalmente exclusivo e gerado pelo cliente para a solicitação.

Respostas

Nome	Tipo	Description
200 OK	SuggestDocumentsResult	A solicitação foi bem-sucedida.
Other Status Codes	ErrorResponse	Uma resposta de erro inesperada.

Segurança

api-key

Tipo: apiKey
Em: header

OAuth2Auth

Tipo: oauth2
Flow: implicit
URL de Autorização: https://login.microsoftonline.com/common/oauth2/v2.0/authorize

Escopos

Nome	Description
https://search.azure.com/.default

Exemplos

SearchIndexSuggestDocumentsGet

Solicitação de exemplo

HTTP

GET https://myservice.search.windows.net/indexes('myindex')/docs/search.suggest?api-version=2026-04-01&search=hote&suggesterName=sg&$filter=rating gt 10&fuzzy=False&highlightPostTag=</em>&highlightPreTag=<em>&minimumCoverage=80&$orderby=search.score() desc,rating desc&searchFields=title&$select=docId,title,description&$top=10

Resposta de exemplo

Código de status:: 200

{
  "value": [
    {
      "@search.text": "Nice <em>Hotel</em>",
      "description": "Cheapest hotel in town",
      "docId": "1",
      "title": "Nice Hotel"
    },
    {
      "@search.text": "Fancy <em>Hotel</em>",
      "description": "Best hotel in town",
      "docId": "2",
      "title": "Fancy Hotel"
    }
  ]
}

Definições

Nome	Description
Accept	O cabeçalho Aceitar.
ErrorAdditionalInfo	As informações adicionais do erro de gerenciamento de recursos.
ErrorDetail	O detalhe do erro.
ErrorResponse	Resposta comum de erro para todas as APIs do Azure Resource Manager devolver detalhes de erro em operações falhadas. (Isso também segue o formato de resposta de erro OData.).
SuggestDocumentsResult	Resposta que contém os resultados da consulta de sugestão de um índice.
SuggestResult	Um resultado que contém um documento encontrado por uma consulta de sugestão, além de metadados associados.

Accept

Enumeração

O cabeçalho Aceitar.

Valor	Description
application/json;odata.metadata=none

ErrorAdditionalInfo

Objeto

As informações adicionais do erro de gerenciamento de recursos.

Nome	Tipo	Description
info		As informações adicionais.
type	string	O tipo de informação adicional.

ErrorDetail

Objeto

O detalhe do erro.

Nome	Tipo	Description
additionalInfo	ErrorAdditionalInfo[]	As informações adicionais do erro.
code	string	O código de erro.
details	ErrorDetail[]	Os detalhes do erro.
message	string	A mensagem de erro.
target	string	O destino do erro.

ErrorResponse

Objeto

Resposta comum de erro para todas as APIs do Azure Resource Manager devolver detalhes de erro em operações falhadas. (Isso também segue o formato de resposta de erro OData.).

Nome	Tipo	Description
error	ErrorDetail	O objeto de erro.

SuggestDocumentsResult

Objeto

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

Nome	Tipo	Description
@search.coverage	number (double)	Um valor que indica a porcentagem do índice que foi incluído na consulta ou null se minimumCoverage não tiver sido definido na solicitação.
value	SuggestResult[]	A sequência de resultados retornados pela consulta.

SuggestResult

Objeto

Um resultado que contém um documento encontrado por uma consulta de sugestão, além de metadados associados.

Nome	Tipo	Description
@search.text	string	O texto do resultado da sugestão.