Documents - Get

Serviço:

Search Service

Versão da API:

2024-07-01

Recupera um documento do índice.

GET {endpoint}/indexes('{indexName}')/docs('{key}')?api-version=2024-07-01

Com parâmetros opcionais:

GET {endpoint}/indexes('{indexName}')/docs('{key}')?$select={$select}&api-version=2024-07-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	ErrorResponse	Resposta de erro.

Exemplos

SearchIndexGetDocument

Solicitação de exemplo

HTTP

GET https://exampleservice.search.windows.net/indexes('getdocumentexample')/docs('1')?$select=docId,title,description&api-version=2024-07-01

Resposta de exemplo

Código de status:

200

{
  "docId": "1",
  "title": "Nice Hotel",
  "description": "Cheapest hotel in town"
}

Definições

Nome	Description
ErrorAdditionalInfo	As informações adicionais do erro de gerenciamento de recursos.
ErrorDetail	O detalhe do erro.
ErrorResponse	Resposta de erro

ErrorAdditionalInfo

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

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

Resposta de erro

Nome	Tipo	Description
error	ErrorDetail	O objeto de erro.