Documents - Autocomplete Post

Referência

Serviço:: Search Service

Versão da API:: 2024-07-01

Preenchimento automático de 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=2024-07-01

Parâmetros de URI

Nome	Em	Obrigató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.

Cabeçalho da solicitação

Nome	Obrigatório	Tipo	Description
x-ms-client-request-id		string uuid	A ID de acompanhamento enviada com a solicitação para ajudar na depuração.

Corpo da solicitação

Nome	Obrigatório	Tipo	Description
search	True	string	O texto de pesquisa no qual basear os resultados do preenchimento automático.
suggesterName	True	string	O nome do sugestor conforme especificado na coleção de sugestores que faz parte da definição de índice.
autocompleteMode		AutocompleteMode	Especifica o modo de preenchimento automático. O padrão é 'oneTerm'. Use 'twoTerms' para obter telhas e 'oneTermWithContext' para usar o contexto atual enquanto produz termos concluídos automaticamente.
filter		string	Uma expressão OData que filtra os documentos usados para produzir termos concluídos para o resultado do preenchimento automático.
fuzzy		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 compilará automaticamente os termos mesmo se houver um caractere substituído ou ausente no texto de 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		string	Uma marca de cadeia de caracteres que é acrescentada a realces de clique. Deve ser definido com highlightPreTag. Se omitido, o realce de clique está desabilitado.
highlightPreTag		string	Uma marca de cadeia de caracteres que é acrescentada a realces de clique. Deve ser definido com highlightPostTag. Se omitido, o realce de clique está desabilitado.
minimumCoverage		number	Um número entre 0 e 100 que indica o percentual do índice que deve ser coberto 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 de pesquisa mesmo para serviços com apenas uma réplica. O padrão é 80.
searchFields		string	A lista separada por vírgulas de nomes de campo a serem considerados ao consultar termos concluídos automaticamente. Os campos de destino devem ser incluídos no sugestor especificado.
top		integer	O número de termos concluídos automaticamente a serem recuperados. Esse deve ser um valor entre 1 e 100. O padrão é 5.

Respostas

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

Exemplos

SearchIndexAutocompleteDocumentsPost

Solicitação de exemplo

HTTP

POST https://myservice.search.windows.net/indexes('myindex')/docs/search.post.autocomplete?api-version=2024-07-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 de exemplo

Código de status:: 200

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

Definições

Nome	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 telhas e 'oneTermWithContext' para usar o contexto atual na produção de termos de preenchimento automático.
AutocompleteRequest	Parâmetros para correspondência difusa e outros comportamentos de consulta 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 de erro

AutocompleteItem

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

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

Nome	Tipo	Description
oneTerm	string	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".
oneTermWithContext	string	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".
twoTerms	string	Será sugerida a correspondência de frases de dois termos no índice. Por exemplo, se a entrada for "médica", os termos sugeridos poderão incluir "cobertura do Medicare" e "assistente médico".

AutocompleteRequest

Parâmetros para correspondência difusa e outros comportamentos de consulta de preenchimento automático.

Nome	Tipo	Description
autocompleteMode	AutocompleteMode	Especifica o modo de preenchimento automático. O padrão é 'oneTerm'. Use 'twoTerms' para obter telhas e 'oneTermWithContext' para usar o contexto atual enquanto produz termos concluídos automaticamente.
filter	string	Uma expressão OData que filtra os documentos usados para produzir termos concluídos para o resultado do preenchimento automático.
fuzzy	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 compilará automaticamente os termos mesmo se houver um caractere substituído ou ausente no texto de 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	string	Uma marca de cadeia de caracteres que é acrescentada a realces de clique. Deve ser definido com highlightPreTag. Se omitido, o realce de clique está desabilitado.
highlightPreTag	string	Uma marca de cadeia de caracteres que é acrescentada a realces de clique. Deve ser definido com highlightPostTag. Se omitido, o realce de clique está desabilitado.
minimumCoverage	number	Um número entre 0 e 100 que indica o percentual do índice que deve ser coberto 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 de pesquisa mesmo para serviços com apenas uma réplica. O padrão é 80.
search	string	O texto de pesquisa no qual basear os resultados do preenchimento automático.
searchFields	string	A lista separada por vírgulas de nomes de campo a serem considerados ao consultar termos concluídos automaticamente. Os campos de destino devem ser incluídos no sugestor especificado.
suggesterName	string	O nome do sugestor conforme especificado na coleção de sugestores que faz parte da definição de índice.
top	integer	O número de termos concluídos automaticamente a serem recuperados. Esse deve ser um valor entre 1 e 100. O padrão é 5.

AutocompleteResult

O resultado da consulta de preenchimento automático.

Nome	Tipo	Description
@search.coverage	number	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

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

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

ErrorDetail

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

Resposta de erro

Nome	Tipo	Description
error	ErrorDetail	O objeto de erro.

Compartilhar via