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

Membuat instans AI agent dan mengembalikan channel tempat agent tersebut berada, nama agent dalam channel tersebut, serta token yang diperlukan untuk bergabung ke channel.

Deskripsi operasi

Gunakan API ini untuk membuat instans AI agent berdasarkan ID AI agent (AIAgentId) yang diberikan. Informasi dalam respons API dapat digunakan untuk bergabung ke channel yang sesuai dan memulai sesi dengan agent tersebut.

Penting Pastikan ID AI agent yang diberikan valid dan konfigurasikan parameter opsional sesuai kebutuhan kasus penggunaan 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	Menentukan ID AI agent.	39f8e0bc005e4f309379701645f4****
Expire	integer	No	Parameter opsional yang menentukan periode validitas token dalam detik. Nilai default adalah 3.600. Nilai harus berada dalam rentang 0 hingga 604.800.	3600
UserId	string	No	Username dalam channel session. Jika Anda tidak memberikan username, sistem akan menghasilkan satu secara otomatis. Username dapat memiliki panjang hingga 64 karakter.	877ae632caae49b1afc81c2e8194ffb4
TemplateConfig `deprecated`	AIAgentTemplateConfig	No	Sistem menggabungkan konfigurasi ini dengan konfigurasi templat agent dari Konsol. Jika Anda tidak mengatur parameter ini, sistem menggunakan konfigurasi default agent dari Konsol. Catatan Menentukan konfigurasi templat agent. Parameter ini sudah usang. Gunakan parameter AgentConfig sebagai gantinya.
UserData	string	No	Menentukan informasi yang ditentukan pengguna.	{"Email":"johndoe@example.com","Preferences":{"Language":"en"}}
SessionId	string	No	Identifier unik untuk session. Default: none.	fw1gr0bc005e4f309379701645f4****
AgentConfig	AIAgentConfig	No	Menentukan konfigurasi templat agent. Sistem menggabungkan konfigurasi ini dengan konfigurasi templat agent dari Konsol. Jika Anda tidak mengatur parameter ini, sistem menggunakan konfigurasi default agent dari Konsol. Catatan Kompatibilitas dengan TemplateConfig: Bidang dalam AgentConfig memiliki prioritas lebih tinggi. Jika suatu bidang ditentukan dalam TemplateConfig tetapi tidak dalam AgentConfig, sistem menggunakan nilai dari TemplateConfig. Kami menyarankan Anda menggunakan AgentConfig alih-alih TemplateConfig.
ChatSyncConfig	object	No	Menentukan konfigurasi sinkronisasi catatan chat.
IMAIAgentId	string	No	Menentukan ID agent Instant Messaging (IM).	****005e4f309379701645f4**
ReceiverId	string	No	Menentukan ID pengguna penerima.	4167626d312034b2b1c3b7f2f3e41884

Elemen respons

Element	Type	Description	Example
	object	Objek respons.
AIAgentUserId	string	Nama agent dalam channel Alibaba Real-time Communication (ARTC).	877ae632caae49b1afc81c2e8194ffb4
ChannelId	string	ID channel ARTC.	70f22d5784194938a7e387052f2b3208
InstanceId	string	ID instans AI agent.	39f8e0bc005e4f309379701645f4****
RequestId	string	ID permintaan.	7B117AF5-2A16-412C-B127-FA6175ED1AD0
Token	string	Token ARTC sisi client.	eyJhcHBpZCI6ICIxMjM0MTIzNxxxxx
UserId	string	Username dalam channel ARTC.	user123
AvatarUserId	string		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.