更新时间:2024-10-11 GMT+08:00
分享

录音文件极速版

前提条件

  • 确保已按照配置Java环境配置完毕。
  • 确保已存在待识别的音频文件并上传OBS,示例音频可参考下载SDK压缩包文件,同时确保服务已授权访问OBS,可参考配置OBS服务

初始化Client

初始化FlashLasrClient,其参数包括AuthInfo和SisConfig。

表1 AuthInfo

参数名称

是否必选

参数类型

描述

ak

String

用户的ak,可参考AK/SK认证

sk

String

用户的sk,可参考AK/SK认证

region

String

区域,如cn-north-4,参考终端节点

projectId

String

项目ID,同region一一对应,参考获取项目ID

endpoint

String

终端节点,参考地区和终端节点。一般使用默认即可。

表2 SisConfig

参数名称

是否必选

参数类型

描述

connectionTimeout

Integer

连接超时,默认10000,单位ms。

readTimeout

Integer

读取超时,默认10000,单位ms。

请求参数

请求类为FlashLasrRequest,详见表3

表3 FlashLasrRequest

参数

是否必选

参数类型

描述

audio_format

String

支持语音的格式,请参考表4

property

String

所使用的模型特征串,通常是 “语种_采样率_领域”的形式,采样率需要与音频采样率保持一致,取值范围请参考表5

add_punc

String

表示是否在识别结果中添加标点,取值为“yes”“no”,默认为“no”

digit_norm

String

表示是否将语音中的数字识别为阿拉伯数字,取值为“yes”“no”,默认为“yes”

vocabulary_id

String

热词表id,不使用则不填写。

创建热词表信息请参考创建热词表

need_word_info

String

表示是否在识别结果中输出分词结果信息,取值为“yes”“no”,默认为“no”

first_channel_only

String

表示是否在识别中只识别首个声道的音频数据,取值为“yes”“no”,默认为“no”

obs_bucket_name

String

表示在OBS对象桶名,使用前请先授权,操作方法请参见配置OBS访问权限。obs_bucket_name长度大于等于3个字符,小于64个字符,不需要进行urlencode编码,如果包含中文,直接输入中文即可。

示例

obs url为https://test.obs.cn-north-4.myhuaweicloud.com/data/0601/test.wav

则obs_bucket_name=test,obs_bucket_key=data/0601/test.wav

obs_object_key

String

表示OBS对象桶中的对象的键值,长度小于1024个字符,不需要进行urlencode编码,如果包含中文,直接输入中文即可。

示例

obs url为https://test.obs.cn-north-4.myhuaweicloud.com/data/0601/test.wav

则obs_bucket_name=test,obs_bucket_key=data/0601/test.wav

表4 audio_format

audio_format取值

描述

wav

wav格式音频

mp3

mp3格式音频

m4a

m4a格式音频

aac

aac格式音频

opus

ops格式音频。

表5 property

property取值

描述

chinese_8k_common

支持采样率为8k的中文普通话语音识别。

chinese_16k_conversation

支持采样率为16k的会议场景的中文普通话语音识别。

响应参数

响应类为FlashLasrResponse, 详见表6。调用失败处理方法请参见错误码

表6 FlashLasrResponse

参数

是否必选

参数类型

描述

trace_id

String

可用于在日志中追溯具体流程,调用失败无此字段。

在某些错误情况下可能没有此令牌字符串。

audio_duration

Integer

音频时长,单位毫秒

flash_result

Array of FlashResult objects

调用成功表示识别结果,调用失败时无此字段。

表7 FlashResult

参数

是否必选

参数类型

描述

channel_id

Integer

声道Id

sentences

Array of Sentences objects

分句信息列表

表8 Sentences

参数

是否必选

参数类型

描述

start_time

Integer

一句话开始时间,单位毫秒

result

Result object

分句结果信息

end_time

Integer

一句话结束时间,单位毫秒

表9 Result

参数

是否必选

参数类型

描述

text

String

调用成功表示识别出的内容。

score

Double

调用成功表示识别出的置信度(0-1之间)。

word_info

Array of WordInfo objects

分词信息列表

表10 WordInfo

参数

是否必选

参数类型

描述

start_time

Integer

起始时间

end_time

Integer

结束时间

word

String

分词

代码示例

如下示例仅供参考,最新代码请前往SDK(websocket)章节获取并运行。

import com.huawei.sis.bean.AuthInfo;
import com.huawei.sis.bean.SisConfig;
import com.huawei.sis.bean.SisConstant;
import com.huawei.sis.bean.request.FlashLasrRequest;
import com.huawei.sis.bean.response.FlashLasrResponse;
import com.huawei.sis.client.FlashLasrClient;
import com.huawei.sis.exception.SisException;
import com.huawei.sis.util.JsonUtils;

/**
 * 录音文件极速版Demo
 *
 * Copyright 2021 Huawei Technologies Co.,Ltd.
 */
public class FlashLasrDemo {
  // 认证用的ak和sk硬编码到代码中或者明文存储都有很大的安全风险,建议在配置文件或者环境变量中密文存放,使用时解密,确保安全;
  // 本示例以ak和sk保存在环境变量中来实现身份验证为例,运行本示例前请先在本地环境中设置环境变量HUAWEICLOUD_SDK_AK和HUAWEICLOUD_SDK_SK。
  private String ak = System.getenv("HUAWEICLOUD_SDK_AK");
  private String sk = System.getenv("HUAWEICLOUD_SDK_SK");


  private String region = "";    // 区域,如cn-north-1、cn-north-4
  private String projectId = ""; // 项目id,在我的凭证查看。参考https://support.huaweicloud.com/api-sis/sis_03_0008.html

  private String obsBucketName = "";      // obs桶名
  private String obsObjectKey = "";       // obs对象的key
  private String audioFormat = "";        // 文件格式,如wav等, 支持格式详见api文档
  private String property = "";           // 属性字符串,language_sampleRate_domain, 如chinese_8k_common, 详见api文档


  /**
   * 设置录音文件识别极速版参数
   *
   * @param request 录音文件极速版请求
   */
  private void setShortParameter(FlashLasrRequest request) {
    // 以下参数必选
    // 设置桶名,必选
    request.setObsBucketName(obsBucketName);
    // 设置桶内对象名,必选
    request.setObsObjectKey(obsObjectKey);
    // 设置格式,必选
    request.setAudioFormat(audioFormat);
    // 设置属性,必选
    request.setProperty(property);

    // 以下参数可选
    // 设置是否添加标点,默认是no
    request.setAddPunc("yes");
    // 设置热词id,详见api文档,若热词id不存在,则会报错
//     request.setVocabularyId("");
    // 设置是否将音频中数字转写为阿拉伯数字,yes or no,默认yes
    request.setDigitNorm("no");
    // 设置是否需要word_info,yes or no, 默认no
    request.setNeedWordInfo("no");
    // 设置是否只识别首个声道的音频数据,默认no
    request.setFirstChannelOnly("no");
  }

  /**
   * 定义config,所有参数可选,设置超时时间等。
   *
   * @return SisConfig
   */
  private SisConfig getConfig() {
    SisConfig config = new SisConfig();
    // 设置连接超时,默认10000ms
    config.setConnectionTimeout(SisConstant.DEFAULT_CONNECTION_TIMEOUT);
    // 设置读取超时,默认10000ms
    config.setReadTimeout(SisConstant.DEFAULT_READ_TIMEOUT);
    // 设置代理, 一定要确保代理可用才启动此设置。 代理初始化也可用不加密的代理,new ProxyHostInfo(host, port);
    // ProxyHostInfo proxy = new ProxyHostInfo(host, port, username, password);
    // config.setProxy(proxy);
    return config;
  }

  /**
   * 录音文件极速版demo。
   */
  private void flashLasrDemo() {
    try {

      // 1. 初始化FlashLasrClient
      // 定义authInfo,根据ak,sk,region,projectId
      AuthInfo authInfo = new AuthInfo(ak, sk, region, projectId);
      // 设置config,主要与超时有关
      SisConfig config = getConfig();
      // 根据authInfo和config,构造FlashLasrClient
      FlashLasrClient flashLasrClient = new FlashLasrClient(authInfo, config);

      // 2. 配置请求
      FlashLasrRequest request = new FlashLasrRequest();
      setShortParameter(request);

      // 3. 发送请求,获取响应。具体结果可通过response.getXX获取。
      FlashLasrResponse response = flashLasrClient.getFlashLasrResponse(request);
       // 设置企业id, 可选
      // Map<String, String> headers = OKHttpClientUtils.getJsonHeaders();
      // headers.put(SisConstant.ENTERPRISE_PROJECT_ID_KEY, "your enterprise_id");
      System.out.println(JsonUtils.obj2Str(response, true));
    } catch (SisException e) {
      e.printStackTrace();
      System.out.println("error_code:" + e.getErrorCode() + "\nerror_msg:" + e.getErrorMsg());
    }
  }


  public static void main(String[] args) {
    FlashLasrDemo demo = new FlashLasrDemo();
    demo.flashLasrDemo();
  }
}

相关文档