Documents - Autocomplete Post

Referência

Serviço:: Search Service

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

Preenche automaticamente 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 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.

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.

Corpo do Pedido

Name	Necessário	Tipo	Description
search	True	string	O texto da pesquisa no qual basear os resultados do preenchimento automático.
suggesterName	True	string	O nome do sugestionador, conforme especificado na coleção de sugestionadores que faz parte da definição do índice.
autocompleteMode		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.
filter		string	Uma expressão OData que filtra os documentos usados para produzir termos concluídos para o resultado de 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 preencherá automaticamente os 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		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		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		number	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		string	A lista separada por vírgulas de nomes de campos a serem considerados ao consultar termos preenchidos automaticamente. Os campos de destino devem ser incluídos no sugeridor especificado.
top		integer	O número de termos preenchidos automaticamente a serem recuperados. Este deve ser um valor entre 1 e 100. O padrão é 5.

Respostas

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

Exemplos

SearchIndexAutocompleteDocumentsPost

Pedido de amostra

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 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.
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	O erro de gerenciamento de recursos informações adicionais.
ErrorDetail	O detalhe do erro.
ErrorResponse	Resposta de erro

AutocompleteItem

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

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.

Name	Tipo	Description
oneTerm	string	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".
oneTermWithContext	string	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".
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 podem incluir "cobertura médica" e "assistente médico".

AutocompleteRequest

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

Name	Tipo	Description
autocompleteMode	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.
filter	string	Uma expressão OData que filtra os documentos usados para produzir termos concluídos para o resultado de 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 preencherá automaticamente os 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	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	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	number	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.
search	string	O texto da pesquisa no qual basear os resultados do preenchimento automático.
searchFields	string	A lista separada por vírgulas de nomes de campos a serem considerados ao consultar termos preenchidos automaticamente. Os campos de destino devem ser incluídos no sugeridor especificado.
suggesterName	string	O nome do sugestionador, conforme especificado na coleção de sugestionadores que faz parte da definição do índice.
top	integer	O número de termos preenchidos automaticamente a serem recuperados. Este deve ser um valor entre 1 e 100. O padrão é 5.

AutocompleteResult

O resultado da consulta de preenchimento automático.

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

ErrorAdditionalInfo

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

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

ErrorDetail

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 destino do erro.

ErrorResponse

Resposta de erro

Name	Tipo	Description
error	ErrorDetail	O objeto de erro.

Partilhar via