Daftar Indeks (Azure AI Search REST API)
Operasi Daftar Indeks mengembalikan daftar indeks yang saat ini ada di layanan Pencarian Azure AI Anda.
GET https://[service name].search.windows.net/indexes?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. |
| versi-api | Wajib diisi. Versi stabil saat ini adalah api-version=2020-06-30. 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 titik akhir 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. Dapatkan permintaan untuk definisi objek harus menyertakan bidang kunci api yang diatur ke kunci admin Anda (dibandingkan dengan kunci kueri). Lihat Menyambungkan ke Pencarian Azure AI menggunakan autentikasi kunci untuk detailnya. |
Isi Permintaan
Tidak ada.
Respons
Kode Status: "200 OK" dikembalikan untuk respons yang berhasil.
Contoh
{
"value": [
{
"name": "Books",
"fields": [
{"name": "ISBN", ...},
...
]
},
{
"name": "Games",
...
},
...
]
}
Anda dapat memfilter respons hanya ke properti yang Anda minati. Misalnya, jika Anda hanya menginginkan daftar nama indeks, gunakan opsi kueri OData $select :
GET /indexes?api-version=2020-06-30&$select=name
Dalam hal ini, respons dari contoh di atas akan muncul sebagai berikut:
{
"value": [
{"name": "Books"},
{"name": "Games"},
...
]
}
Ini adalah teknik yang berguna untuk menghemat bandwidth jika Anda memiliki banyak indeks di layanan Pencarian Anda.