Documents - Suggest Post

Referência

Service:: Search Service

API Version:: 2023-11-01

Sugere documentos no índice que correspondam ao texto de consulta parcial especificado.

POST {endpoint}/indexes('{indexName}')/docs/search.post.suggest?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 do 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 a utilizar para sugerir documentos. Tem de ter, pelo menos, 1 caráter e não ter mais de 100 carateres.
suggesterName	True	string	O nome do sugeridor, conforme especificado na coleção de sugestores 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 deve utilizar correspondência difusa para a consulta de sugestão. A predefinição é falso. Quando definida como verdadeira, a consulta encontrará sugestões 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 pesquisas de sugestões difusas são mais lentas e consomem mais recursos.
highlightPostTag		string	Uma etiqueta de cadeia de carateres que é anexada para obter destaques. Tem de ser definido com highlightPreTag. Se for omitido, prima o realce das sugestões desativado.
highlightPreTag		string	Uma etiqueta de cadeia de carateres que está pré-anexada para obter destaques. Tem de ser definido com highlightPostTag. Se for omitido, prima o realce das sugestões desativado.
minimumCoverage		number	Um número entre 0 e 100 que indica a percentagem do índice que tem de ser abrangido por uma consulta de sugestão 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.
orderby		string	A lista separada por vírgulas de OData $orderby expressões pelas quais ordenar 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. A predefinição é ordem ascendente. Os empates serão quebrados pelas pontuações de correspondência de documentos. Se não for especificada nenhuma $orderby, a sequência de ordenação predefinida é descendente por classificação de correspondência do documento. Pode haver, no máximo, 32 cláusulas de $orderby.
searchFields		string	A lista separada por vírgulas de nomes de campos para procurar o texto de pesquisa especificado. Os campos de destino têm de ser incluídos no sugeridor especificado.
select		string	A lista de campos separados por vírgulas a obter. Se não for especificado, apenas o campo de chave será incluído nos resultados.
top		integer	O número de sugestões a obter. Tem de ser um valor entre 1 e 100. A predefinição é 5.

Respostas

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

Exemplos

SearchIndexSuggestDocumentsPost

Sample Request

HTTP

POST https://myservice.search.windows.net/indexes('myindex')/docs/search.post.suggest?api-version=2023-11-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
}

Sample Response

Status code:: 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
SearchError	Descreve uma condição de erro para a API.
SuggestDocumentsResult	Resposta que contém resultados de consulta de sugestões de um índice.
SuggestRequest	Parâmetros para filtragem, ordenaçã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.

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 série de detalhes sobre erros específicos que levaram a este erro comunicado.
message	string	Uma representação legível por humanos do erro.

SuggestDocumentsResult

Resposta que contém resultados de consulta de sugestões de um índice.

Name	Tipo	Description
@search.coverage	number	Um valor que indica a percentagem do índice incluído na consulta ou nulo se minimumCoverage não tiver sido definido no pedido.
value	SuggestResult[]	A sequência de resultados devolvida pela consulta.

SuggestRequest

Parâmetros para filtragem, ordenaçã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 deve utilizar correspondência difusa para a consulta de sugestão. A predefinição é falso. Quando definida como verdadeira, a consulta encontrará sugestões 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 pesquisas de sugestões difusas são mais lentas e consomem mais recursos.
highlightPostTag	string	Uma etiqueta de cadeia de carateres que é anexada para obter destaques. Tem de ser definido com highlightPreTag. Se for omitido, prima o realce das sugestões desativado.
highlightPreTag	string	Uma etiqueta de cadeia de carateres que está pré-anexada para obter destaques. Tem de ser definido com highlightPostTag. Se for omitido, prima o realce das sugestões desativado.
minimumCoverage	number	Um número entre 0 e 100 que indica a percentagem do índice que tem de ser abrangido por uma consulta de sugestão 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.
orderby	string	A lista separada por vírgulas de OData $orderby expressões pelas quais ordenar 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. A predefinição é ordem ascendente. Os empates serão quebrados pelas pontuações de correspondência de documentos. Se não for especificada nenhuma $orderby, a sequência de ordenação predefinida é descendente por classificação de correspondência do documento. Pode haver, no máximo, 32 cláusulas de $orderby.
search	string	O texto de pesquisa a utilizar para sugerir documentos. Tem de ter, pelo menos, 1 caráter e não ter mais de 100 carateres.
searchFields	string	A lista separada por vírgulas de nomes de campos para procurar o texto de pesquisa especificado. Os campos de destino têm de ser incluídos no sugeridor especificado.
select	string	A lista de campos separados por vírgulas a obter. Se não for especificado, apenas o campo de chave será incluído nos resultados.
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 sugestões a obter. Tem de ser um valor entre 1 e 100. A predefiniçã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 do resultado da sugestão.

Share via