Informasi yang diperlukan untuk panggilan layanan - OpenSearch

Untuk mengakses OpenSearch LLM-Based Conversational Search Edition menggunakan API atau SDK, Anda memerlukan otorisasi dan autentikasi. Topik ini menjelaskan metode otorisasi dan autentikasi yang digunakan oleh OpenSearch LLM-Based Conversational Search Edition serta cara mengelola Kunci API.

Otorisasi pemanggilan API

OpenSearch LLM-Based Conversational Search Edition menggunakan Kunci API untuk mengotorisasi pemanggilan API. Maksimal 10 Kunci API dapat dibuat dan diaktifkan untuk setiap instance.

Penting

Untuk melindungi Kunci API dari pengungkapan, perhatikan hal-hal berikut:

Jangan mengungkapkan Kunci API dengan cara apa pun. Hal ini mencegah risiko keamanan atau kerugian finansial akibat penggunaan tanpa izin.

Pastikan bahwa semua pemanggilan API hanya dilakukan dari server. Pemanggilan API yang dimulai dari klien, seperti browser, aplikasi, atau mini program, dapat menyebabkan pengungkapan Kunci API.
Jika terdeteksi adanya pengungkapan Kunci API yang mencurigakan, masuk ke Konsol OpenSearch untuk menonaktifkan dan kemudian menghapus Kunci API yang terungkap. Setelah Kunci API dinonaktifkan, Anda tidak dapat memanggil API OpenSearch LLM-Based Conversational Search Edition menggunakan Kunci API tersebut.

Autentikasi pemanggilan API

OpenSearch LLM-Based Conversational Search Edition menggunakan pasangan AccessKey untuk mengautentikasi pemanggilan API. Pasangan AccessKey adalah kredensial permanen yang disediakan oleh Alibaba Cloud dan terdiri dari ID AccessKey dan Rahasia AccessKey.

Pasangan AccessKey tidak digunakan untuk masuk ke Konsol Manajemen Alibaba Cloud. Mereka digunakan untuk mengakses layanan Alibaba Cloud menggunakan alat pengembangan seperti API, CLI, SDK, dan Terraform. Untuk setiap permintaan, tanda tangan dihasilkan berdasarkan konten permintaan yang dienkripsi menggunakan ID AccessKey dan Rahasia AccessKey. Tanda tangan digunakan untuk memverifikasi identitas pemanggil dan validitas permintaan.

Kami merekomendasikan Anda membuat Pengguna Resource Access Management (RAM) untuk memanggil operasi API, membuat pasangan AccessKey untuk Pengguna RAM, dan kemudian memberikan izin kepada Pengguna RAM berdasarkan prinsip hak istimewa minimal. Kemudian, Pengguna RAM dapat memanggil operasi API untuk melakukan pengembangan layanan. Untuk informasi lebih lanjut tentang pasangan AccessKey, lihat Konfigurasikan pasangan AccessKey dalam variabel lingkungan. Untuk informasi lebih lanjut tentang cara membuat dan memberikan izin kepada Pengguna RAM, lihat Buat dan Otorisasi Pengguna RAM.

Prosedur

Masuk ke Konsol OpenSearch.
Di bilah navigasi atas, pilih wilayah tempat instance Anda berada. Di pojok kiri atas, pilih OpenSearch LLM-Based Conversational Search Edition.
Di halaman Manajemen Instance, temukan instance yang ingin Anda kelola dan klik Manage di kolom Aksi. Di panel sebelah kiri, klik API keys.
Klik Create API Key. Sistem akan menghasilkan Kunci API. Klik Salin untuk menyimpan Kunci API atau Unduh File CSV untuk mengunduh Kunci API sebagai file CSV.
Setelah Anda menyimpan Kunci API, pilih I have saved my API KEY dan klik OK.
- Edit: Tambahkan deskripsi untuk Kunci API.
- Lihat: Lihat Kunci API.
- Nonaktifkan atau Aktifkan: Nonaktifkan atau aktifkan Kunci API. Kunci API yang dinonaktifkan tidak dapat digunakan untuk memanggil API OpenSearch LLM-Based Conversational Search Edition.
- Hapus: Hapus Kunci API yang dinonaktifkan.

Contoh otorisasi berbasis kunci API

Anda dapat menggunakan Kunci API untuk mengotorisasi pemanggilan API. Contoh kode berikut menunjukkan cara menggunakan Kunci API untuk mengotorisasi permintaan curl yang meminta daftar entri. Anda dapat memulai permintaan setelah menentukan URL dan Kunci API.

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' \

Contoh Respons

{
  "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 untuk penarikan dana perumahan guna membeli rumah hunian di Hangzhou?"
      ],
      "answer":"\"Alamat kantor adalah ****. Nomor telepon kantor adalah 0571-12329-1.\""
      },
    {
      "entry_id":"2f4c7350a7104f029f316706b61b6eb2",
      "create_time":1718193627000,
      "update_time":1718193627000,
      "questions":[
          "Apakah seorang agen dapat mengajukan pembatalan cabang domestik atas nama orang lain?"
      ],
      "answer":"Ya, seorang agen dapat mengajukan pembatalan cabang domestik atas nama orang lain. Agen harus menyerahkan materi otorisasi di jendela lokasi. ***** Materi tersebut harus ditandatangani oleh pemberi kuasa secara langsung."
    }
    ],
    "errors":[]
}