
# 录音文件极速版
#### 前提条件
- 确保已按照[配置Java环境](https://support.huaweicloud.com/sdkreference-sis/sis_05_0041.html)配置完毕。
- 确保已存在待识别的音频文件并上传OBS，示例音频可参考下载SDK压缩包文件，同时确保服务已授权访问OBS，可参考[配置OBS服务](https://support.huaweicloud.com/api-sis/sis_03_0047.html)。
- 请参考[SDK（websocket）](https://support.huaweicloud.com/sdkreference-sis/sis_05_0004.html)获取最新版本SDK包。
 
#### 初始化Client
初始化FlashLasrClient，其参数包括AuthInfo和SisConfig。
表1AuthInfo 
| 参数名称      | 是否必选 | 参数类型   | 描述                                                                                     |
|:---|:---|:---|:---|
| ak        | 是    | String | 用户的ak，可参考[AK/SK认证](https://support.huaweicloud.com/sdkreference-sis/sis_05_0003.html)。 |
| sk        | 是    | String | 用户的sk，可参考[AK/SK认证](https://support.huaweicloud.com/sdkreference-sis/sis_05_0003.html)。 |
| region    | 是    | String | 区域，如cn-north-4，参考[终端节点](https://support.huaweicloud.com/api-sis/sis_03_0004.html)。     |
| projectId | 是    | String | 项目ID，同region一一对应，参考[获取项目ID](https://support.huaweicloud.com/api-sis/sis_03_0008.html)。 |
| endpoint  | 否    | String | 终端节点，参考[终端节点](https://support.huaweicloud.com/api-sis/sis_03_0004.html)。一般使用默认即可。      |
   
表2SisConfig 
| 参数名称              | 是否必选 | 参数类型    | 描述                 |
|:---|:---|:---|:---|
| connectionTimeout | 否    | Integer | 连接超时，默认10000，单位ms。 |
| readTimeout       | 否    | Integer | 读取超时，默认10000，单位ms。 |
   
#### 请求参数
请求类为FlashLasrRequest，详见[表3]。
 表3FlashLasrRequest 
| 参数               | 是否必选 | 参数类型   | 描述                                                                                                                                                                                                                                                                                                                                                                                                                                                                            |
|:---|:---|:---|:---|
| audioFormat      | 是    | String | 支持语音的格式，请参考[表4]。                                                                                                                                                                                                                                                                                                                                                                                                                            |
| property         | 是    | String | 所使用的模型特征串，通常是 "语种_采样率_领域"的形式，采样率需要与音频采样率保持一致，取值范围请参考[表5]。                                                                                                                                                                                                                                                                                                                                                                                      |
| addPunc          | 否    | String | 表示是否在识别结果中添加标点，取值为"yes"和"no"，默认为"no"。                                                                                                                                                                                                                                                                                                                                                                                                                                         |
| digitNorm        | 否    | String | 表示是否将语音中的数字识别为阿拉伯数字，取值为"yes" 和 "no"，默认为"yes"。                                                                                                                                                                                                                                                                                                                                                                                                                                 |
| vocabularyId     | 否    | String | 热词表id，不使用则不填写。 创建热词表信息请参考[创建热词表](https://support.huaweicloud.com/api-sis/sis_03_0071.html)。                                                                                                                                                                                                                                                                                                                                                      |
| needWordInfo     | 否    | String | 表示是否在识别结果中输出分词结果信息，取值为"yes"和"no"，默认为"no"。                                                                                                                                                                                                                                                                                                                                                                                                                                     |
| firstChannelOnly | 否    | String | 表示是否在识别中只识别首个声道的音频数据，取值为"yes"和"no"，默认为"no"。                                                                                                                                                                                                                                                                                                                                                                                                                                   |
| obsBucketName    | 否    | String | 表示OBS对象桶名，使用前，请先进行授权，操作方法请参见[配置OBS访问权限](https://support.huaweicloud.com/api-sis/sis_03_0047.html)。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，详见[录音文件识别极速版接口](https://support.huaweicloud.com/api-sis/sis_03_0090.html)。 |
| obsObjectKey     | 否    | 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，详见[录音文件识别极速版接口](https://support.huaweicloud.com/api-sis/sis_03_0090.html)。                                                                                                              |
   
 表4audioFormat 
| audio_format取值  | 描述        |
|:---|:---|
| wav            | wav格式音频     |
| mp3          | mp3格式音频   |
| m4a            | m4a格式音频   |
| aac             | aac格式音频    |
| opus          | opus格式音频。  |
   
 表5property 
| property取值               | 描述                        |
|:---|:---|
| chinese_8k_common        | 支持采样率为8k的中文普通话语音识别。       |
| chinese_16k_conversation | 支持采样率为16k的会议场景的中文普通话语音识别。 |
   
#### 响应参数
响应类为FlashLasrResponse, 详见[表6]。调用失败处理方法请参见[错误码](https://support.huaweicloud.com/api-sis/sis_03_0045.html)。
 表6FlashLasrResponse 
| 参数            | 是否必选 | 参数类型                                                              | 描述                                                                         |
|:---|:---|:---|:---|
| traceId       | 是    | String                                                            | 可用于在日志中追溯具体流程，调用失败无此字段。 在某些错误情况下可能没有此令牌字符串。 |
| audioDuration | 是    | Integer                                                           | 音频时长，单位毫秒。                                                                 |
| flashResult   | 是    | Array of [FlashResult] objects | 调用成功表示识别结果，调用失败时无此字段。                                                      |
   
 表7FlashResult 
| 参数        | 是否必选 | 参数类型                                                            | 描述      |
|:---|:---|:---|:---|
| channelId | 否    | Integer                                                         | 声道Id。   |
| sentences | 否    | Array of [Sentences] objects | 分句信息列表。 |
   
 表8Sentences 
| 参数        | 是否必选 | 参数类型                                              | 描述            |
|:---|:---|:---|:---|
| startTime | 否    | Integer                                           | 一句话开始时间，单位毫秒。 |
| result    | 否    | [Result] object | 分句结果信息。       |
| endTime   | 否    | Integer                                           | 一句话结束时间，单位毫秒。 |
   
 表9Result 
| 参数       | 是否必选 | 参数类型                                                           | 描述                    |
|:---|:---|:---|:---|
| text     | 是    | String                                                         | 调用成功表示识别出的内容。         |
| score    | 是    | Double                                                         | 调用成功表示识别出的置信度（0-1之间）。 |
| wordInfo | 否    | Array of [WordInfo] objects | 分词信息列表。               |
   
 表10WordInfo 
| 参数        | 是否必选 | 参数类型    | 描述    |
|:---|:---|:---|:---|
| startTime | 否    | Integer | 起始时间。 |
| endTime   | 否    | Integer | 结束时间。 |
| word      | 否    | String  | 分词。   |
   
#### 代码示例
如下示例仅供参考，最新代码请前往[SDK（websocket）](https://support.huaweicloud.com/sdkreference-sis/sis_05_0004.html)章节获取并运行。
```
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();
  }
}
```
