向已有會話發送使用者Prompt併流式返回Agent響應。
介面說明
請求說明
該 API 用於向指定的會話 ID 發送使用者的 Prompt，並以 SSE（Server-Sent Events）流式方式接收來自 Agent 的響應。
響應可能包括訊息分區、思考過程、工具調用狀態更新等資訊。
如果指定的會話不存在，將通過 SSE 錯誤幀返回 400 錯誤。
stopReason欄位指示了 Agent 停止本輪對話的原因。支援多種類型的內容塊作為 Prompt 輸入，如文本、OSS 檔案下載連結等。
可選地提供額外元資訊
Meta來傳遞更多上下文給服務端。返回的內容符合開源協議 Agent Client Protocol (ACP) 的規範，具體可以參考：https://agentclientprotocol.com
** 請確保在使用該介面前，已充分瞭解 Data Agent 產品的收費方式和價格 ** ：https://www.alibabacloud.com/help/zh/dataworks/dataworks-data-agent-agent-billing
調試
您可以在OpenAPI Explorer中直接運行該介面，免去您計算簽名的困擾。運行成功後，OpenAPI Explorer可以自動產生SDK程式碼範例。
調試
授權資訊
請求文法
POST HTTP/1.1請求參數
|
名稱 |
類型 |
必填 |
描述 |
樣本值 |
| Jsonrpc |
string |
否 |
JSON-RPC 版本，固定 2.0 |
2.0 |
| Id |
string |
否 |
請求方傳入的 id，原樣回顯 |
1021418411 |
| Params |
object |
否 |
業務參數 |
|
| SessionId |
string |
否 |
目標會話 ID，不存在會返回 SSE error 幀 |
sess_0f12abc34 |
| Prompt |
array<object> |
否 |
使用者訊息內容塊數組，參考：https://agentclientprotocol.com/protocol/content |
|
|
array<object> |
否 |
|||
| Type |
string |
否 |
內容塊類型 |
目前支援：text，resource_link |
| Text |
string |
否 |
常值內容 |
Type=text下生效，樣本值：近 7 天銷售額 |
| Uri |
string |
否 |
檔案的 URI。 |
Type= resource_link下生效，樣本值：oss://${bucket}/${ossKey} |
| Name |
string |
否 |
檔案名稱 |
Type= resource_link下生效，樣本值：xxx.csv |
| MimeType |
string |
否 |
檔案 MIME 類型 |
Type= resource_link下生效，樣本值：text/csv |
| Size |
integer |
否 |
檔案的大小，單位：byte |
Type= resource_link下生效，樣本值：1231231 |
| Title |
string |
否 |
檔案名稱 |
Type= resource_link下生效，樣本值：銷售訂單明細.csv |
| Description |
string |
否 |
檔案描述 |
Type= resource_link下生效，樣本值：銷售訂單明細.csv |
| Meta |
object |
否 |
DataWorks 擴充的 Prompt 元資訊 |
|
| Hide |
boolean |
否 |
該 Prompt 是否對使用者隱藏不顯示。比如在 Chat 對話方塊中使用者提問了一句話：近 7 天的銷售金額，然後在調用 OpenAPI 之前，調用系統通過 RAG 召回了一些業務領域知識，需要補充在 Agent 上下文裡面，但是又不想回顯給使用者看，此時可以把該值設定成 true |
true or false |
| Meta |
object |
否 |
擴充元資訊 |
|
| Context |
any |
否 |
Map 類型，對於自訂 Agent 情境下，有些預留位置參數可以通過該值進行替換 |
{ "key1": "value1", "key2": "value2" } |
返回參數
|
名稱 |
類型 |
描述 |
樣本值 |
|
object |
|||
| RequestId |
string |
Id of the request |
D5D70885-7CC7-594A-80C7-2EF1B00FFB4B |
| Timestamp |
integer |
時間戳記。 |
1747447032 |
| Jsonrpc |
string |
JSON-RPC 版本，固定 2.0 |
2.0 |
| Id |
string |
請求方傳入的 id，原樣回顯 |
631478864897630XXXX |
| Result |
any |
SSE 的幀結果集，返回的內容符合開源協議 Agent Client Protocol (ACP) 的規範，具體可以參考：https://agentclientprotocol.com/protocol/prompt-turn |
{"stopReason":"end_turn"} |
| Error |
any |
SSE 的幀資訊錯誤提示，返回的內容符合開源協議 Agent Client Protocol (ACP) 的規範，具體可以參考：https://agentclientprotocol.com/protocol/prompt-turn |
{"code": 400, "errorCode": "0x50000000001", "message": "not exist session", "data": null} |
| Method |
string |
SSE 的 method，返回的內容符合開源協議 Agent Client Protocol (ACP) 的規範，具體可以參考：https://agentclientprotocol.com/protocol/prompt-turn |
session/update |
| Params |
any |
SSE 的 params，返回的內容符合開源協議 Agent Client Protocol (ACP) 的規範，具體可以參考：https://agentclientprotocol.com/protocol/prompt-turn |
{"sessionId":"af4f5ef8-e8f5-481c-ad1f-94886c6c0aed","update":{"sessionUpdate":"agent_message_chunk","content":{"type":"text","text":"hello world"}}} |
樣本
正常返回樣本
JSON格式
{
"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\"}}}"
}錯誤碼
訪問錯誤中心查看更多錯誤碼。
變更歷史
更多資訊，參考變更詳情。