Yaygın HTTP isteği ve yanıt üst bilgileri (Azure AI Search)

Azure AI Search REST API'leri, başvuru için burada özetlenen bir dizi ortak HTTP isteği/yanıt üst bilgisini destekler:

İstek Başlığı Tür Description
Kabul Et İçerik türü Yanıt için istenen içerik türü. Varsayılan: application/json; odata.metadata=minimal. İzin verilebilen diğer değerler: application/json, application/json; odata.metadata=full, application/json; odata.metadata=none ve text/plain (yalnızca $count için).
api-key Dize API'ye bağlı olarak sorgunuza veya yönetici anahtarınıza ayarlayın.
yetkilendirme Dize İstek için OAuth 2.0 erişim belirteci. Rol tabanlı erişim için arama hizmetinize yapılandırma gerektirir. Bu istek üst bilgisi, Microsoft Entra ID kimlik doğrulaması ve rol atamaları kullanan istemci uygulamalarına yöneliktir. İstemci kodunuz belirteci sağlamalıdır. Arama hizmeti veri düzlemi kimlik doğrulaması için yapılandırıldığı sürece bu istek üst bilgisini desteklenen herhangi bir REST API sürümüyle kullanabilirsiniz.
İçerik Türü İçerik Türü İstek gövdesinin içerik türü (PUT/POST). application/json varsayılan değerdir.
client-request-id GUID Küme ayraçları gibi süslemesi olmayan guid biçiminde isteğe bağlı arayan tarafından belirtilen istek kimliği (örneğin, client-request-id: 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0). Verilen isteği tanımlayan çağıran tanımlı değer. Belirtilirse, bu değer isteği eşlemenin bir yolu olarak yanıt bilgilerine eklenir.
OData-MaxVersion "4.0" İstemci tarafından desteklenen en yüksek OData protokol sürümünü belirtir. Varsayılan değer "4.0"
Tercih "return=representation" veya "return=minimal" PUT ve POST /indexes isteklerinden yanıt yükünü denetlemek için kullanılır. POST veya PUT aracılığıyla yeni bir dizin oluştururken varsayılan değer "return=representation" ve PUT aracılığıyla var olan bir dizini güncelleştirmek için "return=minimal"dir.
return-client-request-id Doğru veya Yanlış client-request-id belirtildiğinde belirtilirse, sunucuya yanıta client-request-id üst bilgisini eklemesini sağlar. Varsayılan değer False'tur.
If-Match ETag veya * Bir kaynağı yalnızca geçerli sürüm belirtilen ETag ile eşleşiyorsa değiştirmek için kullanılır. İyimser eşzamanlılık denetimini etkinleştirmek için bu üst bilgiyi kaynaklarda (dizin oluşturucular, dizinler ve veri kaynakları gibi ama belgeler değil) POST, PUT veya DELETE yöntemleriyle kullanın.
If-None-Match ETag veya * Bir kaynağı yalnızca geçerli sürüm belirtilen ETag ile eşleşmiyorsa değiştirmek için kullanılır. İyimser eşzamanlılık denetimini etkinleştirmek için bu üst bilgiyi kaynaklarda (dizin oluşturucular, dizinler ve veri kaynakları gibi ama belgeler değil) POST, PUT veya DELETE yöntemleriyle kullanın.
Yanıt Üst Bilgisi Tür Description
client-request-id GUID Varsa, özgün istekte çağıran tarafından belirtilen bir tanımlayıcı.
İçerik Türü İçerik Türü Yanıt gövdesinin içerik türü.
Konum URL POST ve PUT /indexes istekleri için yeni oluşturulan dizin tanımının URL'si.
OData-Version "4.0" Yanıtın OData protokolü sürümü.
istek kimliği GUID Geçerli işlem için benzersiz bir tanımlayıcı. Belirtilirse client-request-id değerine eşit; aksi takdirde değer sunucuda oluşturulur.
geçen süre Sayı Hizmetin isteği işlemek için harcadığı milisaniye cinsinden süre. Bu değer yalnızca isteği işlemek için harcanan zamanı içerir ve ağ aktarım süresini içermez.
Etag Dize Kaynağın geçerli sürümünü temsil eden opak bir dize (dizin oluşturucular, dizinler ve veri kaynakları için döndürülür, ancak belgeler için döndürülmüyor). İyimser eşzamanlılık denetimi için bu dizeyi If-Match veya If-None-Match üst bilgisinde kullanın.

Ayrıca bkz.

Azure AI Arama REST API'leri