Compartilhar via

Documents - Autocomplete Post

Serviço:
Search Service
Versão da API:
2025-09-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=2025-09-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)

O ID de rastreamento enviado 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 no qual basear os resultados do preenchimento automático.
suggesterName True

string

O nome do sugestor, conforme especificado na coleção de sugestores 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 ao produzir termos preenchidos automaticamente.
filter

string

Uma expressão OData que filtra os documentos usados para produzir termos concluídos para o resultado do 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 que haja 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 string anexada aos destaques da ocorrência. Deve ser definido com highlightPreTag. Se omitido, o realce de ocorrências será desativado.
highlightPreTag

string

Uma tag de string que é anexada para atingir os destaques. Deve ser definido com highlightPostTag. Se omitido, o realce de ocorrências será desativado.
minimumCoverage

number (double)

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 bem-sucedida. 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 campo a serem considerados ao consultar termos preenchidos automaticamente. Os campos de destino devem ser incluídos no sugestor especificado.
top

integer (int32)

O número de termos preenchidos automaticamente a serem recuperados. Deve ser um valor entre 1 e 100. O padrão é 5.

Respostas

Nome 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

Solicitação de exemplo

POST https://stableexampleservice.search.windows.net/indexes('stable-test')/docs/search.post.autocomplete?api-version=2025-09-01


{
  "search": "p",
  "autocompleteMode": "oneTerm",
  "filter": "ownerId ne '1'",
  "fuzzy": true,
  "highlightPostTag": "</em>",
  "highlightPreTag": "<em>",
  "minimumCoverage": 80,
  "searchFields": "category, ownerId",
  "suggesterName": "sg",
  "top": 10
}

Resposta de exemplo

Código de status:
200 
{
  "@search.coverage": 100,
  "value": [
    {
      "text": "purple",
      "queryPlusText": "<em>purple</em>"
    },
    {
      "text": "pink",
      "queryPlusText": "<em>pink</em>"
    }
  ]
}

Definições

Nome 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

As informações adicionais do erro de gerenciamento de recursos.
ErrorDetail

O detalhe do erro.
ErrorResponse

Resposta de erro

AutocompleteItem

Objeto

O resultado das solicitações de preenchimento automático.

Nome Tipo Description
queryPlusText

string

A consulta junto com o termo concluído.
text

string

O prazo concluído.

AutocompleteMode

Enumeração

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.

Valor Description
oneTerm

Apenas um termo é sugerido. Se a consulta tiver dois termos, somente o último termo será concluído. Por exemplo, se a entrada for 'washington medic', os termos sugeridos podem incluir 'medicaid', 'medicare' e 'medicina'.
twoTerms

Frases correspondentes de dois termos no índice serão sugeridas. Por exemplo, se a entrada for 'médico', os termos sugeridos podem incluir 'cobertura do medicare' e 'assistente médico'.
oneTermWithContext

Conclui o último termo em uma consulta com dois ou mais termos, em que os dois últimos termos são uma frase que existe no índice. Por exemplo, se a entrada for 'washington medic', os termos sugeridos podem incluir 'washington medicaid' e 'washington medical'.

AutocompleteRequest

Objeto

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

Nome 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 ao produzir termos preenchidos automaticamente.
filter

string

Uma expressão OData que filtra os documentos usados para produzir termos concluídos para o resultado do 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 que haja 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 string anexada aos destaques da ocorrência. Deve ser definido com highlightPreTag. Se omitido, o realce de ocorrências será desativado.
highlightPreTag

string

Uma tag de string que é anexada para atingir os destaques. Deve ser definido com highlightPostTag. Se omitido, o realce de ocorrências será desativado.
minimumCoverage

number (double)

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 bem-sucedida. 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 de pesquisa no qual basear os resultados do preenchimento automático.
searchFields

string

A lista separada por vírgulas de nomes de campo a serem considerados ao consultar termos preenchidos automaticamente. Os campos de destino devem ser incluídos no sugestor especificado.
suggesterName

string

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

integer (int32)

O número de termos preenchidos automaticamente a serem recuperados. Deve ser um valor entre 1 e 100. O padrão é 5.

AutocompleteResult

Objeto

O resultado da consulta de preenchimento automático.

Nome Tipo Description
@search.coverage

number (double)

Um valor que indica a porcentagem do índice que foi considerada pela solicitação de preenchimento automático ou nulo se minimumCoverage não tiver sido especificado na solicitação.
value

AutocompleteItem[]

A lista de itens preenchidos automaticamente.

ErrorAdditionalInfo

Objeto

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

Objeto

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

Objeto

Resposta de erro

Nome Tipo Description
error

ErrorDetail

O objeto de erro.