Udostępnij przez

Documents - Get

Usługa:
Search Service
Wersja interfejsu API:
2025-09-01

Pobiera dokument z indeksu.

GET {endpoint}/indexes('{indexName}')/docs('{key}')?api-version=2025-09-01
Z parametrami opcjonalnymi: 
GET {endpoint}/indexes('{indexName}')/docs('{key}')?$select={$select}&api-version=2025-09-01

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 nie będzie żadnych pól, które nie zostaną pobrane.

Nagłówek żądania

Nazwa Wymagane Typ Opis
x-ms-client-request-id

string (uuid)

Identyfikator śledzenia wysłany z żądaniem, aby pomóc w debugowaniu.

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

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

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.