
# 录音文件极速版
#### 前提条件
- 确保已按照[配置Python环境](https://support.huaweicloud.com/sdkreference-sis/sis_05_0056.html)配置完毕，Python SDK仅支持Python3。
- 确保已存在待识别的音频文件。如果需要请在下载的SDK压缩包中获取示例音频。
- 请参考[SDK（websocket）](https://support.huaweicloud.com/sdkreference-sis/sis_05_0004.html)获取最新版本SDK包。
 
#### 初始化Client
初始化FlashLasrClient详见[表 FlashLasrClient初始化参数]。
 表1FlashLasrClient初始化参数 
| 参数名称             | 是否必选 | 参数类型   | 描述                                                                                     |
|:---|:---|:---|:---|
| 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)。     |
| project_id       | 是    | String | 项目ID，同region一一对应，参考[获取项目ID](https://support.huaweicloud.com/api-sis/sis_03_0008.html)。 |
| service_endpoint | 否    | String | 终端节点，一般使用默认即可。                                                                         |
| sis_config       | 否    | Object | 详见[表2]。                                             |
   
 表2SisConfig 
| 参数名称            | 是否必选 | 参数类型    | 描述                                                   |
|:---|:---|:---|:---|
| connect_timeout | 否    | Integer | 连接超时，默认10，单位s。                                       |
| read_timeout    | 否    | Integer | 读取超时，默认10，单位s。                                       |
| proxy           | 否    | List    | \[host, port\] 或 \[host, port, username, password\]。 |
   
#### 请求参数
请求类为FlashLasrRequest，详见[表3]。
 表3FlashLasrRequest 
| 参数                 | 是否必选 | 参数类型   | 描述                                                                                                                                                                                                                                                                                                                                                                                                                                                                            |
|:---|:---|:---|:---|
| audio_format       | 是    | String | 支持语音的格式，请参考[表 audio_format取值范围]。                                                                                                                                                                                                                                                                                                                                                                                                            |
| property           | 是    | String | 所使用的模型特征串，通常是 "语种_采样率_领域"的形式，采样率需要与音频采样率保持一致，取值范围请参考[表 property取值范围]。                                                                                                                                                                                                                                                                                                                                                                          |
| add_punc           | 否    | String | 表示是否在识别结果中添加标点，取值为"yes"和"no"，默认为"no"。                                                                                                                                                                                                                                                                                                                                                                                                                                         |
| digit_norm         | 否    | String | 表示是否将语音中的数字识别为阿拉伯数字，取值为"yes" 和 "no"，默认为"yes"。                                                                                                                                                                                                                                                                                                                                                                                                                                 |
| vocabulary_id      | 否    | String | 热词表id，不使用则不填写。 创建热词表信息请参考[创建热词表](https://support.huaweicloud.com/api-sis/sis_03_0071.html)。                                                                                                                                                                                                                                                                                                                                                      |
| need_word_info     | 否    | String | 表示是否在识别结果中输出分词结果信息，取值为"yes"和"no"，默认为"no"。                                                                                                                                                                                                                                                                                                                                                                                                                                     |
| first_channel_only | 否    | String | 表示是否在识别中只识别首个声道的音频数据，取值为"yes"和"no"，默认为"no"。                                                                                                                                                                                                                                                                                                                                                                                                                                   |
| obs_bucket_name    | 否    | 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)。 |
| 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，详见[录音文件识别极速版接口](https://support.huaweicloud.com/api-sis/sis_03_0090.html)。                                                                                                              |
   
 表4audio_format取值范围 
| 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 
| 参数             | 是否必选 | 参数类型                                                              | 描述                                                                                 |
|:---|:---|:---|:---|
| trace_id       | 是    | String                                                            | 服务内部的令牌，可用于在日志中追溯具体流程，调用失败无此字段。 在某些错误情况下可能没有此令牌字符串。 |
| audio_duration | 是    | Integer                                                           | 音频时长，单位毫秒                                                                          |
| flash_result   | 是    | Array of [FlashResult] objects | 调用成功表示识别结果，调用失败时无此字段。                                                              |
   
 表7FlashResult 
| 参数         | 是否必选 | 参数类型                                                            | 描述     |
|:---|:---|:---|:---|
| channel_id | 否    | Integer                                                         | 声道Id   |
| sentences  | 否    | Array of [Sentences] objects | 分句信息列表 |
   
 表8Sentences 
| 参数         | 是否必选 | 参数类型                                              | 描述           |
|:---|:---|:---|:---|
| start_time | 否    | Integer                                           | 一句话开始时间，单位毫秒 |
| result     | 否    | [Result] object | 分句结果信息       |
| end_time   | 否    | Integer                                           | 一句话结束时间，单位毫秒 |
   
 表9Result 
| 参数        | 是否必选 | 参数类型                                                           | 描述                    |
|:---|:---|:---|:---|
| text      | 是    | String                                                         | 调用成功表示识别出的内容。         |
| score     | 是    | Double                                                         | 调用成功表示识别出的置信度（0-1之间）。 |
| word_info | 否    | Array of [WordInfo] objects | 分词信息列表                |
   
 表10WordInfo 
| 参数         | 是否必选 | 参数类型    | 描述   |
|:---|:---|:---|:---|
| start_time | 否    | Integer | 起始时间 |
| end_time   | 否    | Integer | 结束时间 |
| word       | 否    | String  | 分词   |
   
#### 代码示例
如下示例仅供参考，最新代码请前往[SDK（websocket）](https://support.huaweicloud.com/sdkreference-sis/sis_05_0004.html)章节获取并运行。
```
# -*- coding: utf-8 -*-
from huaweicloud_sis.client.flash_lasr_client import FlashLasrClient
from huaweicloud_sis.bean.flash_lasr_request import FlashLasrRequest
from huaweicloud_sis.exception.exceptions import ClientException
from huaweicloud_sis.exception.exceptions import ServerException
from huaweicloud_sis.bean.sis_config import SisConfig
import json
import os
# 鉴权参数
# 认证用的ak和sk硬编码到代码中或者明文存储都有很大的安全风险，建议在配置文件或者环境变量中密文存放，使用时解密，确保安全；
# 本示例以ak和sk保存在环境变量中来实现身份验证为例，运行本示例前请先在本地环境中设置环境变量HUAWEICLOUD_SIS_AK/HUAWEICLOUD_SIS_SK
ak = os.getenv("HUAWEICLOUD_SIS_AK")             # 从环境变量获取ak 参考https://support.huaweicloud.com/sdkreference-sis/sis_05_0003.html
assert ak is not None, "Please add ak in your develop environment"
sk = os.getenv("HUAWEICLOUD_SIS_SK")             # 从环境变量获取sk 参考https://support.huaweicloud.com/sdkreference-sis/sis_05_0003.html
assert sk is not None, "Please add sk in your develop environment"
project_id = ""     # project id 同region一一对应，参考https://support.huaweicloud.com/api-sis/sis_03_0008.html
region = ''         # region，如cn-north-4
obs_bucket_name = ''    # obs桶名
obs_object_key = ''     # obs对象的key
audio_format = ''       # 文件格式，如wav等， 支持格式详见api文档
property = ''           # 属性字符串，language_sampleRate_domain, 如chinese_8k_common, 详见api文档
def flash_lasr_example():
    """ 录音文件极速版示例 """
    # step1 初始化客户端
    config = SisConfig()
    config.set_connect_timeout(10)  # 设置连接超时
    config.set_read_timeout(10)  # 设置读取超时
    # 设置代理，使用代理前一定要确保代理可用。 代理格式可为[host, port] 或 [host, port, username, password]
    # config.set_proxy(proxy)
    client = FlashLasrClient(ak, sk, region, project_id, sis_config=config)
    # step2 构造请求
    asr_request = FlashLasrRequest()
    # 以下参数必选
    # 设置存放音频的桶名，必选
    asr_request.set_obs_bucket_name(obs_bucket_name)
    # 设置桶内音频对象名，必选
    asr_request.set_obs_object_key(obs_object_key)
    # 设置格式，必选
    asr_request.set_audio_format(audio_format)
    # 设置属性，必选
    asr_request.set_property(property)
    # 以下参数可选
    # 设置是否添加标点，yes or no，默认no
    asr_request.set_add_punc('yes')
    # 设置是否将语音中数字转写为阿拉伯数字，yes or no，默认yes
    asr_request.set_digit_norm('yes')
    # 设置是否添加热词表id，没有则不填
    # asr_request.set_vocabulary_id(None)
    # 设置是否需要word_info，yes or no, 默认no
    asr_request.set_need_word_info('no')
    # 设置是否只识别首个声道的音频数据，默认no
    asr_request.set_first_channel_only('no')
    # step3 发送请求，返回结果,返回结果为json格式
    result = client.get_flash_lasr_result(asr_request)
    # use enterprise_project_Id
    # headers = {'Enterprise-Project-Id': 'your enterprise project id', 'Content-Type': 'application/json'}
    # result = client.get_flash_lasr_result(asr_request, headers)
    print(json.dumps(result, indent=2, ensure_ascii=False))
if __name__ == '__main__':
    try:
        flash_lasr_example()
    except ClientException as e:
        print(e)
    except ServerException as e:
        print(e)
```
