DescribeAIAgentInstance - 查询智能体实例详情_智能媒体服务(IMS)-阿里云帮助中心

查询实例。

接口说明

功能描述：此接口用于查询指定智能体实例的详细信息。
使用场景：当需要监控或分析智能体在通话中的表现，或者调试智能体配置效果时，可调用此接口获取所需数据。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作	访问级别	资源类型	条件关键字	关联操作
ice:DescribeAIAgentInstance	none	全部资源 ``	无	无

请求参数

名称	类型	必填	描述	示例值
InstanceId	string	是	需要查询的智能体实例 ID	39f8e0bc005e4f309379701645f4****

返回参数

名称	类型	描述	示例值
	object	Schema of Response
Instance	object	智能体实例信息
CallLogUrl	string	通话日志的 URL。	https://example.com/call_logs/12345
RuntimeConfig	AIAgentRuntimeConfig	智能体运行时的配置信息。	{"VoiceChat":{"AgentUserId":"voice_agent_001","ChannelId":"voice_channel_001","AuthToken":"your_voice_chat_auth_token"}}
Status	string	智能体实例的状态，如 Finished，Executing。枚举值： Finished：结束。 Executing：运行中。	Finished
TemplateConfig	AIAgentTemplateConfig	智能体模版配置。	{"VoiceChat": {"AppId": "your_voice_chat_app_id"}}
UserData	string	用户自定义信息。	{"Email":"johndoe@example.com","Preferences":{"Language":"en"}}
RequestId	string	请求 ID。	7B117AF5-2A16-412C-B127-FA6175ED1AD0

示例

正常返回示例

JSON格式

{
  "Instance": {
    "CallLogUrl": "https://example.com/call_logs/12345",
    "RuntimeConfig": {
      "AvatarChat3D": {
        "AgentUserId": "877ae632caae49b1afc81c2e8194ffb4",
        "AuthToken": "eyJhcHBpZCI6ICIxMjM0MTIzNxxxxx",
        "ChannelId": "70f22d5784194938a7e387052f2b3208"
      },
      "VisionChat": {
        "AgentUserId": "877ae632caae49b1afc81c2e8194ffb4",
        "AuthToken": "eyJhcHBpZCI6ICIxMjM0MTIzNxxxxx",
        "ChannelId": "70f22d5784194938a7e387052f2b3208"
      },
      "VoiceChat": {
        "AgentUserId": "877ae632caae49b1afc81c2e8194ffb4",
        "AuthToken": "eyJhcHBpZCI6ICIxMjM0MTIzNxxxxx",
        "ChannelId": "70f22d5784194938a7e387052f2b3208"
      }
    },
    "Status": "Finished",
    "TemplateConfig": {
      "VoiceChat": {
        "Greeting": "早上好，我的朋友",
        "LlmHistory": [
          {
            "Role": "user",
            "Content": "你好"
          }
        ],
        "UserOnlineTimeout": 60,
        "UserOfflineTimeout": 5,
        "WorkflowOverrideParams": "{}",
        "EnableIntelligentSegment": true,
        "AvatarUrlType": "USER",
        "BailianAppParams": "{}",
        "LlmHistoryLimit": 10,
        "AsrMaxSilence": 400,
        "AvatarUrl": "http://example.com/a.jpg",
        "WakeUpQuery": "今天天气怎么样？",
        "AppId": "",
        "Volume": 100,
        "EnableVoiceInterrupt": true,
        "VoiceprintId": "uniqueId",
        "VoiceId": "zhixiaoxia",
        "UseVoiceprint": false,
        "MaxIdleTime": 600,
        "GracefulShutdown": false,
        "EnablePushToTalk": false
      },
      "MessageChat": {
        "AppId": ""
      },
      "VisionChat": {
        "Greeting": "早上好，我的朋友！\n",
        "LlmHistory": [
          {
            "Role": "user",
            "Content": "你好"
          }
        ],
        "UserOnlineTimeout": 60,
        "UserOfflineTimeout": 5,
        "WorkflowOverrideParams": "{}",
        "EnableIntelligentSegment": true,
        "BailianAppParams": "{}",
        "LlmHistoryLimit": 10,
        "AsrMaxSilence": 400,
        "WakeUpQuery": "今天天气怎么样？",
        "AppId": "",
        "Volume": 100,
        "EnableVoiceInterrupt": true,
        "VoiceprintId": "uniqueId",
        "VoiceId": "zhixiaoxia",
        "UseVoiceprint": false,
        "MaxIdleTime": 600,
        "GracefulShutdown": false,
        "EnablePushToTalk": false
      },
      "AvatarChat3D": {
        "Greeting": "早上好，我的朋友！",
        "LlmHistory": [
          {
            "Role": "user",
            "Content": "你好"
          }
        ],
        "UserOnlineTimeout": 60,
        "UserOfflineTimeout": 5,
        "WorkflowOverrideParams": "{}",
        "EnableIntelligentSegment": true,
        "BailianAppParams": "{}",
        "LlmHistoryLimit": 10,
        "AsrMaxSilence": 400,
        "WakeUpQuery": "今天天气怎么样？",
        "AppId": "",
        "Volume": 100,
        "AvatarId": "1231",
        "EnableVoiceInterrupt": true,
        "VoiceprintId": "uniqueId",
        "VoiceId": "zhixiaoxia",
        "UseVoiceprint": false,
        "MaxIdleTime": 600,
        "GracefulShutdown": false,
        "EnablePushToTalk": false
      }
    },
    "UserData": "{\"Email\":\"johndoe@example.com\",\"Preferences\":{\"Language\":\"en\"}}"
  },
  "RequestId": "7B117AF5-2A16-412C-B127-FA6175ED1AD0"
}

错误码

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