Documents - Get

Usługa:: Search Service

Wersja interfejsu API:: 2025-05-01-preview

Pobiera dokument z indeksu.

GET {endpoint}/indexes('{indexName}')/docs('{key}')?api-version=2025-05-01-preview

Z parametrami opcjonalnymi:

GET {endpoint}/indexes('{indexName}')/docs('{key}')?$select={$select}&api-version=2025-05-01-preview

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
endpoint	path	True	string	Adres URL punktu końcowego usługi wyszukiwania.
indexName	path	True	string	Nazwa indeksu.
key	path	True	string	Klucz dokumentu do pobrania.
api-version	query	True	string	Wersja interfejsu API klienta.
$select	query		string[]	Lista nazw pól do pobrania dla dokumentu; W zwróconym dokumencie brakuje żadnego pola, które nie zostanie pobrane.

Nagłówek żądania

Nazwa	Wymagane	Typ	Opis
x-ms-client-request-id		string (uuid)	Identyfikator śledzenia wysłany z żądaniem, aby ułatwić debugowanie.
x-ms-query-source-authorization		string	Token identyfikujący użytkownika, dla którego jest wykonywane zapytanie. Ten token służy do wymuszania ograniczeń zabezpieczeń dokumentów.

Odpowiedzi

Nazwa	Typ	Opis
200 OK	LookupDocument	Odpowiedź zawierająca żądany dokument.
Other Status Codes	ErrorResponse	Odpowiedź na błąd.

Przykłady

SearchIndexGetDocument

Przykładowe żądanie

HTTP

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

Przykładowa odpowiedź

Kod stanu:: 200

{
  "id": "1",
  "name": "test",
  "description": "test1 hello",
  "category": "purple",
  "ownerId": "sam"
}

Definicje

Nazwa	Opis
ErrorAdditionalInfo	Dodatkowe informacje o błędzie zarządzania zasobami.
ErrorDetail	Szczegóły błędu.
ErrorResponse	Odpowiedź na błąd

ErrorAdditionalInfo

Objekt

Dodatkowe informacje o błędzie zarządzania zasobami.

Nazwa	Typ	Opis
info	object	Dodatkowe informacje.
type	string	Dodatkowy typ informacji.

ErrorDetail

Objekt

Szczegóły błędu.

Nazwa	Typ	Opis
additionalInfo	ErrorAdditionalInfo[]	Dodatkowe informacje o błędzie.
code	string	Kod błędu.
details	ErrorDetail[]	Szczegóły błędu.
message	string	Komunikat o błędzie.
target	string	Element docelowy błędu.

ErrorResponse

Objekt

Odpowiedź na błąd

Nazwa	Typ	Opis
error	ErrorDetail	Obiekt błędu.