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 do URI

Name	Em	Necessá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 utilizar 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 de 100 caracteres.
suggesterName	query	True	string	O nome do sugestionador, conforme especificado na coleção de sugestionadores que faz parte da definição do índice.
$filter	query		string	Uma expressão OData que filtra os documentos considerados para sugestões.
$orderby	query		string[]	A lista de OData $orderby expressões 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 ascendente, ou desc para indicar descendente. O padrão é ordem crescente. Os empates serão quebrados pelas pontuações dos documentos. Se nenhum $orderby for especificado, a ordem de classificação padrão será decrescente por pontuação de correspondência de documento. Pode haver no máximo 32 $orderby cláusulas.
$select	query		string[]	A lista de campos a recuperar. Se não for especificado, apenas o campo-chave será incluído nos resultados.
$top	query		integer (int32)	O número de sugestões a recuperar. O valor deve ser um número entre 1 e 100. A predefinição é 5.
fuzzy	query		boolean	Um valor que indica se a correspondência difusa deve ser usada para a consulta de sugestões. O valor predefinido é falso. Quando definida como true, a consulta encontrará termos mesmo se houver um caractere substituído ou ausente no texto da pesquisa. Embora isso proporcione uma experiência melhor em alguns cenários, tem um custo de desempenho, pois as consultas de sugestões difusas, são mais lentas e consomem mais recursos.
highlightPostTag	query		string	Uma tag de cadeia de caracteres que é anexada aos destaques de clique. Deve ser definido com highlightPreTag. Se omitido, o realce de sugestões é desativado.
highlightPreTag	query		string	Uma tag de cadeia de caracteres que é preparada para atingir destaques. Deve ser definido com highlightPostTag. Se omitido, o realce de sugestões é desativado.
minimumCoverage	query		number (double)	Um número entre 0 e 100 indicando a porcentagem do índice que deve ser coberta por uma consulta de sugestões para que a consulta seja relatada como um sucesso. Esse parâmetro pode ser útil para garantir a disponibilidade da pesquisa, mesmo para serviços com apenas uma réplica. O padrão é 80.
searchFields	query		string[]	A lista de nomes de campos para procurar o texto de pesquisa especificado. Os campos de destino devem ser incluídos no sugeridor especificado.

Cabeçalho do Pedido

Name	Necessário	Tipo	Description
Accept		Accept	O cabeçalho Aceitar.
x-ms-client-request-id		string (uuid)	Um identificador de string opaco, globalmente único e gerado pelo cliente para o pedido.

Respostas

Name	Tipo	Description
200 OK	SuggestDocumentsResult	O pedido foi bem-sucedido.
Other Status Codes	ErrorResponse	Uma resposta de erro inesperada.

Segurança

api-key

Tipo: apiKey
Em: header

OAuth2Auth

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

Âmbitos

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

Exemplos

SearchIndexSuggestDocumentsGet

Pedido de amostra

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 da amostra

Código de estado:: 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

Name	Description
Accept	O cabeçalho Aceitar.
ErrorAdditionalInfo	O erro de gerenciamento de recursos informações adicionais.
ErrorDetail	O detalhe do erro.
ErrorResponse	Resposta de erro comum para todas as APIs do Azure Resource Manager devolver detalhes de erro para operações falhadas. (Isso também segue o formato de resposta de erro OData.)
SuggestDocumentsResult	Resposta contendo resultados de 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

Object

O erro de gerenciamento de recursos informações adicionais.

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

ErrorDetail

Object

O detalhe do erro.

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

ErrorResponse

Object

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

Name	Tipo	Description
error	ErrorDetail	O objeto de erro.

SuggestDocumentsResult

Object

Resposta contendo resultados de consulta de sugestão de um índice.

Name	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 foi definido na solicitação.
value	SuggestResult[]	A sequência de resultados retornada pela consulta.

SuggestResult

Object

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

Name	Tipo	Description
@search.text	string	O texto da sugestão resulta.