Documents - Autocomplete Get

Serviço:: Search Service

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

Preenche automaticamente termos de consulta incompletos com base no texto de entrada e nos termos correspondentes no índice.

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

Com parâmetros opcionais:

GET {endpoint}/indexes('{indexName}')/docs/search.autocomplete?api-version=2026-04-01&search={search}&suggesterName={suggesterName}&autocompleteMode={autocompleteMode}&$filter={$filter}&fuzzy={fuzzy}&highlightPostTag={highlightPostTag}&highlightPreTag={highlightPreTag}&minimumCoverage={minimumCoverage}&searchFields={searchFields}&$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 prazo incompleto que deve ser preenchido automaticamente.
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 usados para produzir termos concluídos para o resultado do preenchimento automático.
$top	query		integer (int32)	O número de termos preenchidos automaticamente a serem recuperados. Deve ser um valor entre 1 e 100. O padrão é 5.
autocompleteMode	query		AutocompleteMode	Especifica o modo de preenchimento automático. O padrão é 'oneTerm'. Use 'twoTerms' para obter shingles e 'oneTermWithContext' para usar o contexto atual ao produzir termos preenchidos automaticamente.
fuzzy	query		boolean	Um valor que indica se a correspondência difusa deve ser usada para a consulta de preenchimento automático. 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 preenchimento automático difuso 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 ocorrências será 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 ocorrências será 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 preenchimento automático 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 a serem considerados ao consultar termos preenchidos automaticamente. 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	AutocompleteResult	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

SearchIndexAutocompleteDocumentsGet

Solicitação de exemplo

HTTP

GET https://myservice.search.windows.net/indexes('myindex')/docs/search.autocomplete?api-version=2026-04-01&search=washington medic&suggesterName=sg&autocompleteMode=oneTerm&fuzzy=False&highlightPostTag=</em>&highlightPreTag=<em>&minimumCoverage=80&searchFields=title,description

Resposta de exemplo

Código de status:: 200

{
  "value": [
    {
      "text": "medicaid",
      "queryPlusText": "washington medicaid"
    },
    {
      "text": "medicare",
      "queryPlusText": "washington medicare"
    },
    {
      "text": "medicine",
      "queryPlusText": "washington medicine"
    }
  ]
}

Definições

Nome	Description
Accept	O cabeçalho Aceitar.
AutocompleteItem	O resultado das solicitações de preenchimento automático.
AutocompleteMode	Especifica o modo de preenchimento automático. O padrão é 'oneTerm'. Use 'twoTerms' para obter shingles e 'oneTermWithContext' para usar o contexto atual na produção de termos de preenchimento automático.
AutocompleteResult	O resultado da consulta de preenchimento automático.
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.).

Accept

Enumeração

O cabeçalho Aceitar.

Valor	Description
application/json;odata.metadata=none

AutocompleteItem

Objeto

O resultado das solicitações de preenchimento automático.

Nome	Tipo	Description
queryPlusText	string	A consulta junto com o termo concluído.
text	string	O termo concluído.

AutocompleteMode

Enumeração

Especifica o modo de preenchimento automático. O padrão é 'oneTerm'. Use 'twoTerms' para obter shingles e 'oneTermWithContext' para usar o contexto atual na produção de termos de preenchimento automático.

Valor	Description
oneTerm	Apenas um termo é sugerido. Se a consulta tiver dois termos, somente o último termo será concluído. Por exemplo, se a entrada for 'washington medic', os termos sugeridos podem incluir 'medicaid', 'medicare' e 'medicina'.
twoTerms	Frases correspondentes de dois termos no índice serão sugeridas. Por exemplo, se a entrada for 'médico', os termos sugeridos podem incluir 'cobertura do medicare' e 'assistente médico'.
oneTermWithContext	Conclui o último termo em uma consulta com dois ou mais termos, em que os dois últimos termos são uma frase que existe no índice. Por exemplo, se a entrada for 'washington medic', os termos sugeridos podem incluir 'washington medicaid' e 'washington medical'.

AutocompleteResult

Objeto

O resultado da consulta de preenchimento automático.

Nome	Tipo	Description
@search.coverage	number (double)	Um valor que indica o percentual do índice que foi considerado pela solicitação de preenchimento automático ou nulo se minimumCoverage não foi especificado na solicitação.
value	AutocompleteItem[]	A lista de itens compilados automaticamente retornados.

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.