Documents - Suggest Post

Referência

Serviço:: Search Service

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

Sugere documentos no índice que correspondem ao texto de consulta parcial fornecido.

POST {endpoint}/indexes('{indexName}')/docs/search.post.suggest?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 a ser usado para sugerir documentos. Deve ter pelo menos 1 caractere e não mais do que 100 caracteres.
suggesterName	True	string	O nome do sugestor conforme especificado na coleção de sugestores que faz parte da definição de índice.
filter		string	Uma expressão OData que filtra os documentos considerados para sugestões.
fuzzy		boolean	Um valor que indica se a correspondência difusa deve ser usada para a consulta de sugestão. O padrão é false. Quando definida como true, a consulta encontrará sugestões 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 pesquisas de sugestões difusas 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 das sugestões será 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 das sugestões será desabilitado.
minimumCoverage		number	Um número entre 0 e 100 que indica o percentual do índice que deve ser coberto por uma consulta de sugestão 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.
orderby		string	A lista separada por vírgulas do OData $orderby expressões pelas quais classificar os resultados. Cada expressão pode ser um nome de campo ou uma chamada para as funções geo.distance() ou search.score(). Cada expressão pode ser seguida por asc para indicar crescente ou desc para indicar decrescente. O padrão é a ordem crescente. Os empates serão interrompidos pelas pontuações de correspondência de documentos. Se nenhuma $orderby for especificada, a ordem de classificação padrão será decrescente por pontuação de correspondência do documento. Pode haver no máximo 32 cláusulas $orderby.
searchFields		string	A lista separada por vírgulas de nomes de campo para pesquisar o texto de pesquisa especificado. Os campos de destino devem ser incluídos no sugestor especificado.
select		string	A lista separada por vírgulas de campos a serem recuperados. Se não for especificado, somente o campo de chave será incluído nos resultados.
top		integer	O número de sugestões a serem recuperadas. Esse deve ser um valor entre 1 e 100. O padrão é 5.

Respostas

Nome	Tipo	Description
200 OK	SuggestDocumentsResult	Resposta que contém documentos sugeridos que correspondem à entrada parcial.
Other Status Codes	ErrorResponse	Resposta de erro.

Exemplos

SearchIndexSuggestDocumentsPost

Solicitação de exemplo

HTTP

POST https://myservice.search.windows.net/indexes('myindex')/docs/search.post.suggest?api-version=2024-07-01

{
  "filter": "rating gt 4.0",
  "highlightPostTag": "</em>",
  "highlightPreTag": "<em>",
  "minimumCoverage": 80,
  "orderby": "rating desc",
  "search": "hote",
  "searchFields": "title",
  "select": "docId,title,description",
  "suggesterName": "sg",
  "top": 10
}

Resposta de exemplo

Código de status:: 200

{
  "value": [
    {
      "@search.text": "Nice <em>Hotel</em>",
      "description": "Cheapest hotel in town",
      "docId": "1",
      "title": "Nice Hotel"
    },
    {
      "@search.text": "Fancy <em>Hotel</em>",
      "description": "Best hotel in town",
      "docId": "2",
      "title": "Fancy Hotel"
    }
  ]
}

Definições

Nome	Description
ErrorAdditionalInfo	As informações adicionais do erro de gerenciamento de recursos.
ErrorDetail	O detalhe do erro.
ErrorResponse	Resposta de erro
SuggestDocumentsResult	Resposta que contém os resultados da consulta de sugestão de um índice.
SuggestRequest	Parâmetros para filtragem, classificação, correspondência difusa e outros comportamentos de consulta de sugestões.
SuggestResult	Um resultado que contém um documento encontrado por uma consulta de sugestão, além de metadados associados.

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.

SuggestDocumentsResult

Resposta que contém os resultados da consulta de sugestão de um índice.

Nome	Tipo	Description
@search.coverage	number	Um valor que indica o percentual do índice incluído na consulta ou nulo se minimumCoverage não foi definido na solicitação.
value	SuggestResult[]	A sequência de resultados retornados pela consulta.

SuggestRequest

Parâmetros para filtragem, classificação, correspondência difusa e outros comportamentos de consulta de sugestões.

Nome	Tipo	Description
filter	string	Uma expressão OData que filtra os documentos considerados para sugestões.
fuzzy	boolean	Um valor que indica se a correspondência difusa deve ser usada para a consulta de sugestão. O padrão é false. Quando definida como true, a consulta encontrará sugestões 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 pesquisas de sugestões difusas 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 das sugestões será 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 das sugestões será desabilitado.
minimumCoverage	number	Um número entre 0 e 100 que indica o percentual do índice que deve ser coberto por uma consulta de sugestão 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.
orderby	string	A lista separada por vírgulas do OData $orderby expressões pelas quais classificar os resultados. Cada expressão pode ser um nome de campo ou uma chamada para as funções geo.distance() ou search.score(). Cada expressão pode ser seguida por asc para indicar crescente ou desc para indicar decrescente. O padrão é a ordem crescente. Os empates serão interrompidos pelas pontuações de correspondência de documentos. Se nenhuma $orderby for especificada, a ordem de classificação padrão será decrescente por pontuação de correspondência do documento. Pode haver no máximo 32 cláusulas $orderby.
search	string	O texto de pesquisa a ser usado para sugerir documentos. Deve ter pelo menos 1 caractere e não mais do que 100 caracteres.
searchFields	string	A lista separada por vírgulas de nomes de campo para pesquisar o texto de pesquisa especificado. Os campos de destino devem ser incluídos no sugestor especificado.
select	string	A lista separada por vírgulas de campos a serem recuperados. Se não for especificado, somente o campo de chave será incluído nos resultados.
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 sugestões a serem recuperadas. Esse deve ser um valor entre 1 e 100. O padrão é 5.

SuggestResult

Um resultado que contém um documento encontrado por uma consulta de sugestão, além de metadados associados.

Nome	Tipo	Description
@search.text	string	O texto do resultado da sugestão.

Compartilhar via