ListAIAgentInstance - 查询AI智能体实例列表

更新时间:
复制为 MD 格式

查询AI智能体实例列表,可以获取所有或指定条件下的智能体实例列表。

接口说明

该接口允许用户根据指定的智能体 ID(AIAgentId),以及可选的时间范围(StartTimeEndTime)、每页记录数(PageSize)和当前页码(PageNumber)来查询 AI 智能体实例列表。返回结果包含每个实例的状态、运行时配置、模板配置、用户自定义数据及对话通话记录的下载链接。

重要 分页参数默认值:PageSize 为 10,PageNumber 为 1。

调试

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

调试

授权信息

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

  • 操作:是指具体的权限点。

  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。

  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:

    • 对于必选的资源类型,用前面加 * 表示。

    • 对于不支持资源级授权的操作,用全部资源表示。

  • 条件关键字:是指云产品自身定义的条件关键字。

  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

ice:ListAIAgentInstance

none

*全部资源

*

请求参数

名称

类型

必填

描述

示例值

AIAgentId

string

智能体 Id。

39f8e0bc005e4f309379701645f4***

StartTime

string

查询的开始时间(ISO 8601 格式)。默认无。

2023-01-01T00:00:00Z

EndTime

string

查询的结束时间(ISO 8601 格式)。默认无。

2023-01-02T00:00:00Z

PageSize

integer

每页数量,默认 10,取值范围 0~100。

10

PageNumber

integer

当前页数,默认值 1,取值范围 1~100。

1

返回参数

名称

类型

描述

示例值

object

Schema of Response

Instances

array<object>

智能体实例结构体列表。

object

CallLogUrl

string

智能体对话通话记录文件 URL,该文件内部是 CallLog 结构(Json 格式)。

https://example.com/call_logs/12345.json

RuntimeConfig AIAgentRuntimeConfig

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

{"VoiceChat":{"AgentUserId":"voice_agent_001","ChannelId":"voice_channel_001","AuthToken":"your_voice_chat_auth_token"}}

Status

string

实例状态:

  • Created:通话启动但是双端未建立连接

  • Executing:通话执行中,双端已经建立连接

  • Finished:通话结束

枚举值:

  • Finished :

    Finished

  • Executing :

    Executing

Finished

TemplateConfig deprecated AIAgentTemplateConfig

智能体实例所使用的模版配置。

{"VoiceChat": {"VoiceId": "zhixiaoxia"}}

UserData

string

用户自定义信息。

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

AgentConfig AIAgentConfig

智能体实例所使用的模版配置。

RequestId

string

请求 ID。

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

示例

正常返回示例

JSON格式

{
  "Instances": [
    {
      "CallLogUrl": "https://example.com/call_logs/12345.json",
      "RuntimeConfig": {
        "VoiceChat": {
          "AuthToken": "eyJhcHBpZCI6ICIxMjM0MTIzNxxxxx",
          "AgentUserId": "877ae632caae49b1afc81c2e8194ffb4",
          "ChannelId": "70f22d5784194938a7e387052f2b3208"
        },
        "AuthToken": "eyJhcHBpZCI6ICIxMjM0MTIzNxxxxx",
        "AgentUserId": "877ae632caae49b1afc81c2e8194ffb4",
        "VisionChat": {
          "AuthToken": "eyJhcHBpZCI6ICIxMjM0MTIzNxxxxx",
          "AgentUserId": "877ae632caae49b1afc81c2e8194ffb4",
          "ChannelId": "70f22d5784194938a7e387052f2b3208"
        },
        "ChannelId": "70f22d5784194938a7e387052f2b3208\n",
        "AvatarChat3D": {
          "AuthToken": "eyJhcHBpZCI6ICIxMjM0MTIzNxxxxx",
          "AgentUserId": "877ae632caae49b1afc81c2e8194ffb4",
          "ChannelId": "70f22d5784194938a7e387052f2b3208"
        }
      },
      "Status": "Finished",
      "TemplateConfig": {
        "VoiceChat": {
          "Greeting": "早上好,我的朋友",
          "LlmHistory": [
            {
              "Role": "user",
              "Content": "你好"
            }
          ],
          "WorkflowOverrideParams": "{}",
          "EnableIntelligentSegment": true,
          "AvatarUrlType": "USER",
          "AvatarUrl": "http://example.com/a.jpg",
          "VoiceIdList": [
            "zhixiaoxia"
          ],
          "CharBreak": true,
          "EnableVoiceInterrupt": true,
          "VoiceprintId": "uniqueId",
          "GracefulShutdown": false,
          "InterruptWords": [
            "停止"
          ],
          "UserOnlineTimeout": 60,
          "AsrLanguageId": "zh_mandarin",
          "UserOfflineTimeout": 5,
          "LlmSystemPrompt": "你是一位友好且乐于助人的助手,专注于为用户提供准确的信息和建议。",
          "BailianAppParams": "{}",
          "VadLevel": 11,
          "LlmHistoryLimit": 10,
          "AsrMaxSilence": 400,
          "WakeUpQuery": "今天天气怎么样?",
          "Volume": 100,
          "VoiceId": "zhixiaoxia",
          "UseVoiceprint": false,
          "MaxIdleTime": 600,
          "AsrHotWords": [
            "检查"
          ],
          "EnablePushToTalk": false
        },
        "VisionChat": {
          "Greeting": "早上好,我的朋友!\n",
          "LlmHistory": [
            {
              "Role": "user",
              "Content": "你好"
            }
          ],
          "WorkflowOverrideParams": "{}",
          "EnableIntelligentSegment": true,
          "VoiceIdList": [
            "zhixiaoxia"
          ],
          "CharBreak": true,
          "EnableVoiceInterrupt": true,
          "VoiceprintId": "uniqueId",
          "GracefulShutdown": false,
          "InterruptWords": [
            "停止"
          ],
          "UserOnlineTimeout": 60,
          "AsrLanguageId": "zh_mandarin",
          "UserOfflineTimeout": 5,
          "LlmSystemPrompt": "你是一位友好且乐于助人的助手,专注于为用户提供准确的信息和建议。\n",
          "BailianAppParams": "{}",
          "VadLevel": 0,
          "LlmHistoryLimit": 10,
          "AsrMaxSilence": 400,
          "WakeUpQuery": "今天天气怎么样?",
          "Volume": 100,
          "VoiceId": "zhixiaoxia",
          "UseVoiceprint": false,
          "MaxIdleTime": 600,
          "AsrHotWords": [
            "检查"
          ],
          "EnablePushToTalk": false
        },
        "AvatarChat3D": {
          "Greeting": "早上好,我的朋友!",
          "LlmHistory": [
            {
              "Role": "user",
              "Content": "你好"
            }
          ],
          "WorkflowOverrideParams": "{}",
          "EnableIntelligentSegment": true,
          "VoiceIdList": [
            "zhixiaoxia"
          ],
          "AvatarId": "1231",
          "CharBreak": true,
          "EnableVoiceInterrupt": true,
          "VoiceprintId": "uniqueId",
          "GracefulShutdown": false,
          "InterruptWords": [
            "停止"
          ],
          "UserOnlineTimeout": 60,
          "AsrLanguageId": "zh_mandarin",
          "UserOfflineTimeout": 5,
          "LlmSystemPrompt": "你是一位友好且乐于助人的助手,专注于为用户提供准确的信息和建议。",
          "BailianAppParams": "{}",
          "VadLevel": 0,
          "LlmHistoryLimit": 10,
          "AsrMaxSilence": 400,
          "WakeUpQuery": "今天天气怎么样?",
          "Volume": 100,
          "VoiceId": "zhixiaoxia",
          "UseVoiceprint": false,
          "MaxIdleTime": 600,
          "AsrHotWords": [
            "检查"
          ],
          "EnablePushToTalk": false
        }
      },
      "UserData": "{\"Email\":\"johndoe@example.com\",\"Preferences\":{\"Language\":\"en\"}}",
      "AgentConfig": {
        "Greeting": "你好",
        "WakeUpQuery": "今天天气怎么样?\n",
        "MaxIdleTime": 600,
        "UserOnlineTimeout": 60,
        "UserOfflineTimeout": 5,
        "EnablePushToTalk": false,
        "GracefulShutdown": true,
        "Volume": 100,
        "WorkflowOverrideParams": "{}",
        "AvatarUrl": "http://example.com/a.jpg\n",
        "AvatarUrlType": "USER",
        "EnableIntelligentSegment": true,
        "AsrConfig": {
          "AsrLanguageId": "zh_mandarin",
          "AsrMaxSilence": 400,
          "AsrHotWords": [
            "检查"
          ],
          "VadLevel": 11,
          "CustomParams": "mode=fast&sample=16000&format=wav",
          "VadDuration": 300
        },
        "TtsConfig": {
          "VoiceId": "longcheng_v2\n\n",
          "VoiceIdList": [
            "zhixiaoxia"
          ],
          "PronunciationRules": [
            {
              "Word": "一一零",
              "Pronunciation": "幺幺零",
              "Type": "replacement"
            }
          ],
          "ModelId": "speech-01-turbo",
          "LanguageId": "Chinese",
          "Emotion": "happy",
          "SpeechRate": 1
        },
        "LlmConfig": {
          "LlmHistory": [
            {
              "Role": "user",
              "Content": "你好"
            }
          ],
          "LlmHistoryLimit": 10,
          "LlmSystemPrompt": "你是一位友好且乐于助人的助手,专注于为用户提供准确的信息和建议。\n",
          "BailianAppParams": "\"{\\\"biz_params\\\":{\\\"user_defined_params\\\":{\\\"your_plugin_id\\\":{\\\"article_index\\\":2}}},\\\"memory_id\\\":\\\"your_memory_id\\\",\\\"image_list\\\":[\\\"https://your_image_url\\\"],\\\"rag_options\\\":{\\\"pipeline_ids\\\":[\\\"your_id\\\"],\\\"file_ids\\\":[\\\"文档ID1\\\",\\\"文档ID2\\\"],\\\"metadata_filter\\\":{\\\"name\\\":\\\"张三\\\"},\\\"structured_filter\\\":{\\\"key1\\\":\\\"value1\\\",\\\"key2\\\":\\\"value2\\\"},\\\"tags\\\":[\\\"标签1\\\",\\\"标签2\\\"]}}\"",
          "OpenAIExtraQuery": "api-version=2024-02-01&api-key=sk-xxx",
          "LlmCompleteReply": true,
          "FunctionMap": [
            {
              "Function": "hangup",
              "MatchFunction": "hangup"
            }
          ],
          "OutputMinLength": 5,
          "OutputMaxDelay": 2000,
          "HistorySyncWithTTS": false
        },
        "AvatarConfig": {
          "AvatarId": "5257"
        },
        "InterruptConfig": {
          "EnableVoiceInterrupt": true,
          "InterruptWords": [
            "打断一下"
          ],
          "NoInterruptMode": "cache"
        },
        "VoiceprintConfig": {
          "UseVoiceprint": false,
          "VoiceprintId": "zhixiaoxia",
          "RegistrationMode": ""
        },
        "TurnDetectionConfig": {
          "TurnEndWords": [
            "我说完了"
          ],
          "Mode": "Semantic",
          "SemanticWaitDuration": -1,
          "Eagerness": "High"
        },
        "ExperimentalConfig": "\"\"",
        "VcrConfig": {
          "StillFrameMotion": {
            "Enabled": false,
            "CallbackDelay": 3000
          },
          "InvalidFrameMotion": {
            "Enabled": false,
            "CallbackDelay": 3000
          },
          "PeopleCount": {
            "Enabled": false
          },
          "Equipment": {
            "Enabled": false
          },
          "HeadMotion": {
            "Enabled": false
          },
          "LookAway": {
            "Enabled": true
          }
        },
        "AmbientSoundConfig": {
          "ResourceId": "f67901c595834************",
          "Volume": 50
        },
        "AutoSpeechConfig": {
          "UserIdle": {
            "WaitTime": 5000,
            "MaxRepeats": 5,
            "Messages": [
              {
                "Text": "您还在吗?",
                "Probability": 0.5
              }
            ]
          },
          "LlmPending": {
            "WaitTime": 3000,
            "Messages": [
              {
                "Text": "稍等一下",
                "Probability": 0.5
              }
            ]
          }
        },
        "BackChannelingConfigs": [
          {
            "Enabled": true,
            "TriggerStage": "",
            "Probability": 0,
            "Words": [
              {
                "Text": "",
                "Probability": 0
              }
            ]
          }
        ],
        "BackChannelingConfig": [
          {
            "Enabled": true,
            "TriggerStage": "pause_detected",
            "Probability": 0.5,
            "Words": [
              {
                "Text": "嗯嗯",
                "Probability": 0.3
              }
            ]
          }
        ]
      }
    }
  ],
  "RequestId": "7B117AF5-2A16-412C-B127-FA6175ED1AD0"
}

错误码

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

变更历史

更多信息,参考变更详情