Documents - Get

Service:

Search Service

API Version:

2023-11-01

Pobiera dokument z indeksu.

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

With optional parameters:

GET {endpoint}/indexes('{indexName}')/docs('{key}')?$select={$select}&api-version=2023-11-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	SearchError	Odpowiedź na błąd.

Przykłady

SearchIndexGetDocument

Sample Request

HTTP

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

Sample Response

Status code:

200

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

Definicje

SearchError

Opisuje warunek błędu dla interfejsu API.

Nazwa	Typ	Opis
code	string	Jeden z zdefiniowanych przez serwer zestaw kodów błędów.
details	SearchError[]	Tablica szczegółów dotyczących określonych błędów, które doprowadziły do tego zgłoszonego błędu.
message	string	Czytelna dla człowieka reprezentacja błędu.