Partilhar via

Documents - Get

Serviço:
Search Service
Versão da API:
2025-09-01

Recupera um documento do índice.

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

string

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

string

Versão da API do cliente.
$select
 query

string[]

Lista de nomes de campos a recuperar para o documento; Qualquer campo não recuperado estará ausente do documento devolvido.

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.

Respostas

Name Tipo Description
200 OK

LookupDocument

Resposta contendo o documento solicitado.
Other Status Codes

ErrorResponse

Resposta de erro.

Exemplos

SearchIndexGetDocument

Pedido de amostra

GET https://stableexampleservice.search.windows.net/indexes('stable-test')/docs('1')?$select=id,description,name,category,ownerId&api-version=2025-09-01

Resposta da amostra

Código de estado:
200 
{
  "id": "1",
  "name": "test",
  "description": "test1 hello",
  "category": "purple",
  "ownerId": "sam"
}

Definições

Name Description
ErrorAdditionalInfo

O erro de gerenciamento de recursos informações adicionais.
ErrorDetail

O detalhe do erro.
ErrorResponse

Resposta de erro

ErrorAdditionalInfo

Object

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

Object

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

Object

Resposta de erro

Name Tipo Description
error

ErrorDetail

O objeto de erro.