CreateAppAgentTemplate - 创建智能体模版

更新时间:
复制为 MD 格式

创建应用智能体模版

接口说明

QPS 限制

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

调试

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

调试

授权信息

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

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

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

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

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

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

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

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

操作

访问级别

资源类型

条件关键字

关联操作

rtc:CreateAppAgentTemplate

none

*App

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

请求参数

名称

类型

必填

描述

示例值

AppId

string

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

ac7N****

Name

string

模版名称。

智能体模版

Type

integer

智能体类型:

  • 1: 语音通话(默认)

1

ChatMode

integer

对话模式:

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

  • 2: 对讲机模式

2

InterruptMode

integer

打断方式:

  • 1: 支持打断(默认)

  • 2: 禁止打断

2

Greeting

string

问候语,最大长度不超过 500。

早上好,我的朋友!

AsrConfig

object

语音转文字设置。

Name

string

名称。

STT

MaxSentenceSilence

integer

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

300

WordWeights

array<object>

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

object

热词权重。

Word

string

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

苹果

Lang

string

语言代码。可不写,大模型会自动设别。

  • zh: 中文

  • en: 英文

zh

Weight

integer

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

4

VadConfig

object

vad 配置。

InterruptSpeechDuration

integer

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

1000

LlmConfig

object

大模型设置。

Name

string

名称。

llm

Vendor

string

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

thirdparty

Url

string

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

https://llm.example.aliyuns.com

ApiKey

string

大模型服务商需要的 apikey。

ak-1213123123132123131

Temperature

number

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

0.9

TopP

number

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

0.8

MaxToken

integer

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

1024

HistoryDepth

integer

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

5

Prompt

string

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

你是一个高级心理医生。

AgentAppId

string

百炼智能体 ID。

TtsConfig

object

文字转语音设置。

Name

string

名称。

Tts

Vendor

string

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

aliyun

ApiKey

string

大模型服务商需要的 apikey。

ak-1213123123132123131

Voice

string

音色,默认音色是 longxiaoxia。

  • longwan

  • longcheng

  • longhua

  • longxiaochun

  • longxiaoxia

  • longxiaocheng

  • longxiaobai

  • longlaotie

  • longshu

  • longshuo

  • longjing

  • longmiao

  • longyue

  • longyuan

  • longfei

  • longjielidou

  • longtong

  • longxiang

  • loongstella

  • loongbella

longcheng

Volume

integer

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

70

Rate

number

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

0.8

Pitch

number

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

0.8

FilterBrackets

array

过滤设置。

  • 1-中文刮号()

  • 2-英文刮号()

  • 3-中文方刮号【】

  • 4-英文方刮号[]

  • 5-英文花刮号{}

integer

具体字段。

1

AgentSilenceConfig

object

智能体静默配置。

AlertTimeout

integer

静默提醒的超时时间(单位:秒)。 可能多次触发,若智能体静默提醒超时后依然静默,则再超时还会继续触发,取值范围:[5, 600],默认值 0,0 表示不提醒

30

WebhookTriggerTimeout

integer

触发智能体静默超时 webhook 的静默超时时间(单位:秒)。可能多次触发,若智能体 webhook 静默超时后依然静默,则再超时还会继续触发,取值范围:[10, 600],默认值 0,0 表示不触发

30

Strategy

integer

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

2

Content

string

静默提示消息的内容。

AmbientSoundConfig

object

智能体环境音配置。不传表示不使用环境配置。

SoundId

string

agent 提供以下默认环境音: - white_noise - office

white_noise

Volume

integer

音量大小。

100

InterruptConfig

object

智能体打断配置。

SemanticsInterrupt

boolean

按语义打断。

BackChannelConfig

object

智能体承接词配置。

UserTurnEnd

boolean

是否开启承接词。

返回参数

名称

类型

描述

示例值

object

Schema of Response

RequestId

string

Id of the request

6159ba01-6687-4fb2-a831-f0cd8d188648

Id

string

模版 ID。

1223131213231313213

示例

正常返回示例

JSON格式

{
  "RequestId": "6159ba01-6687-4fb2-a831-f0cd8d188648",
  "Id": "1223131213231313213"
}

错误码

HTTP status code

错误码

错误信息

描述

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

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

变更历史

更多信息,参考变更详情