GetChatContent API 實現即時SSE流傳輸 - Data Management

介面說明

請求說明

響應將以 SSE 流的形式返回，其中每個事件都遵循SSEEvent模式，包含有關訊息層級的元資訊等。
每個 SSE 事件中的content欄位可能攜帶實際的訊息文本或 JSON 對象，具體取決於content_type的值。

調試

您可以在OpenAPI Explorer中直接運行該介面，免去您計算簽名的困擾。運行成功後，OpenAPI Explorer可以自動產生SDK程式碼範例。

調試

授權資訊

當前API暫無授權資訊透出。

請求文法

POST /api/v1/chat/stream HTTP/1.1

請求參數

名稱	類型	必填	描述	樣本值
DMSUnit	string	否	當前所在的 DMS 單元，阿里雲國內站使用者預設填入 cn-hangzhou。	cn-hangzhou
SessionId	string	否	會話 ID，必須欄位	sess_12345
AgentId	string	否	AgentId，必填	xxxx-xxxx-xxxx
Checkpoint	string	否	後端將從這個介面開始返回輸出	0

返回參數

名稱	類型	描述	樣本值
	object	SSE 響應流的每條 data 都符合該 json 結構
content	string	訊息內容	Data understanding completed.
event_type	string	訊息的類型，用於區分控制符和具體訊息。如 `CHAT_START`表示 Agent 的一次回複開始，`CHAT_FINISH`表示 Agent 的一次回複結束。`DATA`表示這是一條攜帶了內容的訊息，`DELTA`表示這是一條增量輸出的訊息的一部分.	DATA
content_type	string	content 欄位的類型，可取值: `[str, json]`。當取值為 json 時，content 欄位可進一步解析為 json 結構	str
checkpoint	integer	Checkpoint 值。	0
level	integer	訊息的輸出層級，層級越高越重要	20
category	string	訊息的類別，用於輔助 json 類型的 content 的解析。如`PLAN`表示該訊息是執行計畫的展示，會符合執行計畫的 Schema。	PLAN

樣本

正常返回樣本

JSON格式

{
  "content": "Data understanding completed.",
  "event_type": "DATA",
  "content_type": "str",
  "checkpoint": 0,
  "level": 20,
  "category": "PLAN"
}

錯誤碼

訪問錯誤中心查看更多錯誤碼。

變更歷史

更多資訊，參考變更詳情。