Documents - Get

  • Referência
Serviço:
Search Service
Versão da API:
2023-11-01

Obtém 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 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.
key
 path True

string

A chave do documento a obter.
api-version
 query True

string

Versão da API de Cliente.
$select
 query

string[]

Lista de nomes de campos a obter para o documento; Qualquer campo não obtido estará em falta no documento devolvido.

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.

Respostas

Name Tipo Description
200 OK

LookupDocument

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

SearchError

Resposta de erro.

Exemplos

SearchIndexGetDocument

Pedido de amostra

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

Resposta da amostra

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

Definições

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 matriz de detalhes sobre erros específicos que levaram a este erro reportado.
message

string

Uma representação legível por humanos do erro.