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 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 de pesquisa a ser usado para sugerir documentos. Deve ter pelo menos 1 caractere e não mais de 100 caracteres.
suggesterName	True	string	O nome do sugestionador, conforme especificado na coleção de sugestionadores que faz parte da definição do í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 que haja um caractere substituído ou ausente no texto da pesquisa. Embora isso proporcione uma experiência melhor em alguns cenários, tem um custo de desempenho, já que as pesquisas de sugestões difusas, 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 sugestões é desativado.
highlightPreTag		string	Uma tag de cadeia de caracteres que é preparada para atingir destaques. Deve ser definido com highlightPostTag. Se omitido, o realce de sugestões é desativado.
minimumCoverage		number	Um número entre 0 e 100 indicando a porcentagem do índice que deve ser coberta 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 da pesquisa, mesmo para serviços com apenas uma réplica. O padrão é 80.
orderby		string	A lista separada por vírgulas de 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 ascendente, ou desc para indicar descendente. O padrão é ordem crescente. Os empates serão quebrados pelas pontuações dos documentos. Se nenhum $orderby for especificado, a ordem de classificação padrão será decrescente por pontuação de correspondência de documento. Pode haver no máximo 32 $orderby cláusulas.
searchFields		string	A lista separada por vírgulas de nomes de campos para procurar o texto de pesquisa especificado. Os campos de destino devem ser incluídos no sugeridor especificado.
select		string	A lista separada por vírgulas de campos a serem recuperados. Se não for especificado, apenas o campo-chave será incluído nos resultados.
top		integer	O número de sugestões a recuperar. Este deve ser um valor entre 1 e 100. O padrão é 5.

Respostas

Name	Tipo	Description
200 OK	SuggestDocumentsResult	Resposta contendo documentos sugeridos que correspondem à entrada parcial.
Other Status Codes	ErrorResponse	Resposta de erro.

Exemplos

SearchIndexSuggestDocumentsPost

Pedido de amostra

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 da amostra

Código de estado:: 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

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

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.

SuggestDocumentsResult

Resposta contendo resultados de consulta de sugestão de um índice.

Name	Tipo	Description
@search.coverage	number	Um valor que indica a porcentagem do índice que foi incluído na consulta, ou null se minimumCoverage não foi definido na solicitação.
value	SuggestResult[]	A sequência de resultados retornada pela consulta.

SuggestRequest

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

Name	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 que haja um caractere substituído ou ausente no texto da pesquisa. Embora isso proporcione uma experiência melhor em alguns cenários, tem um custo de desempenho, já que as pesquisas de sugestões difusas, 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 sugestões é desativado.
highlightPreTag	string	Uma tag de cadeia de caracteres que é preparada para atingir destaques. Deve ser definido com highlightPostTag. Se omitido, o realce de sugestões é desativado.
minimumCoverage	number	Um número entre 0 e 100 indicando a porcentagem do índice que deve ser coberta 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 da pesquisa, mesmo para serviços com apenas uma réplica. O padrão é 80.
orderby	string	A lista separada por vírgulas de 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 ascendente, ou desc para indicar descendente. O padrão é ordem crescente. Os empates serão quebrados pelas pontuações dos documentos. Se nenhum $orderby for especificado, a ordem de classificação padrão será decrescente por pontuação de correspondência de documento. Pode haver no máximo 32 $orderby cláusulas.
search	string	O texto de pesquisa a ser usado para sugerir documentos. Deve ter pelo menos 1 caractere e não mais de 100 caracteres.
searchFields	string	A lista separada por vírgulas de nomes de campos para procurar o texto de pesquisa especificado. Os campos de destino devem ser incluídos no sugeridor especificado.
select	string	A lista separada por vírgulas de campos a serem recuperados. Se não for especificado, apenas o campo-chave será incluído nos resultados.
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 sugestões a recuperar. Este 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.

Name	Tipo	Description
@search.text	string	O texto da sugestão resulta.

Partilhar via