Documents - Autocomplete Get

Serviço:: Search Service

Versão da API:: 2023-10-01-Preview

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=2023-10-01-Preview&search={search}&suggesterName={suggesterName}

Com parâmetros opcionais:

GET {endpoint}/indexes('{indexName}')/docs/search.autocomplete?api-version=2023-10-01-Preview&search={search}&suggesterName={suggesterName}&autocompleteMode={autocompleteMode}&$filter={$filter}&fuzzy={fuzzy}&highlightPostTag={highlightPostTag}&highlightPreTag={highlightPreTag}&minimumCoverage={minimumCoverage}&searchFields={searchFields}&$top={$top}

Parâmetros do URI

Name	Em	Necessário	Tipo	Description
endpoint	path	True	string	A URL do ponto de extremidade do serviço de pesquisa.
indexName	path	True	string	O nome do índice.
api-version	query	True	string	Versão da API do cliente.
search	query	True	string	O prazo incompleto que deve ser preenchido automaticamente.
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 usados para produzir termos concluídos para o resultado de Preenchimento Automático.
$top	query		integer (int32)	O número de termos preenchidos automaticamente a serem recuperados. Este 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 enquanto produz 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 encontrará termos mesmo se houver 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 tag de cadeia de caracteres que é anexada aos destaques de clique. Deve ser definido com highlightPreTag. Se omitido, o realce de cliques será 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 cliques 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 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 a serem considerados ao consultar termos preenchidos automaticamente. Os campos de destino devem ser incluídos no sugeridor especificado.

Cabeçalho do Pedido

Name	Necessário	Tipo	Description
x-ms-client-request-id		string (uuid)	O ID de rastreamento enviado com a solicitação para ajudar com a depuração.

Respostas

Name	Tipo	Description
200 OK	AutocompleteResult	Resposta contendo termos de consulta sugeridos que completam a entrada parcial.
Other Status Codes	SearchError	Resposta de erro.

Exemplos

SearchIndexAutocompleteDocumentsGet

Pedido de amostra

HTTP

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

Resposta da amostra

Código de estado:: 200

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

Definições

Name	Description
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.
SearchError	Descreve uma condição de erro para a API.

AutocompleteItem

Object

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

Name	Tipo	Description
queryPlusText	string	A consulta juntamente com o termo concluído.
text	string	O prazo 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, apenas o último termo será concluído. Por exemplo, se a entrada for "washington medic", os termos sugeridos poderiam incluir "medicaid", "medicare" e "medicine".
twoTerms	Será sugerida a correspondência de frases de dois termos no índice. Por exemplo, se a entrada for "médica", os termos sugeridos podem incluir "cobertura médica" e "assistente médico".
oneTermWithContext	Completa o último termo em uma consulta com dois ou mais termos, onde os dois últimos termos são uma frase que existe no índice. Por exemplo, se a entrada for "washington medic", os termos sugeridos poderiam incluir "washington medicaid" e "washington medical".

AutocompleteResult

Object

O resultado da consulta de preenchimento automático.

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

SearchError

Object

Descreve uma condição de erro para a API.

Name	Tipo	Description
code	string	Um de um conjunto de códigos de erro definido pelo servidor.
details	SearchError[]	Uma matriz de detalhes sobre erros específicos que levaram a esse erro relatado.
message	string	Uma representação legível por humanos do erro.