API Path
/aipaas/voice/v1/stream/synthesis
请求协议
WS
请求头部:
| 头部标签 | 必填 | 说明 | 类型 | 数据字典 | 限制 | 头部内容 | 示例 |
|---|---|---|---|---|---|---|---|
| Content-Type | 是 | application/json | [string] | application/json | application/json | ||
| X-APP-ID | 是 | 控制台-应用管理-创建应用-AppID | [string] | ||||
| Device-Uuid | 否 | 设备管理-设备uuid | [string] | ||||
| Authorization | 是 | 鉴权信息 | [string] | ||||
请求参数:
| 参数名 | 说明 | 必填 | 类型 | 数据字典 | 限制 | 示例 |
|---|---|---|---|---|---|---|
| req_id | 请求全局唯⼀ ID,记录该值便于排查问题 | 是 | [string] | |||
| text | 待合成的⽂本,需要为 UTF-8 编码 | 是 | [string] | |||
| format | ⾳频编码格式,⽀持 PCM 格式,默认值:PCM | 否 | [string] | |||
| sample_rate | ⾳频采样率,⽀持 16000 Hz | 否 | [int] | |||
| voice | 说话⼈,默认值: yixiaobei(翼小贝) | 否 | [string] | yixiaoling:翼小玲,yixiaoke:翼小可,yixiaochao:翼小超,yixiaotong:翼小童,yixiaoxuan:翼小轩,yixiaotian:翼小甜,yixiaoluo:翼小萝,yixiaohui:翼小慧,yixiaowei:翼小威,yixiaoliang:翼小亮,yixiaoshen:翼小深,yixiaojing:翼小京,yixiaorou:翼小柔,yixiaobei:翼小贝 | ||
| volume | ⾳量,取值范围:[0, 100],默认值:50 | 否 | [string] | |||
| speech_rate | 语速,取值范围:[0.5, 2.0],默认值:1.0 | 否 | [float] | |||
| pitch | 语调,取值范围:[0.5, 2.0],默认值:1.0 | 否 | [float] | |||
返回结果:
| 参数名 | 说明 | 必填 | 类型 | 数据字典 | 限制 | 示例 |
|---|---|---|---|---|---|---|
| status | 状态码,⻅服务码说明 | 是 | [string] | |||
| status_msg | 状态说明,⻅服务码说明 | 是 | [string] | |||
| result | 结果 | 是 | [object] | |||
| result>>audio | 合成⾳频数据,经过 base64 编码 | 是 | [string] | |||
| result>>audio_len | 合成⾳频⻓度,单位:ms | 是 | [int] | |||
| result>>is_end | 标志位: true:最后⼀个合成⽚段 false:中间合成⽚段 | 是 | [boolean] | |||
| result>>phn_seq_len | 合成⾳频⾳素序列⻓度 | 是 | [int] | |||
| result>>phn_id_seq | 合成⾳频⾳素 ID 序列 | 是 | [array] | |||
| result>>phn_name_seq | 合成⾳频⾳素名称序列 | 是 | [array] | |||
| result>>phn_dur_seq | 合成⾳频⾳素持续时间序列 | 是 | [array] |
流式语⾳合成提供将输⼊⽂本合成为语⾳⼆进制数据的功能。
服务接口调用时需要严格遵循服务鉴权规则,服务调用鉴权规则请参见:开发指南 - 签名认证方式。
通用状态码请参见【状态码】中的【网关认证】,其余状态码如下:
| 返回码 | 说明 | 错误信息 | 解决⽅法 |
|---|---|---|---|
| 101 | 成功 | {"message":"success"} | 成功,开始语音合成 |
| 4001 | query 参数错误 | {"message":"parse queryparameter fail"} | 检查 query 参数格式是否正确 |
| 4001 | 缺少 app_id 或者app_id ⽆效 | {"message":"loseparameter app_id"} | 检查是否有 app_id 参数或者 app_id 是否有效 |
| 4001 | 缺少 sign | {"message":"loseparameter sign"} | 检查是否有 sign 参数 |
| 4001 | 缺少 timestamp 或者时间戳过期 | {"message":"invalidtimestamp"} | 检查是否有时间戳参数或者时间戳是否过期,时间戳 10 分钟有效 |
| 4001 | 签名校验失败 | {"message":"check signfail"} | 检查签名生成是否错误 |
| 4002 | 并发请求多 | {"message":"Too manyrequests"} | 联系商务,增加并发 |
| 返回码 | 解释 | 说明 | 解决方法 |
|---|---|---|---|
| 10301 | Required parameter miss | 必填参数缺失 | 检查请求体是否符合接口协议 |
| 10304 | Parse request body fail | 请求格式错误 | 查看请求的 URL body 格式是否正确,参考接口 文档 |
| 10503 | Server connection time out | 服务连接超时 | 联系技术人员 |
| 10903 | Synthesis failed | 合成失败 | 联系技术人员 |
| 10000 | Success | 成功 | 执行下一步操作 |
4.1 请求参数示例:
{
"req_id": "3a87fe9793c9-4ebd-95d4-4ce2-a80c054b",
"text": "今天是周⼀,天⽓挺好的。"
}
4.2 开始合成响应示例
{
"status": 10000,
"status_msg": "Success",
"sid": "4eHgiLCBhbGdvcml"
}
4.3 接收合成数据响应示例
{
"status": 10000,
"status_msg": "Success",
"result": {
"audio": "//6YYmNiDlSUXjZlDP8yADQAQ1E2ANKJOaTqFGUgIwDQAKAA==",
"audio_len": 2500,
"is_end": false,
"phn_seq_len": 10,
"phn_id_seq": [0, 1, 2, 3, 4, 5, 6, 7, 8, 9],
"phn_name_seq": ["j", "in1", "t", "ian1", "z", "en3", "m", "e1", "l", "e5"],
"phn_dur_seq": [150, 350, 150, 350, 150, 350, 150, 350, 150, 350]
}
}
4.4 合成结束响应示例
{
"status": 10000,
"status_msg": "Success",
"result": {
"audio": "//6YYmNiDlSUXjZlDP8yADQAQ1E2ANKJOaTqFGUgIwDQAKAA==",
"audio_len": 2500,
"is_end": true,
"phn_seq_len": 10,
"phn_id_seq": [0, 1, 2, 3, 4, 5, 6, 7, 8, 9],
"phn_name_seq": ["j", "in1", "t", "ian1", "z", "en3", "m", "e1", "l", "e5"],
"phn_dur_seq": [150, 350, 150, 350, 150, 350, 150, 350, 150, 350]
}
}
import com.alibaba.fastjson.JSONObject;
import org.java_websocket.client.WebSocketClient;
import org.java_websocket.handshake.ServerHandshake;
import java.net.URI;
import java.net.URISyntaxException;
import java.util.HashMap;
import java.util.Map;
/**
* 为保证示例可以正常运行,请确认maven中是否存在以下依赖:
*
* org.java-websocket
* Java-WebSocket
* 1.5.3
*
*
* com.alibaba
* fastjson
* 2.0.49
*
*/
public class WebSocketExample extends WebSocketClient {
public WebSocketExample(URI serverUri, Map headers) {
super(serverUri, headers);
}
public static void main(String[] args) {
try {
// 创建WebSocket客户端
URI uri = new URI("算法调用地址");
Map headers = new HashMap();
//调用鉴权
headers.put("X-APP-ID", "yourAppId");
headers.put("Authorization", "yourAuthorization");
WebSocketExample client = new WebSocketExample(uri, headers);
client.connect();
// 等待一段时间后关闭连接
Thread.sleep(5000);
client.close();
} catch (URISyntaxException | InterruptedException e) {
e.printStackTrace();
System.out.println("WebSocket error: " + e.getMessage());
}
}
@Override
public void onOpen(ServerHandshake handshakedata) {
System.out.println("WebSocket connection opened");
// 发送消息
try {
// 初始化连接消息
JSONObject initSend = new JSONObject();
initSend.put("req_id", "test001");
initSend.put("text", "今天是周⼀,天⽓挺好的。");
send(initSend.toJSONString());
} catch (Exception e) {
e.printStackTrace();
}
}
@Override
public void onMessage(String message) {
System.out.println("Received message: " + message);
}
@Override
public void onClose(int code, String reason, boolean remote) {
System.out.println("WebSocket connection closed: " + reason);
}
@Override
public void onError(Exception ex) {
System.err.println("WebSocket error: " + ex.getMessage());
}
}
import argparse
import asyncio
import websockets
import json
import base64
import logging
import time
# 配置日志,设置日志级别为INFO,并指定日志格式
logging.basicConfig(level=logging.INFO, format='%(asctime)s - %(levelname)s - %(message)s')
logger = logging.getLogger()
async def uws_call(args):
# 获取命令行参数中的URL
url = args.url
# 记录开始时间
start_time = time.time()
logger.info(f"开始建立websocket连接,获取当前时间:{start_time}")
header = {
"Content-Type": "application/json",
'X-APP-ID': args.X_APP_ID,
'Authorization': args.Authorization
}
# 建立WebSocket连接
async with websockets.connect(url, extra_headers=header) as websocket:
logger.info("=================================请求参数start_json===============================")
# 构建请求参数
start_json = {
'req_id': 'test001',
'text': '今天是周⼀,天⽓挺好的。'
}
logger.info(f"请求参数:{start_json}")
# 发送请求参数
await websocket.send(json.dumps(start_json))
try:
# 接收响应
resp_str = await websocket.recv()
resp_data = json.loads(resp_str)
if resp_data['status'] == 10000:
logger.info('Received initial response: %s', resp_str)
# 记录连接建立(即收到第一个响应)的时间
connection_established_time = time.time()
logger.info('WebSocket connection established in %.2f seconds',
connection_established_time - start_time)
is_end = False
# 打开文件以写入音频数据
with open("test.pcm", "wb") as f:
while not is_end:
# 接收音频数据
resp_audio_str = await websocket.recv()
resp_audio_data = json.loads(resp_audio_str)
if resp_audio_data['status'] != 10000:
logger.error('Received non-success status: %s', resp_audio_data)
break
if 'result' in resp_audio_data:
synth_info = resp_audio_data['result']
logger.info('Received synthesis info: %s', synth_info)
# 解码音频数据并写入文件
audio_wav = base64.b64decode(synth_info['audio'])
f.write(audio_wav)
is_end = synth_info['is_end']
else:
logger.error('No result in response: %s', resp_audio_data)
break
# 计算整个交互的耗时(从尝试连接到接收完所有消息)
total_duration = time.time() - start_time
logger.info('Total interaction duration: %.2f seconds', total_duration)
except websockets.exceptions.ConnectionClosed as e:
logger.error('WebSocket connection closed: %s', e)
# 如果连接关闭了,我们仍然可以记录到目前为止的耗时
logger.info('Duration until connection closed: %.2f seconds', time.time() - start_time)
except Exception as e:
logger.error('An error occurred: %s', e)
# 如果发生错误,我们同样记录到目前为止的耗时
logger.info('Duration until error occurred: %.2f seconds', time.time() - start_time)
finally:
# 关闭WebSocket连接
await websocket.close()
def main(args):
# 运行异步函数
asyncio.get_event_loop().run_until_complete(uws_call(args))
if __name__ == '__main__':
# 解析命令行参数
parser = argparse.ArgumentParser()
parser.add_argument('--url', type=str, default='算法调用地址')
parser.add_argument('--X_APP_ID', type=str, default='yourAppId')
parser.add_argument('--Device_Uuid', type=str, default='yourDeviceUuid')
parser.add_argument('--Authorization', type=str, default='yourAuthorization')
args = parser.parse_args()
# 调用主函数
main(args)