DescribeAppAgentTemplates - 查询智能体模版列表

更新时间:
复制为 MD 格式

应用智能体模版列表

接口说明

QPS 限制

本接口的单用户 QPS 限制为 10 次/秒。超过限制,API 调用会被限流,这可能会影响您的业务,请合理调用。

调试

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

调试

授权信息

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

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

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

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

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

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

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

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

操作

访问级别

资源类型

条件关键字

关联操作

rtc:DescribeAppAgentTemplates

none

*App

acs:rtc::{#accountId}:app/{#AppId}

请求参数

名称

类型

必填

描述

示例值

AppId

string

应用 ID。通过控制台创建和查询,仅支持传单个 ID。

ac7N****

Name

string

模版名称。

智能体模版

Id

string

模版 ID。

123121414122313121313

PageNum

integer

分页页码。

1

PageSize

integer

分页大小。

10

返回参数

名称

类型

描述

示例值

object

Schema of Response

RequestId

string

Id of the request

30D41049-D02D-1C21-86AE-B3E5FD805C27

TotalNum

integer

记录数。

10

TotalPage

integer

分页数

1

Templates

array<object>

模版列表

array<object>

Greeting

string

问候语。

你好,机器人。

CreateTime

string

创建时间。格式为:yyyy-MM-ddTHH:mm:ssZ(UTC 时间)。

2020-09-04T06:22:15Z

AgentSilenceConfig

object

智能体静默配置。

Content

string

静默提示消息的内容。

你好,还在吗?

WebhookTriggerTimeout

integer

触发智能体静默超时 webhook 的静默超时时间(单位:秒)。可能多次触发,若智能体 webhook 静默超时后依然静默,则再超时还会继续触发。

50

Strategy

integer

静默超时处理策略。 1 - 向用户语音播报 content 指定的提示消息 2 - 把 content 指定的提示消息和历史对话发送给 LLM,并播报模型生成的回复

1

AlertTimeout

integer

静默提醒的超时时间(单位:秒)。 可能多次触发,若智能体静默提醒超时后依然静默,则再超时还会继续触发。

60

AmbientSoundConfig

object

环境音配置。

SoundId

string

环境音 ID。

office

Volume

integer

环境音音量大小。

50

InterruptConfig

object

打断配置。

SemanticsInterrupt

boolean

是否开启语义打断。

BackChannelConfig

object

承接词配置。

UserTurnEnd

boolean

用户说完话之后,是否开启承接词。

InterruptMode

integer

打断方式:

  • 1: 支持打断(默认)

  • 2: 禁止打断

1

Name

string

模版名称。

测试

AsrConfig

object

语音转文字配置。

VocabularyId

string

热词 ID。

ecfadace11114cf08a7f07aceee798ad

MaxSentenceSilence

integer

语音断句检测阈值,默认 500ms,允许范围[200,6000]。

300

VadConfig

object

vad 配置。

InterruptSpeechDuration

integer

人声持续阈值 (ms),取值范围为[0,3000]。持续检测到人声信号的最小时间长度,避免误打断。

1200

WordWeights

array<object>

每个词表最多包含 500 个热词,每个热词中文长度不超过 10 个字符。 热词必须为 UTF-8 编码,不能包含标点、特殊字符,不符合的情况下,无热词效果。

object

热词权重。

Word

string

热词文本,每个词语最长 10 个汉字或英文单词。

德州

Lang

string

语言代码。

zh

Weight

integer

热词权重,取值范围为[1, 5]之间的整数。 常用值:4。 如果效果不明显可以适当增加权重,但是当权重较大时可能会引起负面效果,导致其他词语识别不准确。

1

Name

string

名称。

Asr配置

Type

integer

智能体类型:

  • 1: 语音通话(默认)

1

LlmConfig

object

大模型设置。

Temperature

number

采样温度,取值范围[0,2),默认值 0.7。

0.8

ApiKey

string

大模型服务商需要的 apikey。

qW8GpBOdHK/pv9gdUSVLvQ==

MaxToken

integer

输出文本的最大限制,默认值 8192。

1024

Model

string

模型,阿里云百炼,目前支持模型为 qwen-plus 和 deepseek-r1。

deepseek-r1

HistoryDepth

integer

给大模型提供多少历史对话轮次,最大 100,默认值 3。

8

Prompt

string

大模型提示词,最大长度为 5000。

你是一个高级心理医生

AgentAppId

string

当 model 是百炼智能体时,标识智能体 AppId。

1233312

Vendor

string

提供方,目前支持阿里云-百炼和第三方配置(符合 OpenAI 接口规范)。

aliyun

TopP

number

采样的选择范围(0,1],默认值 0.8

0.8

Url

string

接入第三方大模型时,该字段表示接入的 endpoint。

https://test.com

Name

string

名称。

llm

TtsConfig

object

文字转语音设置。

ApiKey

string

大模型服务商需要的 apikey。

N5448VFGI2mXJU8a/A03VQ==

FilterBrackets

array

过滤设置。

  • 1-中文刮号()

  • 2-英文刮号()

  • 3-中文方刮号【】

  • 4-英文方刮号[]

  • 5-英文花刮号{}

integer

具体字段。

1

Volume

integer

音量,取值范围[0~100],默认 50。

50

Rate

number

语速,取值范围[0.5~2.0],默认 1.0。

50

Model

string

模型,阿里云百炼,目前支持模型为 cosyvoice-v1。

cosyvoice-v1

Pitch

number

音调,取值范围[0.5~2.0],默认 1.0。

0.8

Vendor

string

提供方,目前支持阿里云-百炼。

aliyun

Voice

string

音色,默认音色是 longxiaoxia。

  • longwan

  • longcheng

  • longhua

  • longxiaochun

  • longxiaoxia

  • longxiaocheng

  • longxiaobai

  • longlaotie

  • longshu

  • longshuo

  • longjing

  • longmiao

  • longyue

  • longyuan

  • longfei

  • longjielidou

  • longtong

  • longxiang

  • loongstella

  • loongbella

longwan

Name

string

名称。

Tts

Id

string

模版 ID。

wv7N****

ChatMode

integer

对话模式:

  • 1: 自然对话模式(默认)

  • 2: 对讲机模式

1

EnableVideoUnderstanding

boolean

如果开启,LLM 模型必须支持多模态数据。

PreferVideo

integer

开启视觉理解后,可以设置智能体优先理解的视频流。 智能体只能理解一路视频流,当 Camera 流和屏幕共享流同时推流

1 - 智能体优先理解 Camera 流;

2 - 智能体优先理解屏幕共享流;

默认优先理解 Camera 流。

示例

正常返回示例

JSON格式

{
  "RequestId": "30D41049-D02D-1C21-86AE-B3E5FD805C27",
  "TotalNum": 10,
  "TotalPage": 1,
  "Templates": [
    {
      "Greeting": "你好,机器人。",
      "CreateTime": "2020-09-04T06:22:15Z",
      "AgentSilenceConfig": {
        "Content": "你好,还在吗?",
        "WebhookTriggerTimeout": 50,
        "Strategy": 1,
        "AlertTimeout": 60
      },
      "AmbientSoundConfig": {
        "SoundId": "office",
        "Volume": 50
      },
      "InterruptConfig": {
        "SemanticsInterrupt": true
      },
      "BackChannelConfig": {
        "UserTurnEnd": true
      },
      "InterruptMode": 1,
      "Name": "测试",
      "AsrConfig": {
        "VocabularyId": "ecfadace11114cf08a7f07aceee798ad",
        "MaxSentenceSilence": 300,
        "VadConfig": {
          "InterruptSpeechDuration": 1200
        },
        "WordWeights": [
          {
            "Word": "德州",
            "Lang": "zh",
            "Weight": 1
          }
        ],
        "Name": "Asr配置"
      },
      "Type": 1,
      "LlmConfig": {
        "Temperature": 0.8,
        "ApiKey": "qW8GpBOdHK/pv9gdUSVLvQ==",
        "MaxToken": 1024,
        "Model": "deepseek-r1",
        "HistoryDepth": 8,
        "Prompt": "你是一个高级心理医生",
        "AgentAppId": "1233312",
        "Vendor": "aliyun",
        "TopP": 0.8,
        "Url": "https://test.com",
        "Name": "llm"
      },
      "TtsConfig": {
        "ApiKey": "N5448VFGI2mXJU8a/A03VQ==",
        "FilterBrackets": [
          1
        ],
        "Volume": 50,
        "Rate": 50,
        "Model": "cosyvoice-v1",
        "Pitch": 0.8,
        "Vendor": "aliyun",
        "Voice": "longwan",
        "Name": "Tts"
      },
      "Id": "wv7N****",
      "ChatMode": 1,
      "EnableVideoUnderstanding": true,
      "PreferVideo": 0
    }
  ]
}

错误码

HTTP status code

错误码

错误信息

描述

400 ParameterError %s. 参数错误
404 NotFound %s. 请求的资源不存在

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

变更历史

更多信息,参考变更详情