Membuat atau Memperbarui Alias (Pratinjau REST API)
Berlaku untuk: 2023-07-01-Preview, 2021-04-30-Preview
Penting
Pratinjau 01-07-2023 (tidak ada perubahan).
Pratinjau 30-04-2021 menambahkan API.
Di Azure AI Search, alias adalah nama sekunder yang dapat digunakan untuk merujuk ke indeks untuk kueri, pengindeksan, dan operasi lainnya.
Anda dapat menggunakan POST atau PUT pada permintaan buat. Untuk salah satu dari keduanya, dokumen JSON dalam isi permintaan menyediakan definisi objek.
POST https://[service name].search.windows.net/aliases?api-version=[api-version]
Content-Type: application/json
api-key: [admin key]
Untuk permintaan pembaruan, gunakan PUT dan tentukan nama alias pada URI.
PUT https://[service name].search.windows.net/aliases/[alias name]?api-version=[api-version]
Content-Type: application/json
api-key: [admin key]
HTTPS diperlukan untuk semua permintaan layanan. Dalam kasus PUT, jika alias tidak ada, alias dibuat. Jika sudah ada, itu diperbarui ke definisi baru.
Membuat alias menetapkan pemetaan antara nama alias dan nama indeks. Jika permintaan berhasil, alias dapat digunakan untuk pengindeksan, kueri, dan operasi lainnya.
Memperbarui alias memungkinkan Anda memetakan alias tersebut ke indeks pencarian yang berbeda. Saat Anda memperbarui alias yang ada, seluruh definisi diganti dengan konten isi permintaan. Secara umum, pola terbaik yang digunakan untuk pembaruan adalah mengambil definisi alias dengan GET, memodifikasinya, lalu memperbaruinya dengan PUT.
Catatan
Pembaruan untuk alias mungkin membutuhkan waktu hingga 10 detik untuk disebarluaskan melalui sistem sehingga Anda harus menunggu setidaknya 10 detik sebelum menghapus indeks yang sebelumnya dipetakan oleh alias.
Catatan
Jumlah maksimum alias yang dapat Anda buat bervariasi menurut tingkat harga. Untuk informasi selengkapnya, lihat Batas layanan.
Parameter URI
| Parameter | Deskripsi |
|---|---|
| nama layanan | Wajib diisi. Atur nilai ini ke nama unik yang ditentukan pengguna dari layanan pencarian Anda. |
| nama alias | Diperlukan pada URI jika menggunakan PUT. Nama harus huruf kecil, dimulai dengan huruf atau angka, tidak memiliki garis miring atau titik, dan kurang dari 128 karakter. Setelah Anda memulai nama dengan huruf atau angka, sisa nama dapat menyertakan huruf, angka, dan tanda hubung apa pun, selama tanda hubung tidak berturut-turut. |
| versi-api | Wajib diisi. Versi pratinjau saat ini adalah 2023-07-01-Preview. Lihat Versi API untuk versi lainnya. |
Judul Permintaan
Tabel berikut ini menjelaskan header permintaan yang diperlukan dan opsional.
| Bidang | Deskripsi |
|---|---|
| Jenis-Konten | Wajib diisi. Atur nilai ini ke application/json |
| api-key | Opsional jika Anda menggunakan peran Azure dan token pembawa disediakan berdasarkan permintaan, jika tidak, kunci diperlukan. Kunci api adalah string unik yang dihasilkan sistem yang mengautentikasi permintaan ke layanan pencarian Anda. Membuat permintaan harus menyertakan header yang api-key diatur ke kunci admin Anda (dibandingkan dengan kunci kueri). Lihat Menyambungkan ke Azure AI Search menggunakan autentikasi kunci untuk detailnya. |
Isi Permintaan
Isi permintaan berisi definisi alias, yang mencakup nama alias dan array dengan nama indeks tunggal.
JSON berikut adalah representasi tingkat tinggi dari bagian utama definisi.
{
"name" : (optional on PUT; required on POST) "The name of the alias",
"indexes" : (required) ["The name of the index the alias is mapped to"]
}
Permintaan berisi properti berikut:
| Properti | Deskripsi |
|---|---|
| nama | Wajib diisi. Nama alias. Nama alias hanya boleh berisi huruf kecil, digit, atau tanda hubung, tidak boleh dimulai atau diakhir dengan tanda hubung dan dibatasi hingga 128 karakter. |
| Indeks | Wajib diisi. Nama indeks tempat alias dipetakan. Hanya satu nama indeks yang dapat disertakan dalam array. |
Respons
Untuk permintaan pembuatan yang berhasil, Anda akan melihat kode status "201 Dibuat".
Untuk permintaan pembaruan yang berhasil, Anda akan melihat "204 Tanpa Konten".
Contoh
Contoh: Alias indeks
{
"name" : "my-alias",
"indexes" : ["my-index"]
}