Memulai instans Agen AI yang dikonfigurasi di IMS.
Deskripsi operasi
Anda dapat menggunakan API ini untuk memulai instans Agen AI yang telah dikonfigurasi dan mengintegrasikannya ke dalam obrolan. Tentukan ID agen (AIAgentId), konfigurasi waktu proses (RuntimeConfig), serta opsional konfigurasi templat (TemplateConfig) dan data yang ditentukan pengguna (UserData). Setelah instans agen berhasil dimulai, API akan mengembalikan InstanceId unik untuk pelacakan atau operasi lebih lanjut.
Coba sekarang
Test
RAM authorization
Parameter permintaan
|
Parameter |
Type |
Required |
Description |
Example |
| AIAgentId |
string |
Yes |
ID agen yang dikonfigurasi di Konsol IMS. |
39f8e0bc005e4f309379701645f4**** |
| RuntimeConfig | AIAgentRuntimeConfig |
Yes |
Konfigurasi yang diperlukan untuk agen pada waktu proses. |
|
| AgentConfig | AIAgentConfig |
No |
Konfigurasi templat agen. Nilai yang Anda berikan akan digabungkan dengan set konfigurasi templat yang ditetapkan di Konsol. Jika parameter ini diabaikan, agen akan menggunakan konfigurasi default-nya dari Konsol. Catatan
Bidang ini kompatibel dengan TemplateConfig. Bidang dalam AgentConfig memiliki prioritas lebih tinggi. Jika TemplateConfig berisi bidang yang tidak didefinisikan dalam AgentConfig, bidang tersebut tetap digunakan. Gunakan AgentConfig sebagai pengganti TemplateConfig. |
|
| UserData |
string |
No |
Data yang ditentukan pengguna. |
{"Email":"johndoe@example.com","Preferences":{"Language":"en"}} |
| SessionId |
string |
No |
Identifier unik untuk session obrolan. Parameter ini bersifat opsional. |
f213fbc005e4f309379701645f4**** |
| ChatSyncConfig |
object |
No |
Konfigurasi sinkronisasi riwayat obrolan. |
|
| IMAIAgentId |
string |
No |
ID agen IM. |
******005e4f309379701645f4**** |
| ReceiverId |
string |
No |
ID pengguna penerima. |
4167626d312034b2b1c3b7f2f3e41884 |
TemplateConfig
deprecated
|
AIAgentTemplateConfig |
No |
Konfigurasi templat agen. Nilai yang Anda berikan akan digabungkan dengan set konfigurasi templat yang ditetapkan di Konsol. Jika parameter ini diabaikan, agen akan menggunakan konfigurasi default-nya dari Konsol. Catatan
Konfigurasi templat agen. Bidang ini sudah tidak digunakan lagi (deprecated). Lihat bidang AgentConfig. |
Elemen respons
|
Element |
Type |
Description |
Example |
|
object |
Skema Respons |
||
| RequestId |
string |
ID permintaan. |
7B117AF5-2A16-412C-B127-FA6175ED1AD0 |
| InstanceId |
string |
ID unik dari instans agen. |
39f8e0bc005e4f309379701645f4**** |
Contoh
Respons sukses
JSONformat
{
"RequestId": "7B117AF5-2A16-412C-B127-FA6175ED1AD0",
"InstanceId": "39f8e0bc005e4f309379701645f4****"
}Kode kesalahan
Lihat Error Codes untuk daftar lengkap.
Catatan rilis
Lihat Release Notes untuk daftar lengkap.