建立一個智能體執行個體,返回智能體所在的頻道、頻道內名稱以及進入頻道所需的token。
介面說明
通過此 API,您可以根據提供的 AI 智能體 ID(AIAgentId)建立一個智能體執行個體。您可以通過 API 響應中的資訊進入對應房間,與智能體進行對話。
調試
您可以在OpenAPI Explorer中直接運行該介面,免去您計算簽名的困擾。運行成功後,OpenAPI Explorer可以自動產生SDK程式碼範例。
調試
授權資訊
|
操作 |
存取層級 |
資源類型 |
條件關鍵字 |
關聯操作 |
|
ice:GenerateAIAgentCall |
none |
*全部資源
|
無 | 無 |
請求參數
|
名稱 |
類型 |
必填 |
描述 |
樣本值 |
| AIAgentId |
string |
是 |
智能體 ID。 |
39f8e0bc005e4f309379701645f4**** |
| Expire |
integer |
否 |
選擇性參數,表示 token 失效的時間,單位秒,預設 3600 秒。取值範圍 0~604800。 |
3600 |
| UserId |
string |
否 |
對話頻道內使用者名稱稱,不輸入則系統自動產生。長度不超過 64。 |
877ae632caae49b1afc81c2e8194ffb4 |
TemplateConfig
deprecated
|
AIAgentTemplateConfig |
否 |
說明
智能體模版配置。已廢棄,詳見 AgentConfig 欄位。 |
|
| UserData |
string |
否 |
使用者自訂資訊。 |
{"Email":"johndoe@example.com","Preferences":{"Language":"en"}} |
| SessionId |
string |
否 |
對話的唯一標記,預設無。 |
fw1gr0bc005e4f309379701645f4**** |
| AgentConfig | AIAgentConfig |
否 |
智能體模版配置,填寫的配置會和控制台上的智能體模版配置進行合并更新。不填寫則使用控制台上智能體的預設配置。 說明
相容 TemplateConfig 規則:優先使用 AgentConfig 中的欄位,如果 TemplateConfig 存在某些欄位 AgentConfig 未填寫,會使用 TemplateConfig 欄位。推薦使用 AgentConfig,不再使用 TemplateConfig。 |
|
| ChatSyncConfig |
object |
否 |
同步聊天記錄配置。 |
|
| IMAIAgentId |
string |
否 |
IM 的智能體 Id。 |
******005e4f309379701645f4**** |
| ReceiverId |
string |
否 |
接收使用者 Id。 |
4167626d312034b2b1c3b7f2f3e41884 |
返回參數
|
名稱 |
類型 |
描述 |
樣本值 |
|
object |
Schema of Response |
||
| AIAgentUserId |
string |
ARTC 頻道內智能體的名稱。 |
877ae632caae49b1afc81c2e8194ffb4 |
| ChannelId |
string |
ARTC 頻道 ID。 |
70f22d5784194938a7e387052f2b3208 |
| InstanceId |
string |
產生的智能體執行個體 ID。 |
39f8e0bc005e4f309379701645f4**** |
| RequestId |
string |
請求 ID。 |
7B117AF5-2A16-412C-B127-FA6175ED1AD0 |
| Token |
string |
端側的 ARTC Token。 |
eyJhcHBpZCI6ICIxMjM0MTIzNxxxxx |
| UserId |
string |
ARTC 頻道內使用者名稱稱。 |
user123 |
樣本
正常返回樣本
JSON格式
{
"AIAgentUserId": "877ae632caae49b1afc81c2e8194ffb4",
"ChannelId": "70f22d5784194938a7e387052f2b3208",
"InstanceId": "39f8e0bc005e4f309379701645f4****",
"RequestId": "7B117AF5-2A16-412C-B127-FA6175ED1AD0",
"Token": "eyJhcHBpZCI6ICIxMjM0MTIzNxxxxx",
"UserId": "user123"
}
錯誤碼
訪問錯誤中心查看更多錯誤碼。
變更歷史
更多資訊,參考變更詳情。