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:StartAIAgentInstancenone
  • 全部资源
    *

请求参数

名称类型必填描述示例值
AIAgentIdstring

IMS 控制台上配置的智能体 ID。

39f8e0bc005e4f309379701645f4****
RuntimeConfigAIAgentRuntimeConfig

智能体运行时所需要的配置。

TemplateConfigAIAgentTemplateConfig

智能体模版配置,填写的配置会和控制台上的智能体模版配置进行合并更新。不填写则使用控制台上智能体的默认配置。

UserDatastring

用户自定义信息。

{"Email":"johndoe@example.com","Preferences":{"Language":"en"}}

返回参数

名称类型描述示例值
object

Schema of Response

RequestIdstring

请求 ID。

7B117AF5-2A16-412C-B127-FA6175ED1AD0
InstanceIdstring

该智能体实例的唯一 ID

39f8e0bc005e4f309379701645f4****

示例

正常返回示例

JSON格式

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

错误码

访问错误中心查看更多错误码。