Header permintaan dan respons HTTP umum (Azure AI Search)
Artikel
REST API Azure AI Search mendukung sekumpulan header permintaan/respons HTTP umum, yang diringkas di sini untuk referensi:
Header Permintaan
Jenis
Deskripsi
Terima
Jenis konten
Jenis konten yang diminta untuk respons. Defaultnya adalah aplikasi/json; odata.metadata=minimal. Nilai lain yang diizinkan adalah aplikasi/json, aplikasi/json; odata.metadata=full, application/json; odata.metadata=none, dan text/plain (hanya untuk $count).
Token akses OAuth 2.0 untuk permintaan tersebut. Memerlukan konfigurasi ke layanan pencarian Anda untuk akses berbasis peran. Header permintaan ini adalah untuk aplikasi klien yang menggunakan autentikasi Microsoft Entra ID dan penetapan peran. Kode klien Anda harus menyediakan token. Anda dapat menggunakan header permintaan ini dengan versi REST API yang didukung selama layanan pencarian dikonfigurasi untuk autentikasi sarana data.
Jenis-Konten
Jenis-Konten
Jenis konten isi permintaan (PUT/POST). Defaultnya adalah application/json.
client-request-id
GUID
ID permintaan opsional yang ditentukan pemanggil, dalam bentuk GUID tanpa dekorasi seperti kurung kurawal (misalnya, client-request-id: 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0). Nilai yang ditentukan penelepon, yang mengidentifikasi permintaan yang diberikan. Jika ditentukan, nilai ini disertakan dalam informasi respons sebagai cara untuk memetakan permintaan.
OData-MaxVersion
"4.0"
Menentukan versi maksimum protokol OData yang didukung oleh klien. Defaultnya adalah "4.0"
Memilih
"return=representation" atau "return=minimal"
Digunakan untuk mengontrol payload respons dari permintaan PUT dan POST /indexes. Defaultnya adalah "return=representation" saat membuat indeks baru melalui POST atau PUT, dan "return=minimal" untuk memperbarui indeks yang ada melalui PUT.
return-client-request-id
Benar atau Salah
Jika ditentukan saat client-request-id ditentukan, menginstruksikan server untuk menyertakan header client-request-id dalam respons. Defaultnya adalah False.
If-Match
ETag atau *
Digunakan untuk mengubah sumber daya hanya jika versi saat ini cocok dengan ETag yang ditentukan. Gunakan header ini dengan metode POST, PUT, atau DELETE pada sumber daya (seperti pengindeks, indeks, dan sumber data, tetapi bukan dokumen) untuk mengaktifkan kontrol konkurensi optimis.
If-None-Match
ETag atau *
Digunakan untuk mengubah sumber daya hanya jika versi saat ini tidak cocok dengan ETag yang ditentukan. Gunakan header ini dengan metode POST, PUT, atau DELETE pada sumber daya (seperti pengindeks, indeks, dan sumber data, tetapi bukan dokumen) untuk mengaktifkan kontrol konkurensi optimis.
Header Respons
Jenis
Deskripsi
client-request-id
GUID
Pengidentifikasi yang ditentukan oleh pemanggil dalam permintaan asli, jika ada.
Jenis-Konten
Jenis-Konten
Jenis konten dari isi respons.
Lokasi
URL
URL definisi indeks yang baru dibuat untuk permintaan POST dan PUT /indexes.
OData-Version
"4.0"
Versi protokol OData dari respons.
request-id
GUID
Pengidentifikasi unik untuk operasi saat ini. Sama dengan client-request-id jika ditentukan; jika tidak, nilai dihasilkan di server.
waktu berlalu
Telepon
Waktu, dalam milidetik, bahwa layanan menghabiskan pemrosesan permintaan. Nilai ini hanya mencakup waktu yang dihabiskan untuk memproses permintaan, dan tidak termasuk waktu transfer jaringan.
ETag
String
String buram yang mewakili versi sumber daya saat ini (dikembalikan untuk pengindeks, indeks, dan sumber data, tetapi bukan dokumen). Gunakan string ini di header If-Match atau If-None-Match untuk kontrol konkurensi optimis.