logo
产品简介 产品简介
基本概念 基本概念
平台新手指引 平台新手指引
计价模式 计价模式
开发者文档下拉
开放平台计价
定制服务计价
获取访问令牌 获取访问令牌
语音合成 语音合成
开发者文档下拉
接口说明
发音人列表
在线合成 开发者文档下拉
Android SDK
iOS SDK
C++(Linux) SDK
RESTful API
Websocket API
长文本语音合成API
离线合成 开发者文档下拉
离线合成 Android SDK
离线合成 iOS SDK
语音识别 语音识别
开发者文档下拉
一句话识别 开发者文档下拉
RESTful API
Websocket API
实时长语音识别 开发者文档下拉
Websocket API
录音文件识别 开发者文档下拉
RESTful API
SDK文档 开发者文档下拉
Android SDK
iOS SDK
声音复刻 声音复刻
开发者文档下拉
定制模型 开发者文档下拉
RESTful API
Android SDK
iOS SDK
语音合成 开发者文档下拉
RESTful API
声音转换 声音转换
开发者文档下拉
Websocket API
Android SDK
iOS SDK
协议规则 协议规则
开发者文档下拉
平台服务协议
平台通用规则
法律声明及隐私政策
服务等级协议SLA
常见问题 常见问题
开发者文档下拉
语音合成
语音识别

录音文件识别Restful API

功能介绍

录音文件识别时针对已经录制的音频文件,进行文字转写。录音文件识别是非实时的,通过接口提交录音文件或可以直接下载的文件URL,系统接收后进行识别转文字。

音频要求

  • 直接上传音频数据方式一次最多不能超过64MB
  • 通过提交音频URL方式文件大小不超过512MB
  • 单声道:wav,pcm,mp3
  • 双声道:mp3
  • 音频采样率:8000Hz,16000Hz
  • 位深:16bits

使用方法

1. 创建账号和应用,详见平台新手指引,通过标贝开放平台/应用/服务获取client_id,client_secret

2. 发送请求获取access_token,详见获取访问令牌

3. 发送新建任务请求:发送新建任务请求,具体参数详见请求参数

4. 接收返回结果:发送请求成功后会立即收到返回响应,采用JSON格式封装,在“taskid"字段中获取任务id,具体参数详见新建任务响应结果

5. 发送查询识别结果请求:使用“taskid”发送查询识别结果请求,具体参数详见查询识别结果

6. 接收识别结果:发送请求成功后会立即收到返回响应,采用JSON格式封装,识别结果在“text"字段内,具体参数详见响应识别结果

服务地址

访问类型 说明 URL Host
外网访问 新建任务 https://openapi.data-baker.com/asr/starttask? openapi.data-baker.com
外网访问 查询结果
(主动轮询)
https://openapi.data-baker.com/asr/taskresult? openapi.data-baker.com

交互流程

1. 主动轮询 2. 回调通知

测试音频

测试音频

请求参数

1. 请求headers
参数名称 名称 是否必填 说明
access_token String Yes 通过client_id,client_secret调用授权服务获得见获取访问令牌
file_url String No 录音文件URL,外网可访问。 如未指定该参数,则把音频方与请求体中上传
callback_url String No 识别结果回调URL
如有,则识别结束后通过回调通知
否则,则通过查询结果进行轮询
channel Integer No 录音文件声道数
1:单声道
2:双声道(audio_format为mp3时支持)
audio_format String Yes 音频格式
pcm
wav
mp3
sample_rate Integer Yes 音频采样率支持
8000Hz
16000Hz
domain string no 模型名称,通用模型 "common",
英文模型"english",
默认值为“common”
2. 请求体

当未指定file_url参数时,请将二进制音频数据放到HTTP请求体中;

当指定file_url参数时,服务端将忽略HTTP请求体,并从指定的url处下载音频文件

请求示例

curl -X POST \
-H "access_token:xxxxxxxxxx" \
-H "audio_format:wav" \
-H "sample_rate:16000" \
--data-binary "@wav_16k.wav" \
"https://openapi.data-baker.com/asr/starttask?"

Python示例代码

代码地址:Github

Python3示例如下:

#!/usr/bin/env python
# coding: utf-8

import argparse
import time

import requests
import json


# 获取access_token用于鉴权
def get_access_token(client_secret, client_id):
    grant_type = "client_credentials"
    url = "https://openapi.data-baker.com/oauth/2.0/token?grant_type={}&client_secret={}&client_id={}".format(
        grant_type, client_secret, client_id)
    response = requests.post(url)
    access_token = json.loads(response.text).get('access_token')

    return access_token


# 查询识别结果
def get_text(headers):
    url = "https://asr.data-baker.com/asr/taskresult"
    response = requests.post(url, headers=headers)
    text = json.loads(response.text).get("text")
    code = json.loads(response.text).get("code")
    if code != 20000:
        raise Exception(response.text)

    return text


# 创建识别任务,发送识别文件
def create_task(file, headers):
    url = "https://openapi.data-baker.com/asr/starttask?"
    response = requests.post(url, data=file, headers=headers)
    task_id = json.loads(response.text).get("taskid")
    code = json.loads(response.text).get("code")
    if code != 20000:
        raise Exception(response.text)

    return task_id


# 获取命令行输入参数
def get_args():
    parser = argparse.ArgumentParser(description='ASR')
    parser.add_argument('-client_secret', type=str, required=True)
    parser.add_argument('-client_id', type=str, required=True)
    parser.add_argument('-file_path', type=str, required=True)
    parser.add_argument('--audio_format', type=str, default='wav')
    parser.add_argument('--sample_rate', type=str, default='16000')
    args = parser.parse_args()

    return args


if __name__ == '__main__':
    try:
        args = get_args()

        # 获取access_token
        client_secret = args.client_secret
        client_id = args.client_id
        access_token = get_access_token(client_secret, client_id)

        # 新建任务
        file = open(args.file_path, 'rb')
        audio_format = args.audio_format
        sample_rate = args.sample_rate
        headers = {'access_token': access_token, 'audio_format': audio_format, 'sample_rate': sample_rate}
        task_id = create_task(file, headers)

        # 根据录音文件大小,等待识别结束
        time.sleep(1)

        # 查询识别结果
        recognition_headers = {'access_token': access_token, 'taskid': task_id}
        text = get_text(recognition_headers)
        print(text['left_result'])
    except Exception as e:
        print(e)

命令行执行: 默认wav格式,16000采样率

python audio_file_recognition.py -client_secret=你的client_secret -client_id=你的client_secret -file_path=test.wav

如有主要可自行修改参数

python audio_file_recognition.py -client_secret=你的client_secret -client_id=你的client_id -file_path=test.wav --audio_format=wavmple_rate=16000

PHP示例代码

<?php
//获取访问令牌
$client_secret = '***'; //应用secret
$client_id = '***'; //应用id
$grant_type = 'client_credentials'; //固定格式

//1.获取token
$url = 'https://openapi.data-baker.com/oauth/2.0/token?grant_type='.$grant_type.'&client_id='.$client_id.'&client_secret='.$client_secret;

//curl get请求
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $url);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, false); //信任任何证书
curl_setopt($ch, CURLOPT_SSL_VERIFYHOST, 0); // 检查证书中是否设置域名,0不验证
$token_res = curl_exec($ch);

//如果错误 查看错误信息
if(curl_errno($ch))
{
    print curl_error($ch);
}
curl_close($ch);

//进行token信息解析
$token_info = json_decode($token_res,1);
$access_token = $token_info['access_token'];    //获取到的token信息
//var_dump($access_token);die;
//$access_token = '***';

//2.录音文件新建任务 说明(支持录音文件url方式,支持识别结果回调方式。本demo采用本地文件发送请求体识别,主动轮询识别结果方式。)
$url = 'https://openapi.data-baker.com/asr/starttask?';

//curl post请求
$audio_format = 'wav';  //音频格式
$sample_rate = 16000;   //采样率
$Content_Type = 'application/json; charset=utf-8';
$headers = array(
    'access_token:'.$access_token,
    'audio_format:'.$audio_format,
    'sample_rate:'.$sample_rate,
    'Content-Type:'.$Content_Type
);

$file_path = './test.wav';
//第一种方式读取
$post_audio = file_get_contents($file_path);

//第二种方式读取
//$file_size = filesize($file_path);
//$post_audio = fread(fopen($file_path, "r"), $file_size);

$ch = curl_init();
curl_setopt($ch, CURLINFO_HEADER_OUT, true);
curl_setopt($ch, CURLOPT_URL, $url);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);
curl_setopt($ch, CURLOPT_POST, true);
curl_setopt($ch, CURLOPT_POSTFIELDS, $post_audio);
$audio_res = curl_exec($ch);

//$request_header = curl_getinfo($ch, CURLINFO_HEADER_OUT);

if(curl_errno($ch))
{
    print curl_error($ch);
}
curl_close($ch);

$audio_info = json_decode($audio_res,1);
$task_id = $audio_info['taskid'];    //新建任务后返回的全局唯一任务ID


//3.查询识别结果

function queryRes($access_token,$task_id){
    sleep(10);   //等待10s后查询识别结果(可以队列方式)
    $url = 'https://openapi.data-baker.com/asr/taskresult?';

    //curl post请求
    $Content_Type = 'application/json; charset=utf-8';
    $headers = array(
        'access_token:'.$access_token,
        'taskid:'.$task_id,
        'Content-Type:'.$Content_Type
    );

    $ch = curl_init();
    curl_setopt($ch, CURLOPT_URL, $url);
    curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
    curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);
    $result = curl_exec($ch);
    if(curl_errno($ch))
    {
        print curl_error($ch);
    }
    curl_close($ch);

    $result_info = json_decode($result,1);

    //如果响应结果不成功递归调用
    if($result_info['code']!=20000){
        queryRes($access_token,$task_id);
    }else{
        $text = $result_info['text'];    //录音文件识别结果 json 类型
        var_dump($text);die;
    }
}

queryRes($access_token,$task_id);

新建任务响应结果

字段名 描述
trace_id 日志id,如遇到问题,可反馈此id给开发,用于跟踪问题
code 请求结果码,请参考错误码一节
info 任务结果描述,如请求失败请根据该字段内容分析问题
taskid 任务id,后面请求方可携带此taskid去查询是否识别结束
1. 请求成功
{
    "trace_id":" 1571988259683020 ",
    "code":20000,
    "info":"Success",
    "taskid":" f0c58fc9************90e3ebfdb653"
}
2. 请求失败
{
    "trace_id":" 1571988883381595 ",
    "code":40007,
    "info":"Invalid body"
}

查询识别结果

参数名称 类型 是否必填 说明
access_token String Yes 通过client_id,client_secret调用授权服务获得见获取访问令牌
taskid string yes 识别任务的taskid
curl -X POST \
-H "access_token:xxxxxxxxxx" \
-H "taskid:f0c58fc9************90e3ebfdb653" \
"https://openapi.data-baker.com/asr/taskresult" 

响应识别结果

回调通知或主动查询得到识别结果,json格式返回。
字段名 描述
trace_id 日志id,如遇到问题,可反馈此id给开发,用于跟踪问题
code 请求结果码,请参考错误码一节
info 任务结果描述,如请求失败请根据该字段内容分析问题
text 识别结果,josn对象,任务失败则为空
taskid 任务id,后面请求方可携带此taskid去查询是否识别结束

text参数:

字段名 类型 描述 内部结构
left_result_array jsonArray 左声道分段识别结果 segment_code:分段任务code,暂时固定为 20000,忽略该字段
success:yes/no此分段是否识别成功,忽略该字段
sos:音频分段开始时间点(秒)
eo:音频分段结束时间点(秒)
result:分段识别结果
right_result_array jsonArray 右声道分段识别结果 同上
left_result string 左声道全部识别结果
right_result string 右声道全部识别结果

识别结果示例

{
	  "trace_id":" 1571988259683020 ",
	  "code":20000,
	  "info":"Success",
	  "text":
	  {
		  "left_result_array":
		  [
			 {"sos":0.02, "eos":4,  "result":"北国风光", "success":"yes"},
			 {"sos":6,    "eos":10, "result":"千里冰封" , "success":"yes"},
			 {"sos":11,   "eos":15, "result":"万里雪飘" , "success":"yes"},
			 {"sos":17,   "eos":22, "result":"望长城内外" , "success":"yes"}
		  ],
		  "left_result":" 北国风光,千里冰封,万里雪飘,望长城内外…"
		  "right_result_array":
		  [
			  {},
			  {}
		  ],
		  "right_result":"…"
	  },
	  "taskid":" f0c58fc9************90e3ebfdb653"
}

回调通知

录音文件识别支持回调接口发送识别结果,在调用创建任务接口时,填写callback_url可以将识别结果直接发送到该接口。(如果长时间未收到回调通知,仍可以根据taskid调用识别接口进行查询)

回调通知Python3示例代码

from flask import Flask, request
import json


app = Flask(__name__)


@app.route("/", methods=['GET', 'POST'])
def get_text():
    with open('test.txt', 'w') as f:
        text = json.loads(request.get_data())['text']['left_result']
        f.write(text)
    return "finished"

将上述代码保存为server.py

命令行执行

export FLASK_APP=server
flask run -p 端口号 --host=服务器IP

回调示例

{'left_result': '欢迎使用标贝科技开放平台!', 'left_result_array': [{'eos': '4.97', 'result': '欢迎使用标贝科技开放平台!', 'segment_code': 20000, 'sos': '0.23', 'success': 'yes'}]}

错误码

code 描述 解决方案
20000 请求成功
20001 任务正在处理 等待10分钟再查询
20002 taskid无效 使用新建识别任务时返回的taskid
30001 HTTP请求参数错误 服务器内部错误,提交traceid,标贝后台进行排查。
30002 服务内部错误
30003 识别结果解析出错
30004 应用包名未知
30005 语音质量问题
30006 输入语音过长
30007 连接识别引擎失败
30008 会话id不存在
30009 Rpc调用非法
30010 redis rpop操作返回空
30011 redis rpop值不合法
30012 rpc调用识别引擎失败
30013 Redis rpop操作失败
30014 redis lpush操作失败
30015 单个语音分片过长
30016 回调url失败
50002 内部rpc调用失败
50009 其他内部错误