提交录音文件识别任务

功能介绍

该接口用于提交录音文件识别任务，其中录音文件保存在用户的OBS桶中或公网可访问的服务器上（需保证可使用域名访问）。用户开通录音识别服务时，如果录音文件存放在OBS桶中，需授权录音文件引擎读取用户OBS桶权限，授权方法见配置OBS访问权限。该接口的使用限制请参见约束与限制，详细使用指导请参见SIS服务使用简介章节。

SIS服务控制台提供了录音文字识别的在线使用页面，用户无需编程即可使用服务功能。

图1 在线使用

调试

您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。

接口约束

• 录音时长不超过5小时，文件大小不超过300M。8k采样率音频最小为1.6kb，16k采样率音频最小为3.2kb，即音频时长至少0.1s以上。
• 需要将识别的录音文件存放在某服务上，可以通过URL访问。
  • 推荐使用华为云OBS：授权配置请参见配置OBS服务，优先推荐使用与请求服务同一region的私有桶文件，如果region不一致，可考虑使用obs签名。
  • 您也可以把录音文件放在自行搭建服务器上，提供下载文件的地址。URL不能使用IP地址，只能使用域名，请尽量避免中文。
• 音频转写时长受音频时长和排队任务数量影响，音频时长和理论返回时间可参见表 音频转写时长参考表。如果转写耗时比理论时延长，大概率表示当前时间段出现转写高峰，请耐心等待，我们承诺最大转写时长不超过6小时。

  表1 音频转写时长参考表

  音频时长	参考返回时间
  小于10分钟	小于2分钟
  10分钟-60分钟	2分钟-12分钟
  大于60分钟	12 分钟-60分钟

• 识别结果保存72小时（从识别完成的时间算起）。72小时后如果再访问，将会返回 "task id is not found"错误。

URI

POST /v1/{project_id}/asr/transcriber/jobs

请求参数

响应参数

状态码： 200

状态码： 400

请求示例

“endpoint”即调用API的请求地址，不同服务不同区域的“endpoint”不同，具体请参见终端节点。

• 提交录音文件识别任务

  POST https://{endpoint}/v1/1609d8170cd86660a81281e5a3a03f8b/asr/transcriber/jobs
  
  Request Header:
  Content-Type: application/json
  X-Auth-Token: MIINRwYJKoZIhvcNAQcCoIINODCCDTQCAQExDTALBglghkgBZQMEAgEwgguVBgkqhkiG...
  
  Request Body:
  {
    "config":
    {
      "audio_format": "auto",
      "property": "chinese_8k_general",
      "add_punc": "yes",
      "need_analysis_info":
      {
        "diarization": true,
        "channel": "LEFT_AGENT",
        "emotion": true
      },
      "need_word_info": "yes"
    },
    "data_url":"https://****_voip.obs.myxxxcloud.com/VOIP/***.wav"
  }

• 使用Python3语言提交录音文字识别任务

  # -*- coding: utf-8 -*-
  # 此demo仅供测试使用，强烈建议使用sdk。需提前安装requests，执行pip install requests
  import requests
  import time
  import json
  
  def lasr_demo():
      url = 'https://{{endpoint}}/v1/{{project_id}}/asr/transcriber/jobs'  # endpoint和project_id需替换
      token = '用户对应region的token'
      obs_url = 'obs路径'
      header = {
          'Content-Type': 'application/json',
          'X-Auth-Token': token
      }
      body = {
          'data_url': obs_url,
          'config': {
              'property': 'chinese_8k_general',
              'audio_format': 'auto'
          }
      }
      resp = requests.post(url, data=json.dumps(body), headers=header)
      job_id = json.loads(resp.text, encoding='utf-8')['job_id']
      query_task(header, job_id)
  def query_task(header, job_id):
      # endpoint和project_id需替换
      url = 'https://{{endpoint}}/v1/{{project_id}}/asr/transcriber/jobs/' + job_id
      for _ in range(1000):
          resp = requests.get(url, headers=header)
          print(resp.text)
          if resp.text.find('segments') != -1:
              break
          time.sleep(1)
  if __name__ == '__main__':
      lasr_demo()

• 使用Java语言提交录音文件识别任务

  import java.io.BufferedReader;
  import java.io.InputStream;
  import java.io.InputStreamReader;
  import java.io.OutputStreamWriter;
  import java.net.HttpURLConnection;
  import java.net.URL;
  
  /**
   * 此demo仅供测试使用，强烈建议使用SDK
   */
  public class LasrDemo {
    public void lasrDemo() {
      try {
        // endpoint和projectId需要替换成实际信息。
        URL url = new URL("https://{{endpoint}}/v1/{{project_id}}/asr/transcriber/jobs");
        String token = "对应region的token";
        String obsUrl = "音频在obs的路径";
        HttpURLConnection connection = (HttpURLConnection)url.openConnection();
        connection.setRequestMethod("POST");
        connection.setDoInput(true);
        connection.setDoOutput(true);
        connection.addRequestProperty("Content-Type", "application/json");
        connection.addRequestProperty("X-Auth-Token", token);
  
        OutputStreamWriter osw = new OutputStreamWriter(connection.getOutputStream(), "UTF-8");
        String body = "{\"data_url\":\"" +  obsUrl + "\", \"config\": { \"audio_format\": \"auto\", "
          + "\"property\":\"chinese_8k_general\"}}";
        osw.append(body);
        osw.flush();
        InputStream is = connection.getInputStream();
        BufferedReader br = new BufferedReader(new InputStreamReader(is, "UTF-8"));
        String jobId = "";
        while (br.ready()) {
          String line = br.readLine().trim();
          jobId = line.replace("{\"job_id\":\"", "").replace("\"}", "");
        }
        queryTask(token, jobId);
      } catch (Exception e) {
        e.printStackTrace();
      }
    }
    private void queryTask(String token, String jobId) {
      try {
        // endpoint和projectId需要替换成实际信息。
        URL url = new URL("https://{{endpoint}}/v1/{{project_id}}/asr/transcriber/jobs/" + jobId);
        while (true) {
          HttpURLConnection connection = (HttpURLConnection)url.openConnection();
          connection.setRequestMethod("GET");
          connection.setDoInput(true);
          connection.setDoOutput(true);
          connection.addRequestProperty("Content-Type", "application/json");
          connection.addRequestProperty("X-Auth-Token", token);
  
          InputStream is = connection.getInputStream();
          BufferedReader br = new BufferedReader(new InputStreamReader(is, "UTF-8"));
          if (br.ready()) {
            String line = br.readLine();
            System.out.println(line);
            if (line.contains("segments")) {
              break;
            }
          }
          Thread.sleep(2000);
        }
      } catch (Exception e) {
        e.printStackTrace();
      }
    }
    public static void main(String[] args) {
      LasrDemo lasrDemo = new LasrDemo();
      lasrDemo.lasrDemo();
    }
  }

响应示例

状态码：200

成功响应示例

{
"job_id": "567e6536-a89c-13c3-a882-826321939656"
}

状态码：400

失败响应示例

{
"error_code":"SIS.0002",
"error_msg":"***"
}

状态码

状态码请参见状态码。

错误码

错误码请参见错误码。