StartAIAgentInstance - 啟動智能體執行個體 -

啟動一個IMS配置的AI智能體執行個體。

介面說明

通過此 API，您可以啟動一個配置好的 AI 智能體執行個體，並讓它參與到某個對話中去。您需要提供智能體的 ID（AIAgentId）、運行時配置（RuntimeConfig），可選的包括模版配置（TemplateConfig）及使用者自訂資訊（UserData）。智能體執行個體一旦成功啟動，將返回唯一的InstanceId用於後續跟蹤或操作。

調試

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

調試

授權資訊

下表是API對應的授權資訊，可以在RAM權限原則語句的Action元素中使用，用來給RAM使用者或RAM角色授予調用此API的許可權。具體說明如下：

操作：是指具體的許可權點。
存取層級：是指每個操作的存取層級，取值為寫入（Write）、讀取（Read）或列出（List）。
資源類型：是指操作中支援授權的資源類型。具體說明如下：
- 對於必選的資源類型，用前面加 * 表示。
- 對於不支援資源級授權的操作，用全部資源表示。
條件關鍵字：是指雲產品自身定義的條件關鍵字。
關聯操作：是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權，操作才能成功。

操作

存取層級

資源類型

條件關鍵字

關聯操作

ice:StartAIAgentInstance

none

*全部資源

*

無

請求參數

名稱	類型	必填	描述	樣本值
AIAgentId	string	是	IMS 控制台上配置的智能體 ID。	39f8e0bc005e4f309379701645f4****
RuntimeConfig	AIAgentRuntimeConfig	是	智能體運行時所需要的配置。
AgentConfig	AIAgentConfig	否	智能體模版配置，填寫的配置會和控制台上的智能體模版配置進行合并更新。不填寫則使用控制台上智能體的預設配置。說明相容 TemplateConfig 規則：優先使用 AgentConfig 中的欄位，如果 TemplateConfig 存在某些欄位 AgentConfig 未填寫，會使用 TemplateConfig 欄位。推薦使用 AgentConfig，不再使用 TemplateConfig。
UserData	string	否	使用者自訂資訊。	{"Email":"johndoe@example.com","Preferences":{"Language":"en"}}
SessionId	string	否	對話的唯一標記，預設無。	f213fbc005e4f309379701645f4****
ChatSyncConfig	object	否	同步聊天記錄配置。
IMAIAgentId	string	否	IM 的智能體 Id。	****005e4f309379701645f4**
ReceiverId	string	否	接收使用者 Id。	4167626d312034b2b1c3b7f2f3e41884
TemplateConfig `deprecated`	AIAgentTemplateConfig	否	智能體模版配置，填寫的配置會和控制台上的智能體模版配置進行合并更新。不填寫則使用控制台上智能體的預設配置。說明智能體模版配置。已廢棄，詳見 AgentConfig 欄位。

返回參數

名稱	類型	描述	樣本值
	object	Schema of Response
RequestId	string	請求 ID。	7B117AF5-2A16-412C-B127-FA6175ED1AD0
InstanceId	string	該智能體執行個體的唯一 ID	39f8e0bc005e4f309379701645f4****

樣本

正常返回樣本

JSON格式

{
  "RequestId": "7B117AF5-2A16-412C-B127-FA6175ED1AD0",
  "InstanceId": "39f8e0bc005e4f309379701645f4****"
}

錯誤碼

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

變更歷史

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