AI虚拟人技术 API 文档
接口说明
AI虚拟人技术 demo java语言
AI虚拟人技术 demo python语言
内容 | 说明 |
---|---|
传输方式 | http[s]和ws[s](为提高安全性,强烈推荐wss) |
请求地址 | 1、启动:http(s): //vms.cn-huadong-1.xf-yun.com/v1/private/vms2d_start 2、文本驱动:http(s): //vms.cn-huadong-1.xf-yun.com/v1/private/vms2d_ctrl 3、音频驱动:ws(s): //vms.cn-huadong-1.xf-yun.com/v1/private/vms2d_audio_ctrl 4、停止:http(s): //vms.cn-huadong-1.xf-yun.com/v1/private/vms2d_stop 5、心跳:http(s): //vms.cn-huadong-1.xf-yun.com/v1/private/vms2d_ping 注:服务器IP不固定,为保证您的接口稳定,请勿通过指定IP的方式调用接口,使用域名方式调用 |
请求行 | 1、启动:POST /v1/private/vms2d_start HTTP/1.1 2、文本驱动:POST v1/private/vms2d_ctrl HTTP/1.1 3、音频驱动:POST v1/private/vms2d_audio_ctrl HTTP/1.1 4、停止:POST v1/private/vms2d_stop HTTP/1.1 5、心跳:POST v1/private/vms2d_ping HTTP/1.1 |
接口鉴权 | 签名机制,详情请参照下方鉴权说明 |
字符编码 | UTF-8 |
响应格式 | 统一采用JSON格式 |
开发语言 | 任意,只要可以向讯飞云服务发起HTTP请求的均可 |
适用范围 | 任意操作系统,但因不支持跨域不适用于浏览器 |
音频格式 | mp3, opus-wb, speex-wb |
文本长度 | 文本大小:0-64k |
#鉴权说明
#鉴权方法
http://vms.cn-huadong-1.xf-yun.com/v1/private/vms2d_start?host=vms.cn-huadong-1.xf-yun.com&date=Fri%2C+16+Dec+2022+07%3A12%3A46+GMT&authorization=YXBpX2tleT0iNzM5NDNjZGVmOTVlZDFhMWQwOTRlNjk4MjA2ZGZjZTEiLCBhbGdvcml0aG09ImhtYWMtc2hhMjU2IiwgaGVhZGVycz0iaG9zdCBkYXRlIHJlcXVlc3QtbGluZSIsIHNpZ25hdHVyZT0iNW03REQxbUNKajF0VXRWYmRWSkJML0FvSTdhMVF6NmZCVVlST21EVEI5UT0i
参数 | 类型 | 必须 | 说明 | 示例 |
---|---|---|---|---|
host | string | 是 | 请求主机 | vms.cn-huadong-1.xf-yun.com |
date | string | 是 | 当前时间戳,RFC1123格式("EEE, dd MMM yyyy HH:mm:ss z") | Fri, 16 Dec 2022 07:12:46 GMTT |
authorization | string | 是 | 使用base64编码的签名相关信息(签名基于hamc-sha256计算) | 参考下方详细生成规则 |
服务端会对date进行时钟偏移检查,最大允许300秒的偏差,超出偏差的请求都将被拒绝。
在讯飞开放平台控制台,创建一个应用后打开AI虚拟人技术页面可以获取,均为32位字符串。
2)参数authorization base64编码前(authorization_origin)的格式如下。
api_key="$api_key",algorithm="hmac-sha256",headers="host date request-line",signature="$signature"
signature 是使用加密算法对参与签名的参数签名后并使用base64编码的字符串,详见下方。
拼接的格式为(\n为换行符,’:’后面有一个空格):
host: $host\ndate: $date\n$request-line
请求url = "https://vms.cn-huadong-1.xf-yun.com/v1/private/vms2d_start"
date = "Fri, 16 Dec 2022 07:12:46 GMT"
host: vms.cn-huadong-1.xf-yun.com
date: Fri, 16 Dec 2022 07:12:46 GMT
POST /v1/private/vms2d_start HTTP/1.1
signature_sha=hmac-sha256(signature_origin,$apiSecret)
signature=base64(signature_sha)
APISecret = "apisecretXXXXXXXXXXXXXXXXXXXXXXX"
date = "Fri, 16 Dec 2022 07:12:46 GMT"
signature="5m7DD1mCJj1tUtVbdVJBL/AoI7a1Qz6fBUYROmDTB9Q="
api_key="apikeyXXXXXXXXXXXXXXXXXXXXXXXXXX", algorithm="hmac-sha256", headers="host date request-line", signature="5m7DD1mCJj1tUtVbdVJBL/AoI7a1Qz6fBUYROmDTB9Q="
authorization = base64(authorization_origin)
示例结果为:
authorization=YXBpX2tleT0iNzM5NDNjZGVmOTVlZDFhMWQwOTRlNjk4MjA2ZGZjZTEiLCBhbGdvcml0aG09ImhtYWMtc2hhMjU2IiwgaGVhZGVycz0iaG9zdCBkYXRlIHJlcXVlc3QtbGluZSIsIHNpZ25hdHVyZT0iNW03REQxbUNKajF0VXRWYmRWSkJML0FvSTdhMVF6NmZCVVlST21EVEI5UT0i
#鉴权结果
HTTP Code | 说明 | 错误描述信息 | 解决方法 |
---|---|---|---|
401 | 缺少authorization参数 | {"message":"Unauthorized"} | 检查是否有authorization参数,详情见authorization参数详细生成规则 |
401 | 签名参数解析失败 | {“message”:”HMAC signature cannot be verified”} | 检查签名的各个参数是否有缺失是否正确,特别确认下复制的api_key是否正确 |
401 | 签名校验失败 | {“message”:”HMAC signature does not match”} | 签名验证失败,可能原因有很多。 1. 检查api_key,api_secret 是否正确。 2.检查计算签名的参数host,date,request-line是否按照协议要求拼接。 3. 检查signature签名的base64长度是否正常(正常44个字节)。 |
403 | 时钟偏移校验失败 | {“message”:”HMAC signature cannot be verified, a valid date or x-date header is required for HMAC Authentication”} | 检查服务器时间是否标准,相差5分钟以上会报此错误 |
HTTP/1.1 403 Forbidden
Date: Mon, 30 Nov 2020 02:34:33 GMT
Content-Length: 116
Content-Type: text/plain; charset=utf-8
{
"message": "HMAC signature does not match, a valid date or x-date header is required for HMAC Authentication"
}
字偏移控制指令
{
"avatar":[
{
"type": "action",
"value": "A_LH_introduced_O",
"wb": 7
}
]
}
字段 | 类型 | 说明 |
---|---|---|
avatar | object | 形象控制,单次输入含1个或多个控制项情绪、动作等渲染引擎功能 |
avatar.type | string | 控制数据类型,支持情绪控制、动作控制 |
avatar.value | string | 动作名称,详见动作列表 |
avatar.wb | int | 动作起始位置,文本驱动需要;音频驱动不需要该字段 |
#动作列表
118801001 | 依丹 |
---|---|
A_TALKING_LONG | 说话段 |
A_LISTENING | 聆听段 |
A_TALKING | 交互说话段 |
A_LH_introduced_O | 左手向左上介绍 |
A_LH_please_O | 身体微侧,左手有请 |
A_RH_bye_O | 右手挥手再见 |
A_RH_emphasize2_O | 右手手掌强调 |
A_RH_emphasize_O | 右手食指强调 |
A_RH_encourage_O | 右手握拳加油 |
A_RH_good_O | 右手点赞夸奖 |
A_RH_introduced1_O | 右手向右上介 绍 |
A_RH_introduced_O | 右手掌心呈现介绍 |
A_RH_like_O | 右手向前比心 |
A_RH_ok_O | 右手举起OK |
A_RH_please1_O | 右手向前有请 |
A_RH_please_O | 右手向右有请 |
A_RLH_emphasize_O | 双手强调 |
110026010 | 伊凡 |
---|---|
A_LH_introduced_O | 左手左上介绍 |
A_RH_click_O | 右手向下指 |
A_RH_emphasize2_O | 右手手掌强调 |
A_RH_emphasize_O_1 | 右手来回晃 |
A_RH_good_O | 右手点赞夸奖 |
A_RH_hello_O | 右手打招呼 |
A_RH_introduced1_O | 右手右上介绍 |
A_RH_introduced_O_1 | 右手食指胸前右滑 |
A_RLH_emphasize_O | 双手强调 |
A_RLH_puzzle_0 | 双手无奈 |
A_RLH_welcome_O | 双手打开 |
110022010 | 晓云 |
---|---|
A_LH_introduced_O | 左手左上介绍 |
A_RH_EMPHASIZE_O_1 | 右手来回晃 |
A_RH_click_O | 右手向下指 |
A_RH_emphasize2_O | 右手手掌强调 |
A_RH_good_O | 右手点赞夸奖 |
A_RH_hello_O | 右手打招呼 |
A_RH_introduced1_O | 右手右上介绍 |
A_RH_introduced_O_1 | 右手食指胸前右滑 |
A_RLH_emphasize_O | 双手强调 |
A_RLH_puzzle_0 | 双手无奈 |
A_RLH_welcome_O | 双手打开 |
110017006 | 马可 |
---|---|
A_LH_please_O | 身体微侧,左手有请 |
A_RH_emphasize2_O | 右手手掌强调 |
A_RH_emphasize_O | 右手指竖起强调 |
A_RH_encourage_O | 右手握拳加油 |
A_RH_good_O | 右手点赞夸奖 |
A_RH_hello_O | 右手打招呼 |
A_RH_please1_O | 右手向前有请 |
A_RH_please_O | 右手向右有请 |
A_RLH_emphasize_O | 双手强调 |
110005018 | 知新 |
---|---|
A_LH_click_O | 左手点击 |
A_LH_introduced_O | 左手左上介绍 |
A_RH_click_O | 右手点击 |
A_RH_hello_O | 右手打招呼 |
A_RH_introduced1_O | 右手右上介绍 |
A_RH_please1_O | 右手有请 |
A_RLH_introduced_O | 双手介绍 |
110029003 | 晓姿(粉色衬衫) |
---|---|
A_RLH_puzzle_0 | 困惑2 |
A_RLH_introduced_O | 双手铺开介绍 |
A_RLH_encourage_O | 双手握拳加油 |
A_RLH_emphasize_O | 双手强调 |
A_RLH_welcome_O | 双手打开欢迎 |
A_LH_introduced_O | 左手向左上介绍 |
A_RH_good_O | 右手点赞夸奖 |
A_RH_encourage_O | 右手握拳加油 |
A_RH_introduced1_O | 右手向右上介绍 |
A_RH_introduced_O | 右手掌心呈现介绍 |
A_RH_emphasize2_O | 右手掌强调 |
A_RH_emphasize_O | 右手指竖起强调 |
A_RH_bye_O | 右手挥手再见 |
A_RH_hello_O | 右手挥手你好 |
A_H_listen_C | 点头倾听 |
110029002 | 晓姿(白色西装) |
---|---|
A_RLH_introduced_O | 双手铺开介绍 |
A_RLH_encourage_O | 双手握拳加油 |
A_RLH_emphasize_O | 双手强调 |
A_RLH_welcome_O | 双手打开欢迎 |
A_LH_introduced_O | 左手向左上介绍 |
A_RH_good_O | 右手点赞夸奖 |
A_RH_encourage_O | 右手握拳加油 |
A_RH_introduced1_O | 右手向右上介绍 |
A_RH_introduced_O | 右手掌心呈现介绍 |
A_RH_emphasize2_O | 右手掌强调 |
A_RH_emphasize_O | 右手指竖起强调 |
A_RH_bye_O | 右手挥手再见 |
A_RH_hello_O | 右手挥手你好 |
A_H_listen_C | 点头倾听 |
110021007 | 晓娴(黑裙) |
---|---|
A_RLH_emphasize_O | 双手强调 |
A_R_introduced_O | 右手体侧向下滑动介绍 |
A_RH_please_O | 右手向右有请 |
A_RH_encourage_O | 右手握拳加油 |
A_RH_emphasize_O | 右手指竖起强调 |
A_RH_please1_O | 右手向前有请 |
A_RH_hello_O | 右手挥手你好 |
110021006 | 晓娴(灰色西装) |
---|---|
A_RLH_emphasize_O | 双手强调 |
A_R_introduced_O | 右手体侧向下滑动介绍 |
A_RH_good_O | 右手点赞夸奖 |
A_RH_emphasize2_O | 右手掌强调 |
A_RH_emphasize_O | 右手指竖起强调 |
A_RH_please1_O | 右手向前有请 |
A_RH_bye_O | 右手挥手再见 |
110026013 | 伊凡(蓝色西装) |
---|---|
A_RLH_emphasize_O | 双手强调 |
A_RH_encourage_O | 右手握拳加油 |
A_RH_like_O | 右手比心 |
A_RH_ok_O | 右手ok |
A_RH_good_O | 右手点赞 |
A_RH_emphasize2_O | 单手强调 |
A_RH_emphasize_O | 单手强调(食指) |
A_LH_introduced_O | 左手向上 |
A_LH_please_O | 身体微侧,左手有请 |
A_RH_introduced_O | 右手左前 |
A_RH_introduced1_O | 右手右上 |
A_RH_please1_O | 右手向前 |
A_RH_bye_O | 右手打招呼 |
110023004 | 小雅(毛衣) |
---|---|
a1_hudong_R | 向右看 |
a1_hudong_L | 向左看 |
a1_jiayou_RL | 双手加油 |
a1_bixin_RL | 双手比心 |
a2_dianzan_R | 手指向前点点 |
a1_guanzhu_R | 手指向上指 |
a1_gouwuche_R | 手指向下指 |
a1_youqing_L | 左手向前 |
a1_jieshao_L | 左手向左 |
a1_jieshao_R | 右手向右 |
a1_jiayou_R | 单手握拳加油 |
a1_bixin_R | 比心 |
a1_dianzan_R | 右手大拇指点赞 |
a1_youqing_R | 右手向前 |
a1_nihao_R | 打招呼 |
#发音人列表
名称 | 语种 | 场景 | 性别 | 虚拟人接口支持的vcn |
---|---|---|---|---|
聆小瑧 | 中文普通话 | 直播 | 女 | x4_lingxiaozhen_eclives |
聆小瑜 | 中文普通话 | 交互 | 女 | x4_lingxiaoyu_assist |
聆玉言 | 中文普通话 | 通用 | 女 | x4_lingyuyan |
聆小珊 | 中文普通话 | 新闻 | 女 | x4_lingxiaoshan_profnews |
聆小璐-助手 | 中文普通话 | 交互 | 女 | x4_lingxiaolu_assist |
聆小璎-助手 | 中文普通话 | 交互 | 女 | x4_lingxiaoying_assist |
聆小璇-助手 | 中文普通话 | 交互 | 女 | x4_lingxiaoxuan_assist |
聆小瑶-助手 | 中文普通话 | 交互 | 女 | x4_lingxiaoyao_assist |
聆飞哲-助手 | 中文普通话 | 交互 | 男 | x4_lingfeizhe_assist |
聆飞晨-助手 | 中文普通话 | 交互 | 男 | x4_lingfeichen_assist |
聆飞晨-情感 | 中文普通话 | 交互 | 男 | x4_lingfeichen_emo |
小露 | 中文普通话 | 通用 | 女 | x4_yezi |
潘婷 | 中文普通话 | 交互 | 女 | x4_panting |
小璇 | 中文普通话 | 交互 | 女 | x4_xiaoxuan |
明哥 | 中文普通话 | 阅读 | 男 | x4_mingge |
一菲 | 中文普通话 | 交互 | 女 | x4_yifei |
超哥 | 中文普通话 | 新闻 | 男 | x4_chaoge |
小忠 | 中文普通话 | 新闻 | 男 | x4_xiaozhong |
小果 | 中文普通话 | 新闻 | 女 | x4_xiaoguo |
Luna-助手 | 美式英语 | 交互 | 女 | x4_EnUs_Luna_assist |
Gavin-助手 | 美式英语 | 交互 | 男 | x4_EnUs_Gavin_assist |
Laura-教育 | 美式英语 | 教育 | 女 | x4_EnUs_Laura_education |
Catherine-新闻 | 美式英语 | 新闻 | 女 | x4_EnUs_Catherine_profnews |
Lindsay-助手 | 美式英语 | 交互 | 女 | x4_EnUs_Lindsay_assist |
Amanda-教育 | 英式英语 | 教育 | 女 | x4_EnUk_Amanda_education |
Ashleigh-助手 | 英式英语 | 交互 | 女 | x4_EnUk_Ashleigh_assist |
Lucy-教育 | 美式英语 | 教育 | 女 | x4_EnUs_Lucy_education |
Ryan-助手 | 美式英语 | 交互 | 男 | x4_EnUs_Ryan_assist |
#常见问题
#AI虚拟人的主要功能是什么?
答:结合语音合成、语音识别、语义理解、图像处理、机器翻译、虚拟形象驱动等多项AI 核心技术,实现了信息播报、互动交流、业务咨询、服务导览等多项功能,满足了新闻、政企、文旅、金融等多场景的需要。
#AI虚拟人支持什么应用平台?
答:目前支持Web API应用平台。
#AI虚拟人支持合成什么格式的音频?
答: mp3, opus(16k), speex(16k)
修改于 2023-12-19 06:20:46