更新时间:2024-12-04 GMT+08:00
分享

一句话识别Http接口

前提条件

  • 确保已按照配置Python环境配置完毕,Python SDK仅支持Python3。
  • 确保已存在待识别的音频文件。如果需要请在下载的SDK压缩包中获取示例音频。
  • 请参考SDK(websocket)获取最新版本SDK包。

初始化Client

初始化AsrCustomizationClient详见表 AsrCustomizationClient初始化参数

表1 AsrCustomizationClient初始化参数

参数名称

是否必选

参数类型

描述

ak

String

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

sk

String

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

region

String

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

project_id

String

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

service_endpoint

String

终端节点,一般使用默认即可。

sis_config

Object

详见表2

表2 SisConfig

参数名称

是否必选

参数类型

描述

connect_timeout

Integer

连接超时,默认10,单位s。

read_timeout

Integer

读取超时,默认10,单位s。

proxy

List

[host, port] 或 [host, port, username, password]。

请求参数

请求类为AsrCustomShortRequest,详见表3

表3 AsrCustomShortRequest

参数名称

是否必选

参数类型

描述

data

String

本地音频文件经过Base64编码后的字符串,音频文件时长不超过1min。

audio_format

String

音频格式,具体信息请参见《API参考》中一句话识别章节。

model_property

String

属性字符串,语言_采样率_模型,如chinese_16k_general。具体信息请参见《API参考》中一句话识别章节。

add_punc

String

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

digit_norm

String

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

vocabulary_id

String

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

创建热词表请参考《API参考》中创建热词表章节。

need_word_info

String

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

响应参数

Python SDK响应结果为Json格式,表4。调用失败处理方法请参见错误码

表4 响应结果

参数名称

是否必选

参数类型

描述

result

Object

详见表5

trace_id

String

用于后台日志问题追溯。

表5 Result

参数名称

是否必选

参数类型

描述

text

String

识别结果。

score

Float

识别结果置信度评分。

word_info

Array of objects

分词信息列表。

表6 Word_info 数据结构

参数名

是否必选

参数类型

说明

start_time

Integer

起始时间

end_time

Integer

结束时间

word

String

分词

代码示例

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

# -*- coding: utf-8 -*-
from huaweicloud_sis.client.asr_client import AsrCustomizationClient
from huaweicloud_sis.bean.asr_request import AsrCustomShortRequest
from huaweicloud_sis.exception.exceptions import ClientException
from huaweicloud_sis.exception.exceptions import ServerException
from huaweicloud_sis.utils import io_utils
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
"""
    todo 请正确填写音频格式和模型属性字符串
    1. 音频格式一定要相匹配。
         例如wav音频,格式是wav。具体参考api文档。
         例如音频是pcm格式,并且采样率为8k,则格式填写pcm8k16bit。
         如果返回audio_format is invalid 说明该文件格式不支持。具体支持哪些音频格式,需要参考一些api文档。
    2. 音频采样率要与属性字符串的采样率要匹配。
         例如格式选择pcm16k16bit,属性字符串却选择chinese_8k_common, 则会返回'audio_format' is not match model
         例如wav本身是16k采样率,属性选择chinese_8k_common, 同样会返回'audio_format' is not match model
"""
# 一句话识别参数,以音频文件的base64编码传入,1min以内音频
path = ''                               # 文件位置, 需要具体到文件,如D:/test.wav
path_audio_format = ''                  # 音频格式,如wav等,详见api文档
path_property = 'chinese_16k_general'   # language_sampleRate_domain, 如chinese_16k_general,详见api文档
def sasr_example():
    """ 一句话识别示例 """
    # step1 初始化客户端
    config = SisConfig()
    config.set_connect_timeout(10)  # 设置连接超时
    config.set_read_timeout(10)  # 设置读取超时
    # 设置代理,使用代理前一定要确保代理可用。 代理格式可为[host, port] 或 [host, port, username, password]
    # config.set_proxy(proxy)
    asr_client = AsrCustomizationClient(ak, sk, region, project_id, sis_config=config)
    # step2 构造请求
    data = io_utils.encode_file(path)
    asr_request = AsrCustomShortRequest(path_audio_format, path_property, data)
    # 所有参数均可不设置,使用默认值
    # 设置是否添加标点,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')
    # step3 发送请求,返回结果,返回结果为json格式
    result = asr_client.get_short_response(asr_request)
    # use enterprise_project_Id
    # headers = {'Enterprise-Project-Id': 'your enterprise project id', 'Content-Type': 'application/json'}
    # result = asr_client.get_short_response(asr_request, headers)
    print(json.dumps(result, indent=2, ensure_ascii=False))
if __name__ == '__main__':
    try:
        sasr_example()
    except ClientException as e:
        print(e)
    except ServerException as e:
        print(e)

相关文档