Documents - Suggest Get

  • Referência
Service:
Search Service
API Version:
2023-11-01

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

GET {endpoint}/indexes('{indexName}')/docs/search.suggest?search={search}&suggesterName={suggesterName}&api-version=2023-11-01
With optional parameters: 
GET {endpoint}/indexes('{indexName}')/docs/search.suggest?search={search}&suggesterName={suggesterName}&$filter={$filter}&fuzzy={fuzzy}&highlightPostTag={highlightPostTag}&highlightPreTag={highlightPreTag}&minimumCoverage={minimumCoverage}&$orderby={$orderby}&searchFields={searchFields}&$select={$select}&$top={$top}&api-version=2023-11-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.
search
 query True

string

O texto de pesquisa a ser usado para sugerir documentos. Deve ter pelo menos 1 e não mais que 100 caracteres.
suggesterName
 query True

string

O nome do sugestor conforme especificado na coleção de sugestores que faz parte da definição de índice.
$filter
 query

string

Uma expressão OData que filtra os documentos considerados para sugestões.
$orderby
 query

string[]

A lista de expressões $orderby OData 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 resolvidos 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.
$select
 query

string[]

A lista de campos a serem recuperados. Se não for especificado, somente o campo de chave será incluído nos resultados.
$top
 query

integer

int32

O número de sugestões a serem recuperadas. O valor deve ser um número entre 1 e 100. O padrão é 5.
fuzzy
 query

boolean

Um valor que indica se a correspondência difusa deve ser usada para a consulta de sugestões. O padrão é false. Quando definida como true, a consulta encontrará 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 sugestões difusas são mais lentas e consomem mais recursos.
highlightPostTag
 query

string

Uma marca de cadeia de caracteres que é acrescentada para atingir realces. Deve ser definido com highlightPreTag. Se omitido, o realce de ocorrência de sugestões será desabilitado.
highlightPreTag
 query

string

Uma marca de cadeia de caracteres que é prefixada para atingir realces. Deve ser definido com highlightPostTag. Se omitido, o realce de ocorrência de sugestões será desabilitado.
minimumCoverage
 query

number

double

Um número entre 0 e 100 indicando o percentual do índice que deve ser coberto por uma consulta de sugestões 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 um réplica. O padrão é 80.
searchFields
 query

string[]

A lista de nomes de campo para pesquisar o texto de pesquisa especificado. Os campos de destino devem ser incluídos no sugestor especificado.

Cabeçalho da solicitação

Nome Obrigatório Tipo Description
x-ms-client-request-id

string

uuid

A ID de rastreamento enviada com a solicitação para ajudar na depuração.

Respostas

Nome Tipo Description
200 OK

SuggestDocumentsResult

Resposta que contém documentos sugeridos que correspondem à entrada parcial.
Other Status Codes

SearchError

Resposta de erro.

Exemplos

SearchIndexSuggestDocumentsGet

Sample Request

GET https://myservice.search.windows.net/indexes('myindex')/docs/search.suggest?search=hote&suggesterName=sg&$filter=rating gt 10&fuzzy=False&highlightPostTag=</em>&highlightPreTag=<em>&minimumCoverage=80&$orderby=search.score() desc,rating desc&searchFields=title&$select=docId,title,description&$top=10&api-version=2023-11-01

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

Nome Description
SearchError

Descreve uma condição de erro para a API.
SuggestDocumentsResult

Resposta que contém os resultados da consulta de sugestão de um índice.
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.

Nome Tipo Description
code

string

Um de um conjunto definido pelo servidor de códigos de erro.
details

SearchError[]

Uma matriz de detalhes sobre erros específicos que levaram a esse erro relatado.
message

string

Uma representação legível pelo homem do 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 que foi 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.

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.