Documents - Get

Usługa:

Search Service

Wersja interfejsu API:

2024-07-01

Pobiera dokument z indeksu.

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

Z parametrami opcjonalnymi:

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

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://exampleservice.search.windows.net/indexes('getdocumentexample')/docs('1')?$select=docId,title,description&api-version=2024-07-01

Przykładowa odpowiedź

Kod stanu:

200

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

Definicje

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

ErrorAdditionalInfo

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

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

ErrorDetail

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

Odpowiedź na błąd

Nazwa	Typ	Opis
error	ErrorDetail	Obiekt błędu.