Dokument odnośnika (interfejs API REST Azure Cognitive Search)

Artykuł
05/10/2023

Operacja Wyszukiwania dokumentu pobiera dokument z Azure Cognitive Search. Jest to przydatne, gdy użytkownik kliknie określony wynik wyszukiwania i chcesz wyszukać szczegółowe informacje o tym dokumencie. Jednocześnie można pobrać tylko jeden dokument. Użyj funkcji Wyszukaj dokumenty , aby pobrać wiele dokumentów w jednym żądaniu.

GET https://[service name].search.windows.net/indexes/[index name]/docs/key?[query parameters]  
  Content-Type: application/json   
  api-key: [admin or query key]

Alternatywnie możesz użyć tradycyjnej składni OData dla wyszukiwania klucza:

GET /indexes/[index name]/docs('[key]')?[query parameters]

Parametry identyfikatora URI

Parametr	Opis
nazwa usługi	Wymagane. Ustaw tę wartość na unikatową, zdefiniowaną przez użytkownika nazwę usługi wyszukiwania.
nazwa indeksu	Wymagane. Identyfikator URI żądania określa nazwę indeksu do kwerendy. Parametry zapytania są określane w ciągu zapytania dla żądań GET i w treści żądania POST.
key	Wymagane. Wartość `Edm.String` , która jednoznacznie identyfikuje każdy dokument w indeksie. Klucz jest czasami określany jako identyfikator dokumentu. W wartości klucza jest uwzględniana wielkość liter. Na przykład dokument z kluczem "abc" różni się od dokumentu z kluczem "ABC".
parametry zapytania	Konstrukcja wieloczęściowa, która zawiera `$select` (opcjonalnie) i `api-version=2020-06-30` (wymagane). W przypadku tej operacji wersja interfejsu API jest określana jako parametr zapytania. `$select=[string]` to lista pól rozdzielanych przecinkami do pobrania. W tej klauzuli można uwzględnić tylko pola oznaczone jako możliwe do pobrania. Jeśli nieokreślone lub ustawione na `*`wartość , wszystkie pola oznaczone jako możliwe do pobrania w schemacie są uwzględniane w projekcji.

Nagłówki żądań

W poniższej tabeli opisano wymagane i opcjonalne nagłówki żądań.

Pola Opis

Content-Type Wymagane. Ustaw tę wartość na application/json

api-key Opcjonalnie, jeśli używasz ról platformy Azure , a token elementu nośnego jest dostarczany w żądaniu, w przeciwnym razie wymagany jest klucz. Api-key to unikatowy ciąg generowany przez system, który uwierzytelnia żądanie w usłudze wyszukiwania. Żądania pobierania definicji obiektu muszą zawierać pole api-key ustawione na klucz administratora (w przeciwieństwie do klucza zapytania). Aby uzyskać szczegółowe informacje, zobacz Nawiązywanie połączenia z usługą Cognitive Search przy użyciu uwierzytelniania klucza .

Pola	Opis
Content-Type	Wymagane. Ustaw tę wartość na `application/json`
api-key	Opcjonalnie, jeśli używasz ról platformy Azure , a token elementu nośnego jest dostarczany w żądaniu, w przeciwnym razie wymagany jest klucz. Api-key to unikatowy ciąg generowany przez system, który uwierzytelnia żądanie w usłudze wyszukiwania. Żądania pobierania definicji obiektu muszą zawierać pole api-key ustawione na klucz administratora (w przeciwieństwie do klucza zapytania). Aby uzyskać szczegółowe informacje, zobacz Nawiązywanie połączenia z usługą Cognitive Search przy użyciu uwierzytelniania klucza .

Treść żądania

Brak.

Reakcja

Kod stanu: "200 OK" jest zwracany dla pomyślnej odpowiedzi.

{   
   field_name: field_value (fields matching the default or specified projection)   
}

Przykłady

Wyszukaj dokument o kluczu "2":

GET /indexes/hotels/docs/2?api-version=2020-06-30

Wyszukaj dokument z kluczem "3" przy użyciu składni OData:

GET /indexes/hotels/docs('3')?api-version=2020-06-30