Reset Dokumen (Pratinjau REST API)
Versi API: 2021-04-30-Preview, 2020-06-30-Preview, 2019-05-06-Preview
Penting
Seluruh API ini adalah fitur pratinjau yang diperkenalkan pada Pratinjau 2019-05-06. Ini mendukung skenario reset.
Reset Dokumen adalah API asinkron. Ini memungkinkan Anda untuk memproses ulang dokumen secara selektif dari sumber data Anda.
API menerima dua jenis pengidentifikasi dokumen sebagai input. Kunci tersebut adalah kunci dokumen (kunci yang secara unik mengidentifikasi dokumen dalam indeks pencarian) dan pengidentifikasi dokumen sumber data (kunci yang secara unik mengidentifikasi dokumen dalam sumber data). Memanggil API menambahkan kunci dokumen atau pengidentifikasi dokumen sumber data untuk direset ke metadata pengindeks. Pada eksekusi pengindeks terjadwal atau sesuai permintaan berikutnya, pengindeks hanya memproses dokumen reset.
- Untuk pengindeks dengan skillset dan pengayaan inkremental diaktifkan, API akan menghapus cache dan menjalankan kembali set keterampilan lengkap hanya untuk dokumen yang ditentukan.
- Untuk pengindeks tanpa set keterampilan, API hanya akan membaca dokumen sumber dari sumber data dan memperbarui/menyisipkan konten ke dalam indeks.
Jika Anda menggunakan kunci dokumen untuk mereset dokumen dan kunci dokumen Anda direferensikan dalam pemetaan bidang pengindeks, pengindeks akan menggunakan pemetaan bidang untuk menemukan bidang yang sesuai di sumber data yang mendasar.
API berfungsi untuk semua pengindeks (dengan atau tanpa set keterampilan). Anda dapat memanggilnya menggunakan permintaan HTTP POST. Jika panggilan berhasil, Anda akan selalu mendapatkan respons 204 NoContent. Tentukan nama pengindeks yang akan diperbarui pada URI permintaan:
POST https://[service name].search.windows.net/indexers/[indexer name]/resetdocs?api-version=[api-version]
Content-Type: application/json
api-key: [admin key]
Parameter URI
| Parameter | Deskripsi |
|---|---|
| nama layanan | Wajib diisi. Atur ini ke nama unik yang ditentukan pengguna dari layanan pencarian Anda. |
| nama pengindeks | Wajib diisi. URI permintaan menentukan nama pengindeks yang akan diperbarui. |
| versi-api | Wajib diisi. Versi saat ini adalah api-version=2021-04-30-Preview. Lihat Versi API untuk versi lainnya. |
| menimpa | Opsional. Parameter ini menentukan apakah operasi Reset Dokumen berturut-turut digabungkan atau ditimpa. Defaultnya adalah false. Ketika false, payload panggilan kunci dokumen atau pengidentifikasi dokumen sumber data akan ditambahkan ke daftar kunci yang sudah diantrekan untuk pemrosesan ulang. Jika true, payload panggilan kunci dokumen atau pengidentifikasi dokumen sumber data akan menimpa daftar yang ada, termasuk menghapus daftar reset dokumen jika Anda mengatur kunci ke null. |
Judul Permintaan
Tabel berikut ini menjelaskan header permintaan yang diperlukan dan opsional.
| Bidang | Deskripsi |
|---|---|
| Jenis-Konten | Wajib diisi. Atur titik akhir ini ke application/json |
| api-key | Wajib diisi. api-key digunakan untuk mengautentikasi permintaan ke layanan Pencarian Anda. Ini adalah nilai string, unik untuk layanan Anda. Permintaan reset harus menyertakan header yang api-key diatur ke kunci admin Anda (dibandingkan dengan kunci kueri). Anda dapat menemukan kunci API di dasbor layanan pencarian di portal Azure. |
Isi Permintaan
Isi harus berisi daftar kunci dokumen atau daftar pengidentifikasi dokumen sumber data yang akan dicari pengindeks di sumber data.
JSON berikut adalah representasi tingkat tinggi dari bagian utama definisi.
{
"documentKeys" : [
"key1",
"key2",
"key3"
],
"datasourceDocumentIds" : [
"key1",
"key2",
"key3"
],
}
Permintaan berisi properti berikut dan perhatikan bahwa satu dan hanya satu dari "documentKeys" dan "datasourceDocumentIds" yang harus disediakan:
| Properti | Deskripsi |
|---|---|
| documentKeys | Ini adalah sekumpulan kunci dokumen yang akan diolah ulang pengindeks secara selektif dari sumber datanya. Secara default, memanggil tindakan ini beberapa kali akan menambahkan kumpulan kunci dokumen bersama-sama. Perilaku ini dapat diubah untuk menimpa daripada menambahkan melalui parameter URI timpa (lihat di atas). Jika Anda ingin pengindeks berhenti mencoba memproses reset dokumen, Anda dapat mengatur "documentKeys" ke daftar kosong "[]". Ini akan mengakibatkan pengindeks melanjutkan pengindeksan reguler berdasarkan tanda air tinggi. Kunci dokumen atau kunci dokumen yang tidak valid yang tidak ada akan diabaikan. |
| datasourceDocumentIds | Ini adalah kumpulan pengidentifikasi dokumen sumber data yang akan diolah ulang pengindeks secara selektif dari sumber datanya. Secara default, memanggil tindakan ini beberapa kali akan menambahkan kumpulan pengidentifikasi dokumen sumber data bersama-sama. Perilaku ini dapat diubah untuk menimpa daripada menambahkan melalui parameter URI timpa (lihat di atas). Jika Anda ingin pengindeks berhenti mencoba memproses reset dokumen, Anda dapat mengatur "datasourceDocumentIds" ke daftar kosong "[]". Ini akan mengakibatkan pengindeks melanjutkan pengindeksan reguler berdasarkan tanda air tinggi. Pengidentifikasi dokumen sumber data yang tidak valid atau pengidentifikasi dokumen sumber data yang tidak ada akan diabaikan. |
Respons
204 Tidak Ada Konten untuk permintaan yang berhasil.