Membuat sesi agen baru dan mengembalikan ID sesi.
Deskripsi operasi
Deskripsi permintaan
-
Operasi ini membuat sesi agen baru.
-
Gunakan
_meta.agent.agentNameuntuk menentukan nama agen yang terikat. Parameter ini wajib diisi.dataworks_data_agent: Agen bawaan DataWorks — Data Agent, yang menyediakan kemampuan AI pengembangan data cerdas yang mencakup seluruh alur kerja integrasi data, pengembangan, O&M, tata kelola, dan analitik.
dataworks_chatbi_agent: Agen bawaan DataWorks — ChatBI, yang menggunakan pemrosesan bahasa alami dan teknologi analitik cerdas untuk mengotomatisasi seluruh alur kerja analisis dari penguraian kebutuhan, ekstraksi data, dan pembuatan kode otomatis hingga output laporan visualisasi melalui interaksi percakapan.
dataworks_ai_assistant_agent: Agen bawaan DataWorks — Layanan AI Assistant, yang merupakan asisten AI khusus tingkat perusahaan DataWorks yang dibangun di atas framework open source seperti OpenClaw dan Hermes Agent.
-
Gunakan
_meta.config.sessionSourceuntuk meneruskan pengenal sumber sesi untuk pengambilan berikutnya berdasarkan sumber. -
Gunakan
_meta.config.sessionTags[].sessionTagCodeuntuk meneruskan tag sesi.
Coba sekarang
Test
RAM authorization
|
Action |
Access level |
Resource type |
Condition key |
Dependent action |
|
dataworks:CreateAgentSession |
create |
*Semua Sumber daya.
|
None | None |
Sintaks permintaan
POST HTTP/1.1
Parameter permintaan
|
Parameter |
Type |
Required |
Description |
Example |
| Jsonrpc |
string |
No |
Versi JSON-RPC. Nilai tetap: 2.0. |
2.0 |
| Id |
string |
No |
ID permintaan yang diteruskan oleh pemanggil. Nilai dikembalikan apa adanya. |
4758330557805415712 |
| Params |
object |
No |
Parameter bisnis. |
|
| Meta |
object |
No |
Metadata tambahan yang membawa informasi binding agen, sumber sesi, tag, dan lainnya. |
|
| Agent |
object |
No |
Konfigurasi agen untuk sesi. Nilai valid adalah hasil yang dikembalikan oleh operasi ListAgents. |
|
| AgentName |
string |
No |
Nama agen yang akan diikat ke sesi. Parameter ini wajib diisi. Nilai valid:
|
dataworks_data_agent |
| Config |
object |
No |
Pengaturan parameter sesi, seperti pengaturan parameter filtering berdasarkan sumber sesi dan tag sesi. |
|
| SessionSource |
string |
No |
Pengidentifikasi sumber sesi untuk pengambilan berdasarkan sumber. Misalnya, jika agen digunakan di Halaman A dan Halaman B, dan Anda ingin Halaman A hanya menampilkan sesi yang dibuat dari Halaman A, Anda dapat memfilter menggunakan parameter ini. Panjang nilai maksimal 128 karakter dan dapat berisi huruf, angka, tanda hubung (-), dan garis bawah (_). |
openapi_sdk |
| SessionTags |
array<object> |
No |
Daftar tag sesi. Anda dapat menggunakan tag sesi untuk pencarian dan pemfilteran. |
|
|
object |
No |
|||
| SessionTagCode |
string |
No |
Tag sesi. Anda dapat memfilter sesi berdasarkan tag. Misalnya, jika Anda menggunakan pengguna RAM tetap untuk memanggil API tetapi sistem Anda memiliki sistem akun sendiri, Anda dapat meneruskan ID akun sistem Anda sebagai tag ini untuk memfilter daftar sesi berdasarkan ID akun. Panjang nilai maksimal 128 karakter dan dapat berisi huruf, angka, tanda hubung (-), dan garis bawah (_). |
chatbi |
| InitialConfigOptions |
object |
No |
Pengaturan parameter lanjutan untuk lingkungan eksekusi agen. |
|
| ExecutionLane |
string |
No |
Mode eksekusi. Nilai valid:
|
chat,cli |
| Mode |
string |
No |
Mode otorisasi untuk eksekusi skrip. Hanya mode yolo yang didukung untuk panggilan API. Nilai valid:
|
yolo |
| Skills |
string |
No |
Nama keterampilan kustom yang akan dimuat. Pisahkan beberapa nama dengan koma (,). |
skill-name-1,skill-name2,skill-name-3 |
| ResourceGroupId |
string |
No |
ID kelompok sumber daya yang digunakan untuk inisialisasi. |
Serverless_res_group_123123123_564657857 |
Elemen respons
|
Element |
Type |
Description |
Example |
|
object |
Parameter tanggapan (hasil). |
||
| RequestId |
string |
ID permintaan. |
8A9D5E6C-5817-5837-9715-6E3967EC6123 |
| JsonRpcResponse |
object |
Tanggapan JSON-RPC. |
|
| Jsonrpc |
string |
Versi JSON-RPC. Nilai tetap: 2.0. |
2.0 |
| Id |
string |
ID permintaan yang diteruskan oleh pemanggil. Nilai dikembalikan apa adanya. |
1 |
| Result |
object |
Data bisnis. Nilainya null jika terjadi error. |
|
| SessionId |
string |
ID sesi yang dibuat. |
sess_0f12abc34 |
Contoh
Respons sukses
JSONformat
{
"RequestId": "8A9D5E6C-5817-5837-9715-6E3967EC6123",
"JsonRpcResponse": {
"Jsonrpc": "2.0",
"Id": "1",
"Result": {
"SessionId": "sess_0f12abc34"
}
}
}
Kode kesalahan
Lihat Error Codes untuk daftar lengkap.
Catatan rilis
Lihat Release Notes untuk daftar lengkap.