Documents - Autocomplete Post

Referência

Serviço:: Search Service

Versão da API:: 2023-11-01

O preenchimento automático dos termos de consulta incompletos com base no texto de entrada e nos termos correspondentes no índice.

POST {endpoint}/indexes('{indexName}')/docs/search.post.autocomplete?api-version=2023-11-01

Parâmetros do URI

Name	Em	Necessário	Tipo	Description
endpoint	path	True	string	O URL do ponto final do serviço de pesquisa.
indexName	path	True	string	O nome do índice.
api-version	query	True	string	Versão da API de Cliente.

Cabeçalho do Pedido

Name	Necessário	Tipo	Description
x-ms-client-request-id		string uuid	O ID de controlo enviado com o pedido para ajudar na depuração.

Corpo do Pedido

Name	Necessário	Tipo	Description
search	True	string	O texto de pesquisa no qual se baseiam os resultados da conclusão automática.
suggesterName	True	string	O nome do sugeridor, conforme especificado na coleção de sugestores que faz parte da definição do índice.
autocompleteMode		AutocompleteMode	Especifica o modo de Conclusão Automática. A predefinição é "oneTerm". Utilize "twoTerms" para obter telhas e "oneTermWithContext" para utilizar o contexto atual enquanto produz termos concluídos automaticamente.
filter		string	Uma expressão OData que filtra os documentos utilizados para produzir termos concluídos para o resultado da Conclusão Automática.
fuzzy		boolean	Um valor que indica se deve utilizar correspondência difusa para a consulta de conclusão automática. A predefinição é falso. Quando definida como verdadeira, a consulta irá preencher automaticamente os termos, mesmo que exista um caráter substituído ou em falta no texto de pesquisa. Embora isto proporcione uma melhor experiência em alguns cenários, tem um custo de desempenho, uma vez que as consultas de conclusão automática difusas são mais lentas e consomem mais recursos.
highlightPostTag		string	Uma etiqueta de cadeia que é anexada aos destaques de acesso. Tem de ser definido com highlightPreTag. Se omitido, o realce de acesso está desativado.
highlightPreTag		string	Uma etiqueta de cadeia que está pré-anexada para atingir destaques. Tem de ser definido com highlightPostTag. Se omitido, o realce de acesso está desativado.
minimumCoverage		number	Um número entre 0 e 100 que indica a percentagem do índice que tem de ser abrangida por uma consulta de conclusão automática para que a consulta seja comunicada com êxito. Este parâmetro pode ser útil para garantir a disponibilidade da pesquisa, mesmo para serviços com apenas uma réplica. A predefinição é 80.
searchFields		string	A lista separada por vírgulas de nomes de campos a considerar ao consultar os termos concluídos automaticamente. Os campos de destino têm de ser incluídos no sugeridor especificado.
top		integer	O número de termos de conclusão automática a obter. Tem de ser um valor entre 1 e 100. A predefinição é 5.

Respostas

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

Exemplos

SearchIndexAutocompleteDocumentsPost

Pedido de amostra

HTTP

POST https://myservice.search.windows.net/indexes('myindex')/docs/search.post.autocomplete?api-version=2023-11-01

{
  "autocompleteMode": "oneTerm",
  "search": "washington medic",
  "suggesterName": "sg",
  "filter": "search.in(docId,'101,102,105')",
  "highlightPostTag": "</em>",
  "highlightPreTag": "<em>",
  "minimumCoverage": 80,
  "searchFields": "title,description",
  "top": 10
}

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 dos pedidos de conclusão automática.
AutocompleteMode	Especifica o modo de Conclusão Automática. A predefinição é "oneTerm". Utilize "twoTerms" para obter telhas e "oneTermWithContext" para utilizar o contexto atual na produção de termos de conclusão automática.
AutocompleteRequest	Parâmetros para correspondência difusa e outros comportamentos de consulta de conclusão automática.
AutocompleteResult	O resultado da consulta de conclusão automática.
SearchError	Descreve uma condição de erro para a API.

AutocompleteItem

O resultado dos pedidos de conclusão automática.

Name	Tipo	Description
queryPlusText	string	A consulta juntamente com o termo concluído.
text	string	O termo concluído.

AutocompleteMode

Especifica o modo de Conclusão Automática. A predefinição é "oneTerm". Utilize "twoTerms" para obter telhas e "oneTermWithContext" para utilizar o contexto atual na produção de termos de conclusão automática.

Name	Tipo	Description
oneTerm	string	Só é sugerido um termo. Se a consulta tiver dois termos, apenas o último termo será concluído. Por exemplo, se a entrada for "washington medic", os termos sugeridos podem incluir "medicaid", "medicare" e "medicina".
oneTermWithContext	string	Conclui o último termo numa consulta com dois ou mais termos, em que os dois últimos termos são uma expressão que existe no índice. Por exemplo, se a entrada for "washington medic", os termos sugeridos podem incluir "washington medicaid" e "washington medical".
twoTerms	string	Serão sugeridas expressões de dois termos correspondentes no índice. Por exemplo, se a entrada for "médico", os termos sugeridos podem incluir "cobertura medicare" e "assistente médica".

AutocompleteRequest

Parâmetros para correspondência difusa e outros comportamentos de consulta de conclusão automática.

Name	Tipo	Description
autocompleteMode	AutocompleteMode	Especifica o modo de Conclusão Automática. A predefinição é "oneTerm". Utilize "twoTerms" para obter telhas e "oneTermWithContext" para utilizar o contexto atual enquanto produz termos concluídos automaticamente.
filter	string	Uma expressão OData que filtra os documentos utilizados para produzir termos concluídos para o resultado da Conclusão Automática.
fuzzy	boolean	Um valor que indica se deve utilizar correspondência difusa para a consulta de conclusão automática. A predefinição é falso. Quando definida como verdadeira, a consulta irá preencher automaticamente os termos, mesmo que exista um caráter substituído ou em falta no texto de pesquisa. Embora isto proporcione uma melhor experiência em alguns cenários, tem um custo de desempenho, uma vez que as consultas de conclusão automática difusas são mais lentas e consomem mais recursos.
highlightPostTag	string	Uma etiqueta de cadeia que é anexada aos destaques de acesso. Tem de ser definido com highlightPreTag. Se omitido, o realce de acesso está desativado.
highlightPreTag	string	Uma etiqueta de cadeia que está pré-anexada para atingir destaques. Tem de ser definido com highlightPostTag. Se omitido, o realce de acesso está desativado.
minimumCoverage	number	Um número entre 0 e 100 que indica a percentagem do índice que tem de ser abrangida por uma consulta de conclusão automática para que a consulta seja comunicada com êxito. Este parâmetro pode ser útil para garantir a disponibilidade da pesquisa, mesmo para serviços com apenas uma réplica. A predefinição é 80.
search	string	O texto de pesquisa no qual se baseiam os resultados da conclusão automática.
searchFields	string	A lista separada por vírgulas de nomes de campos a considerar ao consultar os termos concluídos automaticamente. Os campos de destino têm de ser incluídos no sugeridor especificado.
suggesterName	string	O nome do sugeridor, conforme especificado na coleção de sugestores que faz parte da definição do índice.
top	integer	O número de termos de conclusão automática a obter. Tem de ser um valor entre 1 e 100. A predefinição é 5.

AutocompleteResult

O resultado da consulta de conclusão automática.

Name	Tipo	Description
@search.coverage	number	Um valor que indica a percentagem do índice que foi considerado pelo pedido de conclusão automática ou nulo se minimumCoverage não tiver sido especificado no pedido.
value	AutocompleteItem[]	A lista de itens com conclusão automática devolvidos.

SearchError

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

Name	Tipo	Description
code	string	Um dos conjuntos de códigos de erro definidos pelo servidor.
details	SearchError[]	Uma matriz de detalhes sobre erros específicos que levaram a este erro reportado.
message	string	Uma representação legível por humanos do erro.

Partilhar via