上傳檔案並發送訊息的API

當您已經完成上傳檔案，要把這個檔案同時發送訊息給 Bot 判斷時，需要使用這個 API 來發送訊息。

URI

{{base_url}}/generic/ns/{{namespace}}/bot-provider/{{bot_provider_name}}/message/sse

HTTP Method

POST

Headers

如果您有設定使用 API-Key 功能，請在 Header 中加入 X-API-KEY 欄位，值為您在 Asgard 後台設定的 API-Key。否則會無法正常連線。

名稱	類型	描述
X-API-KEY	string	您使用的 API-Key

Request Parameters

名稱	類型	描述
customChannelId	string	聊天頻道 ID，請使用同啟動請求用的頻道 ID。同一頻道 ID 才會記憶對話內容。
customMessageId	string	訊息 ID，可自訂或留空，便於追蹤與除錯。通常為流水號遞增。
text	string	輸入的訊息內容。
action	string	這邊固定使用`NONE`
blobIds	array	上傳檔案完成時取得的 blobId，可傳入多個檔案 ID，用陣列格式

Sample Payload

{
    "customChannelId": "a-random-channel-id-1",
    "customMessageId": "a-random-msg-id-3",
    "text": "圖片上有什麼?",
    "action": "NONE",
    "blobIds": ["1939596382025289728"]
}

實際應用範例

請參考下方的請求操作教學，內含完整 JSON 範例與應用說明：

👉 Postman 實際操作與 JSON 格式說明

Response

成功就會收到連串的 JSON 訊息，需要了解每個事件的詳細資訊？請參考底下文件說明：

詳細事件說明

asgard.run.init - 啟動事件
asgard.message.start - 訊息開始事件
asgard.message.delta - 訊息增量事件
asgard.message.complete - 訊息完成事件
asgard.run.done - 完成事件
asgard.run.error - 錯誤事件

Message Template

message 物件的 template 欄位提供了前端公版的渲染資料物件，詳細可參考：

Message Template 完整說明 - 了解如何處理模板資料

URI​

HTTP Method​

Headers​

Request Parameters​

Sample Payload​

實際應用範例​

Response​

詳細事件說明​

Message Template​

URI