Documents - Get

Serviço:
Search Service
Versão da API:
2023-11-01

Recupera um documento do índice.

GET {endpoint}/indexes('{indexName}')/docs('{key}')?api-version=2023-11-01
Com parâmetros opcionais: 
GET {endpoint}/indexes('{indexName}')/docs('{key}')?$select={$select}&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.
key
 path True

string

A chave do documento a ser recuperado.
api-version
 query True

string

Versão da API do cliente.
$select
 query

string[]

Lista de nomes de campo a serem recuperados para o documento; Qualquer campo não recuperado estará ausente do documento retornado.

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.

Respostas

Nome Tipo Description
200 OK

LookupDocument

Resposta que contém o documento solicitado.
Other Status Codes

SearchError

Resposta de erro.

Exemplos

SearchIndexGetDocument

Solicitação de exemplo

GET https://myservice.search.windows.net/indexes('myindex')/docs('1')?$select=docId,title,description&api-version=2023-11-01

Resposta de exemplo

Código de status:
200 
{
  "description": "Cheapest hotel in town",
  "docId": "1",
  "title": "Nice Hotel"
}

Definições

SearchError

Objeto

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 ser humano do erro.