Typowe nagłówki żądań HTTP i odpowiedzi (Azure AI Search)
Artykuł
Interfejsy API REST usługi Azure AI Search obsługują zestaw typowych nagłówków żądań/odpowiedzi HTTP, podsumowanych tutaj, aby uzyskać informacje:
Nagłówek żądania
Typ
Opis
Zaakceptuj
Typ zawartości
Żądany typ zawartości odpowiedzi. Wartość domyślna to application/json; odata.metadata=minimum. Inne dozwolone wartości to application/json, application/json; odata.metadata=full, application/json; odata.metadata=none i text/plain (tylko dla $count).
Token dostępu OAuth 2.0 dla żądania. Wymaga skonfigurowania usługi wyszukiwania pod kątem dostępu opartego na rolach. Ten nagłówek żądania jest przeznaczony dla aplikacji klienckich korzystających z uwierzytelniania Tożsamość Microsoft Entra i przypisań ról. Kod klienta musi podać token. Możesz użyć tego nagłówka żądania z dowolną obsługiwaną wersją interfejsu API REST, o ile usługa wyszukiwania jest skonfigurowana do uwierzytelniania płaszczyzny danych.
Content-Type
Content-Type
Typ zawartości treści żądania (PUT/POST). Wartość domyślna to application/json.
client-request-id
GUID
Opcjonalny identyfikator żądania określonego przez obiekt wywołujący w postaci identyfikatora GUID bez dekoracji, takich jak nawiasy klamrowe (na przykład client-request-id: 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0). Wartość zdefiniowana przez obiekt wywołujący, która identyfikuje dane żądanie. Jeśli ta wartość jest określona, ta wartość jest uwzględniana w informacjach odpowiedzi jako sposób mapowania żądania.
OData-MaxVersion
"4.0"
Określa maksymalną wersję protokołu OData obsługiwanego przez klienta. Wartość domyślna to "4.0"
Wolą
"return=representation" lub "return=minimal"
Służy do kontrolowania ładunku odpowiedzi z żądań PUT i POST /indexes. Wartość domyślna to "return=representation" podczas tworzenia nowego indeksu za pośrednictwem metody POST lub PUT i "return=minimal" w celu zaktualizowania istniejącego indeksu za pośrednictwem funkcji PUT.
return-client-request-id
Prawda czy fałsz
Jeśli określono parametr client-request-id, nakazuje serwerowi uwzględnienie nagłówka client-request-id w odpowiedzi. Wartość domyślna to False.
If-Match
ETag lub *
Służy do zmiany zasobu tylko wtedy, gdy bieżąca wersja jest zgodna z określonym elementem ETag. Użyj tego nagłówka z metodami POST, PUT lub DELETE dla zasobów (takich jak indeksatory, indeksy i źródła danych, ale nie dokumenty), aby umożliwić optymistyczną kontrolę współbieżności.
Dopasowanie if-none
ETag lub *
Służy do zmiany zasobu tylko wtedy, gdy bieżąca wersja nie jest zgodna z określonym elementem ETag. Użyj tego nagłówka z metodami POST, PUT lub DELETE dla zasobów (takich jak indeksatory, indeksy i źródła danych, ale nie dokumenty), aby umożliwić optymistyczną kontrolę współbieżności.
Nagłówek odpowiedzi
Typ
Opis
client-request-id
GUID
Identyfikator określony przez obiekt wywołujący w oryginalnym żądaniu, jeśli istnieje.
Content-Type
Content-Type
Typ zawartości treści odpowiedzi.
Lokalizacja
Adres URL
Adres URL nowo utworzonej definicji indeksu dla żądań POST i PUT /indexes.
OData-Version
"4.0"
Wersja protokołu OData odpowiedzi.
identyfikator żądania
GUID
Unikatowy identyfikator bieżącej operacji. Równa się identyfikatorowi żądania klienta, jeśli jest określona; w przeciwnym razie wartość jest generowana na serwerze.
czas, który upłynął
Liczba
Czas (w milisekundach), który usługa spędziła na przetwarzaniu żądania. Ta wartość obejmuje tylko czas spędzony na przetwarzaniu żądania i nie obejmuje czasu transferu sieciowego.
Etag
Ciąg
Nieprzezroczysty ciąg reprezentujący bieżącą wersję zasobu (zwracany dla indeksatorów, indeksów i źródeł danych, ale nie dokumentów). Użyj tego ciągu w nagłówku If-Match lub If-None-Match dla optymistycznej kontrolki współbieżności.