Gunakan GenerateAIAgentCall API untuk meluncurkan AI Agent & bergabung dengan Channel - Intelligent Media Services - Alibaba Cloud - Intelligent Media Services

Membuat instance agen AI dan mengembalikan channel tempat agen berada, nama di dalam channel, serta token yang diperlukan untuk masuk ke channel.

Deskripsi operasi

Melalui API ini, Anda dapat membuat instance agen berdasarkan ID agen AI yang diberikan (AIAgentId). Anda dapat menggunakan informasi dalam respons API untuk memasuki ruangan yang sesuai dan melakukan percakapan dengan agen.

Penting Pastikan ID agen AI yang diberikan valid, dan konfigurasi parameter opsional dengan tepat berdasarkan kasus penggunaan aktual Anda.

Coba sekarang

Coba API ini di OpenAPI Explorer tanpa perlu penandatanganan manual. Panggilan yang berhasil akan secara otomatis menghasilkan contoh kode SDK sesuai dengan parameter Anda. Unduh kode tersebut dengan kredensial bawaan yang aman untuk penggunaan lokal.

Test

RAM authorization

Tabel berikut menjelaskan otorisasi yang diperlukan untuk memanggil API ini. Anda dapat menentukannya dalam kebijakan Resource Access Management (RAM). Kolom pada tabel dijelaskan sebagai berikut:

Action: Aksi yang dapat digunakan dalam elemen Action pada pernyataan kebijakan izin RAM untuk memberikan izin guna melakukan operasi tersebut.
API: API yang dapat Anda panggil untuk melakukan aksi tersebut.
Access level: Tingkat akses yang telah ditentukan untuk setiap API. Nilai yang valid: create, list, get, update, dan delete.
Resource type: Jenis resource yang mendukung otorisasi untuk melakukan aksi tersebut. Ini menunjukkan apakah aksi tersebut mendukung izin tingkat resource. Resource yang ditentukan harus kompatibel dengan aksi tersebut. Jika tidak, kebijakan tersebut tidak akan berlaku.
- Untuk API dengan izin tingkat resource, jenis resource yang diperlukan ditandai dengan tanda bintang (*). Tentukan Nama Sumber Daya Alibaba Cloud (ARN) yang sesuai dalam elemen Resource pada kebijakan.
- Untuk API tanpa izin tingkat resource, ditampilkan sebagai All Resources. Gunakan tanda bintang (*) dalam elemen Resource pada kebijakan.
Condition key: Kunci kondisi yang didefinisikan oleh layanan. Kunci ini memungkinkan kontrol granular, berlaku baik hanya untuk aksi maupun untuk aksi yang terkait dengan resource tertentu. Selain kunci kondisi spesifik layanan, Alibaba Cloud menyediakan serangkaian common condition keys yang berlaku di semua layanan yang didukung RAM.
Dependent action: Aksi dependen yang diperlukan untuk menjalankan aksi tersebut. Untuk menyelesaikan aksi tersebut, pengguna RAM atau role RAM harus memiliki izin untuk melakukan semua aksi dependen.

Action

Access level

Resource type

Condition key

Dependent action

ice:GenerateAIAgentCall

none

*全部资源

*

None

Parameter permintaan

Parameter	Type	Required	Description	Example
AIAgentId	string	Yes	ID agen AI.	39f8e0bc005e4f309379701645f4****
Expire	integer	No	Parameter opsional yang menentukan waktu kedaluwarsa token, dalam detik. Nilai default: 3600. Rentang yang valid: 0 hingga 604800.	3600
UserId	string	No	Nama pengguna di dalam channel percakapan. Jika dikosongkan, sistem akan otomatis menghasilkannya. Panjangnya tidak boleh melebihi 64 karakter.	877ae632caae49b1afc81c2e8194ffb4
TemplateConfig `deprecated`	AIAgentTemplateConfig	No	Konfigurasi yang Anda tentukan akan digabungkan ke dalam konfigurasi template agen di konsol. Jika dikosongkan, konfigurasi agen default di konsol akan digunakan. Catatan Konfigurasi template agen. Parameter ini telah usang. Untuk informasi lebih lanjut, lihat parameter AgentConfig.
UserData	string	No	Informasi yang ditentukan pengguna.	{"Email":"johndoe@example.com","Preferences":{"Language":"en"}}
SessionId	string	No	Pengenal unik percakapan. Nilai default: tidak ada.	fw1gr0bc005e4f309379701645f4****
AgentConfig	AIAgentConfig	No	Konfigurasi template agen. Konfigurasi yang Anda tentukan akan digabungkan ke dalam konfigurasi template agen di konsol. Jika dikosongkan, konfigurasi agen default di konsol akan digunakan. Catatan Aturan kompatibilitas dengan TemplateConfig: field di AgentConfig diutamakan. Jika TemplateConfig berisi field yang tidak ditentukan di AgentConfig, maka field TemplateConfig akan digunakan. Kami merekomendasikan Anda menggunakan AgentConfig daripada TemplateConfig.
ChatSyncConfig	object	No	Konfigurasi sinkronisasi riwayat chat.
IMAIAgentId	string	No	ID agen untuk IM.	****005e4f309379701645f4**
ReceiverId	string	No	ID pengguna penerima.	4167626d312034b2b1c3b7f2f3e41884

Elemen respons

Element	Type	Description	Example
	object	Skema Respons
AIAgentUserId	string	Nama agen di dalam channel ARTC.	877ae632caae49b1afc81c2e8194ffb4
ChannelId	string	ID channel ARTC.	70f22d5784194938a7e387052f2b3208
InstanceId	string	ID instance agen yang dihasilkan.	39f8e0bc005e4f309379701645f4****
RequestId	string	ID permintaan.	7B117AF5-2A16-412C-B127-FA6175ED1AD0
Token	string	Token ARTC sisi klien.	eyJhcHBpZCI6ICIxMjM0MTIzNxxxxx
UserId	string	Nama pengguna di dalam channel ARTC.	user123
AvatarUserId	string	ID pengguna yang digunakan oleh avatar digital untuk bergabung ke pertemuan.	avatar_39f8e0bc005e4f309379701645f4****

Contoh

Respons sukses

JSONformat

{
  "AIAgentUserId": "877ae632caae49b1afc81c2e8194ffb4",
  "ChannelId": "70f22d5784194938a7e387052f2b3208",
  "InstanceId": "39f8e0bc005e4f309379701645f4****",
  "RequestId": "7B117AF5-2A16-412C-B127-FA6175ED1AD0",
  "Token": "eyJhcHBpZCI6ICIxMjM0MTIzNxxxxx",
  "UserId": "user123",
  "AvatarUserId": "avatar_39f8e0bc005e4f309379701645f4****"
}

Kode kesalahan

Lihat Error Codes untuk daftar lengkap.

Catatan rilis

Lihat Release Notes untuk daftar lengkap.