Yaygın HTTP istek ve yanıt başlıkları (Azure AI Search)

Azure AI Arama REST API'leri, referans için burada özetlenmiş yaygın HTTP istek/yanıt başlıklarını destekler:

İstek Başlığı Türü Description
Kabul etmek İçerik türü Yanıt için istenen içerik türü. Varsayılan uygulama / json'dur; odata.metadata=minimum. Diğer izin verilen değerler application/json, application/json; odata.metadata=full, application/json; odata.metadata=none ve metin/sade (sadece $count için).
API anahtarı String API'ye bağlı olarak sorgu veya admin anahtarını ayarlayın.
yetkilendirme String Talep için OAuth 2.0 erişim tokenı. Rol tabanlı erişim için arama hizmetinizde yapılandırma gerekiyor. Bu istek başlığı, Microsoft Entra ID kimlik doğrulaması ve rol atamaları kullanan istemci uygulamaları içindir. İstemci kodunuz tokenı sağlamalıdır. Bu istek başlığını, arama hizmeti veri düzlemi kimlik doğrulaması için yapılandırıldığı sürece 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). Uygulama/json olarak ayarlanması gerekiyor.
istemci-istek-kimliği GUID Isteğe bağlı arayan tarafından belirlenen istek kimliği, kıvırcıl teller gibi süslemesiz bir GUID şeklinde (örneğin, istemci istek-kimliği: 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0). Verilen isteği tanımlayan bir çağıran tarafından tanımlanmış bir değer. Belirtilirse, bu değer isteği eşlemek için yanıt bilgilerine dahil edilir.
OData-MaxVersion "4.0" İstemci tarafından desteklenen maksimum OData protokolü sürümünü belirtir. Varsayılan "4.0"dır.
Tercih etmek "return=representation" veya "return=minimum" PUT ve POST /indexes taleplerinden gelen yanıt yükünü kontrol etmek için kullanılır. Varsayılan olarak POST veya PUT ile yeni bir indeks oluşturulduğunda "return=representation" ve mevcut bir indeks PUT ile güncellendiğinde "return=minimum" olur.
return-client-request-id Doğru veya Yanlış Eğer istemci-request-id belirtildiğinde, sunucuya answer-request-id başlığını dahil etmesi talimatı verilir. Varsayılan değer False'tur.
If-Match ETag veya * Mevcut sürüm belirtilen ETag ile eşleşirse kaynak değiştirmek için kullanılır. Bu başlığı, kaynaklarda (örneğin indeksleyiciler, indeksler ve veri kaynakları gibi, belgeler değil) POST, PIT veya DELETE yöntemleriyle kullanarak iyimser eşzamanlılık kontrolünü mümkün kılın.
If-None-Match ETag veya * Mevcut sürüm belirtilen ETag ile eşleşmiyorsa bir kaynağı değiştirmek için kullanılır. Bu başlığı, kaynaklarda (örneğin indeksleyiciler, indeksler ve veri kaynakları gibi, belgeler değil) POST, PIT veya DELETE yöntemleriyle kullanarak iyimser eşzamanlılık kontrolünü mümkün kılın.
Yanıt Üst Bilgisi Türü Description
istemci-istek-kimliği GUID Eğer varsa, orijinal istekte arayan tarafından belirtilen bir tanımlayıcı.
İçerik Türü İçerik Türü Yanıt bedeninin içerik türü.
Yer URL POST ve PUT /indexes talepleri için yeni oluşturulan indeks tanımının URL'si.
OData-Version "4.0" OData protokolü versiyonu olan yanıt.
request-id GUID Mevcut işlem için benzersiz bir tanımlayıcı. Belirtilirse istemci-request-id ile eşittir; aksi takdirde değer sunucuda üretilir.
Geçmiş zaman Sayı Servisin talebi işleme için harcadığı milisaniye cinsinden zaman. Bu değer yalnızca talebin işleme süresini içerir ve ağ transfer süresini içermez.
ETag String Bir kaynağın mevcut sürümünü temsil eden opak bir dizidir (indeksleyiciler, indeksler ve veri kaynakları için döner, ancak belgeler için döner). Bu diziyi iyimser eşzamanlılık kontrolü için If-Match veya If-None-Match başlığında kullanın.

Ayrıca bakınız

Azure AI Arama REST API'leri