PromptAgentSession - DataWorks - Alibaba Cloud Documentation Center

Mengirim prompt pengguna ke sesi yang ada dan mengembalikan tanggapan Agen dalam mode streaming.

Deskripsi operasi

API ini mengirimkan prompt pengguna ke ID sesi tertentu dan menerima tanggapan Agen dalam mode streaming SSE (Server-Sent Events).
Tanggapan dapat mencakup fragmen Paket, prosedur berpikir, pembaruan status pemanggilan alat, dan informasi lainnya.
Jika sesi yang ditentukan tidak ada, kesalahan 400 dikembalikan melalui frame error SSE.
Bidang stopReason menunjukkan alasan Agen menghentikan giliran percakapan saat ini.
Berbagai jenis blok konten didukung sebagai input prompt, seperti teks dan tautan unduhan file OSS.
Anda dapat secara opsional memberikan informasi meta tambahan Meta untuk meneruskan lebih banyak konteks ke server.
Konten yang dikembalikan sesuai dengan spesifikasi open-source Agent Klien Protocol (ACP). Untuk informasi selengkapnya, lihat: https://agentclientprotocol.com
Sebelum memanggil API ini, pastikan Anda sepenuhnya memahami metode penagihan dan harga produk Data Agent: https://www.alibabacloud.com/help/en/dataworks/dataworks-data-agent-agent-billing

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

dataworks:PromptAgentSession

none

*Semua Sumber daya.

*

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 yang diteruskan oleh peminta. Nilai dikembalikan apa adanya.	1021418411
Params	object	No	Parameter bisnis.
SessionId	string	No	ID sesi target. Jika sesi tidak ada, frame error SSE dikembalikan.	sess_0f12abc34
Prompt	array<object>	No	Array dari blok konten Paket Klien pengguna. Untuk informasi selengkapnya, lihat: https://agentclientprotocol.com/protocol/content.
	array<object>	No
Type	string	No	Tipe blok konten.	Saat ini didukung: text, resource_link.
Text	string	No	Konten teks.	Berlaku saat Type=text. Contoh: Jumlah penjualan dalam 7 hari terakhir.
Uri	string	No	URI file.	Berlaku saat Type=resource_link. Contoh: oss://${bucket}/${ossKey}
Name	string	No	Nama file.	Berlaku saat Type=resource_link. Contoh: xxx.csv.
MimeType	string	No	Tipe MIME file.	Berlaku saat Type=resource_link. Contoh: text/csv.
Size	integer	No	Ukuran file. Unit: byte.	Berlaku saat Type=resource_link. Contoh: 1231231
Title	string	No	Judul file.	Berlaku saat Type=resource_link. Contoh: SalesOrderDetails.csv.
Description	string	No	Deskripsi file.	Berlaku saat Type=resource_link. Contoh: SalesOrderDetails.csv.
Meta	object	No	Informasi meta prompt extended DataWorks.
Hide	boolean	No	Menentukan apakah akan menyembunyikan prompt dari pengguna. Misalnya, jika pengguna bertanya "Jumlah penjualan dalam 7 hari terakhir" pada dialog chat, sistem pemanggil dapat menggunakan RAG untuk mengambil pengetahuan domain bisnis yang relevan dan menambahkannya ke konteks agen sebelum memanggil API. Jika Anda tidak ingin menampilkan informasi tambahan ini kepada pengguna, tetapkan parameter ini ke true.	true or false
Meta	object	No	Informasi meta extended. Penting Jika Agen yang terikat pada sesi yang ditentukan bernama dataworks_ai_assistant_agent (Layanan AI Assistant), berikan ID Instans Layanan AI Assistant di bidang Context.agent.instanceId dari informasi meta extended.
Context	any	No	Tipe Map. Dalam skenario Agen kustom, beberapa parameter placeholder dapat diganti melalui nilai ini.	{ "key1": "value1", "key2": "value2" }

Elemen respons

Element	Type	Description	Example
	object
RequestId	string	ID permintaan.	D5D70885-7CC7-594A-80C7-2EF1B00FFB4B.
Timestamp	integer	Stempel waktu.	1747447032
Jsonrpc	string	Versi JSON-RPC. Nilai tetap: 2.0.	2.0
Id	string	ID yang diteruskan oleh peminta. Nilai dikembalikan apa adanya.	631478864897630XXXX.
Result	any	Set hasil frame SSE. Konten yang dikembalikan sesuai dengan spesifikasi open-source Agent Klien Protocol (ACP). Untuk informasi selengkapnya, lihat: https://agentclientprotocol.com/protocol/prompt-turn.	{"stopReason":"end_turn"}
Error	any	Pesan error frame SSE. Konten yang dikembalikan sesuai dengan spesifikasi open-source Agent Klien Protocol (ACP). Untuk informasi selengkapnya, lihat: https://agentclientprotocol.com/protocol/prompt-turn.	{"code": 400, "errorCode": "0x50000000001", "message": "Sesi tidak ada", "data": null}
Method	string	Metode SSE. Konten yang dikembalikan sesuai dengan spesifikasi open-source Agent Klien Protocol (ACP). Untuk informasi selengkapnya, lihat: https://agentclientprotocol.com/protocol/prompt-turn.	session/update
Params	any	Parameter SSE. Konten yang dikembalikan sesuai dengan spesifikasi open-source Agent Klien Protocol (ACP). Untuk informasi selengkapnya, lihat: https://agentclientprotocol.com/protocol/prompt-turn.	{"sessionId":"af4f5ef8-e8f5-481c-ad1f-94886c6c0aed","update":{"sessionUpdate":"agent_message_chunk","content":{"type":"text","text":"halo dunia"}}}

Contoh

Respons sukses

JSONformat

{
  "RequestId": "D5D70885-7CC7-594A-80C7-2EF1B00FFB4B",
  "Timestamp": 1747447032,
  "Jsonrpc": "2.0",
  "Id": "631478864897630XXXX",
  "Result": "{\"stopReason\":\"end_turn\"}\n",
  "Error": "{\"code\": 400, \"errorCode\": \"0x50000000001\", \"message\": \"not exist session\", \"data\": null}",
  "Method": "session/update",
  "Params": "{\"sessionId\":\"af4f5ef8-e8f5-481c-ad1f-94886c6c0aed\",\"update\":{\"sessionUpdate\":\"agent_message_chunk\",\"content\":{\"type\":\"text\",\"text\":\"hello world\"}}}"
}

Kode kesalahan

Lihat Error Codes untuk daftar lengkap.

Catatan rilis

Lihat Release Notes untuk daftar lengkap.