Panggilan API dan SDK ke Edisi Pencarian Terbuka berbasis OpenSearch-LLM harus diautentikasi atau diotorisasi. Topik ini menjelaskan metode autentikasi dan otorisasi serta cara mengelola kunci API.
Autentikasi panggilan API
Anda dapat menggunakan kunci API untuk mengautentikasi panggilan API. Metode ini mengharuskan Anda menyertakan kunci API dalam permintaan. Setiap instans mendukung pembuatan dan pengaktifan hingga 10 kunci API.
Untuk mencegah kebocoran kunci API Anda:
-
Jangan memublikasikan kunci API Anda secara terbuka. Penggunaan tanpa izin dapat menimbulkan risiko keamanan atau kerugian finansial.
-
Lakukan panggilan API hanya dari sisi server. Panggilan API dari sisi klien, seperti dari browser, aplikasi, atau mini-program, dapat mengekspos kunci API Anda.
-
Jika Anda mencurigai bahwa kunci API telah dikompromikan, masuklah ke Konsol OpenSearch untuk menonaktifkan lalu menghapus kunci tersebut. Kunci API yang dinonaktifkan tidak dapat lagi digunakan untuk panggilan API.
Otorisasi panggilan API
Anda dapat menggunakan AccessKey untuk otorisasi panggilan API. AccessKey adalah kredensial jangka panjang yang disediakan oleh Alibaba Cloud dan terdiri dari pasangan kunci: ID AccessKey dan Secret AccessKey.
AccessKey tidak digunakan untuk masuk ke konsol. Sebaliknya, AccessKey digunakan untuk mengakses Alibaba Cloud melalui alat pengembangan seperti API, CLI, SDK, dan Terraform. Alat-alat tersebut menandatangani permintaan dengan menggunakan ID AccessKey dan Secret AccessKey guna memverifikasi identitas pengirim dan integritas permintaan.
Kami sangat menyarankan agar Anda membuat RAM user khusus untuk akses API, membuat AccessKey yang sesuai, dan memberikan hanya izin minimum yang diperlukan. Untuk informasi selengkapnya, lihat Create an AccessKey dan Create a RAM user and grant permissions.
Prosedur
-
Masuk ke Konsol OpenSearch.
-
Pilih wilayah target dan beralih ke OpenSearch LLM-Based Conversational Search Edition.
-
Pada daftar instans, klik Manage di sebelah kanan instans target. Di panel navigasi sebelah kiri, klik API keys.
-
Klik Create API Key. Tindakan ini akan menghasilkan kunci API. Klik Copy untuk menyimpan kunci API, atau unduh file CSV untuk menyimpan informasi kunci API.
-
Setelah Anda menyimpan kunci API secara aman, pilih I have saved my API KEY. dan klik OK untuk menutup kotak dialog.
-
Edit: Tambahkan deskripsi untuk kunci API.
-
View: Lihat kunci API.
-
Disable/Enable: Mengaktifkan atau menonaktifkan kunci API. Kunci yang dinonaktifkan tidak dapat digunakan untuk panggilan API.
-
Delete: Anda hanya dapat menghapus kunci API yang telah dinonaktifkan.
-
Contoh: Autentikasi kunci API
Contoh berikut menunjukkan permintaan curl yang menggunakan kunci API untuk mengambil daftar entri. Untuk menjalankan contoh ini, perbarui URL dan ganti placeholder dengan kunci API Anda.
curl --location 'http://***.opensearch-cn-shanghai.aliyuncs.com/v3/openapi/apps/[app_group_identity]/knowledge/entries' \
--header 'Authorization: Bearer YOUR_API_KEY' \
--header 'Content-Type: application/json'Tanggapan contoh:
{
"request_id":"4F6F9BDC-740F-4FC1-B976-74CAFCBF1333",
"status":"OK",
"total_count":2,
"latency":0.0,
"result":[
{
"entry_id":"ca0c8c1cec7c41a280c76c16f0db79f6",
"create_time":1718188424000,
"update_time":1718188424000,
"questions":[
"Di mana alamat kantor layanan untuk mencairkan dana tabungan perumahan saat membeli rumah tinggal di Hangzhou?"
],
"answer":"\"Halo, alamat layanannya adalah ****. Nomor kontak: 0571-12329-1\""
},
{
"entry_id":"2f4c7350a7104f029f316706b61b6eb2",
"create_time":1718193627000,
"update_time":1718193627000,
"questions":[
"Apakah seseorang bisa membantu saya mengajukan permohonan pencabutan pendaftaran cabang perusahaan bermodal domestik atas nama saya?"
],
"answer":"Ya. Anda dapat memberi kuasa kepada seseorang untuk mengajukan permohonan atas nama Anda. Serahkan dokumen yang diperlukan di loket di tempat. Pemberi kuasa harus menandatangani secara langsung."
}
],
"errors":[]
}