Dokumen Pencarian (Rest API Pencarian Azure AI)

  • Artikel

Operasi Dokumen Pencarian mengambil dokumen dari Azure AI Search. Ini berguna saat pengguna mengklik hasil pencarian tertentu, dan Anda ingin mencari detail spesifik tentang dokumen tersebut. Anda hanya bisa mendapatkan satu dokumen pada satu waktu. Gunakan Dokumen Pencarian untuk mendapatkan beberapa dokumen dalam satu permintaan.

GET https://[service name].search.windows.net/indexes/[index name]/docs/key?[query parameters]  
  Content-Type: application/json   
  api-key: [admin or query key]

Atau, Anda dapat menggunakan sintaks OData tradisional untuk pencarian kunci:

GET /indexes/[index name]/docs('[key]')?[query parameters]

Parameter URI

Parameter Deskripsi
nama layanan Wajib diisi. Atur ini ke nama unik yang ditentukan pengguna dari layanan pencarian Anda.
nama indeks Wajib diisi. URI permintaan menentukan nama indeks yang akan dikueri. Parameter kueri ditentukan pada string kueri untuk permintaan GET dan di isi permintaan untuk permintaan POST.
kunci Wajib diisi. Nilai Edm.String yang secara unik mengidentifikasi setiap dokumen dalam indeks. Kunci terkadang disebut sebagai ID dokumen. Nilai kunci peka huruf besar/kecil. Misalnya, dokumen dengan kunci "abc" berbeda dari dokumen dengan kunci "ABC".
parameter kueri Konstruksi multi-bagian yang mencakup $select (opsional) dan api-version=2020-06-30 (diperlukan). Untuk operasi ini, versi api ditentukan sebagai parameter kueri.
$select=[string] adalah daftar bidang yang dipisahkan koma untuk diambil. Hanya bidang yang ditandai sebagai dapat diambil yang dapat disertakan dalam klausa ini. Jika tidak ditentukan atau diatur ke *, semua bidang yang ditandai sebagai dapat diambil dalam skema disertakan dalam proyeksi.

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 Azure AI Search menggunakan autentikasi kunci untuk detailnya.

Isi Permintaan

Tidak ada.

Respons

Kode Status: "200 OK" dikembalikan untuk respons yang berhasil.

{   
   field_name: field_value (fields matching the default or specified projection)   
}

Contoh

Cari dokumen yang memiliki kunci '2':

GET /indexes/hotels/docs/2?api-version=2020-06-30

Cari dokumen yang memiliki kunci '3' menggunakan sintaks OData:

GET /indexes/hotels/docs('3')?api-version=2020-06-30

Lihat juga