Catatan
Akses ke halaman ini memerlukan otorisasi. Anda dapat mencoba masuk atau mengubah direktori.
Akses ke halaman ini memerlukan otorisasi. Anda dapat mencoba mengubah direktori.
Azure AI Search REST API mendukung sekumpulan header permintaan/respons HTTP umum, dirangkum di sini untuk referensi:
| Header Permohonan | Tipe | Description |
|---|---|---|
| Terima | Jenis konten | Jenis konten yang diminta untuk respons. Defaultnya adalah application/json; odata.metadata=minimal. Nilai lain yang diizinkan adalah application/json, application/json; odata.metadata=lengkap, aplikasi/json; odata.metadata=none, dan text/plain (hanya untuk $count). |
| kunci API | String | Atur ke kueri atau kunci admin Anda, tergantung pada API. |
| otorisasi | String | Token akses OAuth 2.0 untuk permintaan. Memerlukan konfigurasi ke layanan pencarian Anda untuk akses berbasis peran. Header permintaan ini untuk aplikasi klien yang menggunakan autentikasi ID Microsoft Entra dan penetapan peran. Kode klien Anda harus memberikan token. Anda dapat menggunakan header permintaan ini dengan versi REST API yang didukung selama layanan pencarian dikonfigurasi untuk autentikasi bidang data. |
| Jenis-Konten | Jenis-Konten | Jenis konten isi permintaan (PUT/POST). Harus diatur ke application/json. |
| ID permintaan klien | GUID | ID permintaan yang ditentukan pemanggil opsional, dalam bentuk GUID tanpa dekorasi seperti kurung kurawal (misalnya, client-request-id: 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0). Nilai yang ditentukan pemanggil 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" |
| Lebih suka | "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. |
| kembalikan-klien-permintaan-id | Benar atau Salah | Jika ditentukan saat client-request-id ditentukan, menginstruksikan server untuk menyertakan header client-request-id dalam respons. Nilai bawaan 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 resource (seperti pengindeks, indeks, dan sumber data, tetapi bukan dokumen) untuk mengaktifkan kontrol konkurensi yang optimis. |
| Jika-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 resource (seperti pengindeks, indeks, dan sumber data, tetapi bukan dokumen) untuk mengaktifkan kontrol konkurensi yang optimis. |
| Respons Header | Tipe | Description |
|---|---|---|
| ID permintaan klien | 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. |
| id permintaan | GUID | Pengidentifikasi unik untuk operasi saat ini. Sama dengan client-request-id jika ditentukan; jika tidak, nilai dihasilkan di server. |
| waktu yang telah berlalu | Number | Waktu, dalam milidetik, yang dihabiskan layanan untuk memproses 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 yang optimis. |