# frozen_string_literal: true
# Copyright (c) 2017-2018 THL A29 Limited, a Tencent company. All Rights Reserved.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
require 'json'
module TencentCloud
module Asr
module V20190614
class Client < TencentCloud::Common::AbstractClient
def initialize(credential, region, profile = nil)
api_version = '2019-06-14'
api_endpoint = 'asr.tencentcloudapi.com'
sdk_version = 'ASR_' + File.read(File.expand_path('../VERSION', __dir__)).strip
super(credential, region, api_version, api_endpoint, sdk_version, profile)
end
# 本接口用于关闭语音流异步识别任务。
# @param request: Request instance for CloseAsyncRecognitionTask.
# @type request: :class:`Tencentcloud::asr::V20190614::CloseAsyncRecognitionTaskRequest`
# @rtype: :class:`Tencentcloud::asr::V20190614::CloseAsyncRecognitionTaskResponse`
def CloseAsyncRecognitionTask(request)
body = send_request('CloseAsyncRecognitionTask', request.serialize)
response = JSON.parse(body)
if response['Response'].key?('Error') == false
model = CloseAsyncRecognitionTaskResponse.new
model.deserialize(response['Response'])
model
else
code = response['Response']['Error']['Code']
message = response['Response']['Error']['Message']
reqid = response['Response']['RequestId']
raise TencentCloud::Common::TencentCloudSDKException.new(code, message, reqid)
end
rescue TencentCloud::Common::TencentCloudSDKException => e
raise e
rescue StandardError => e
raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
end
# 用户通过本接口进行热词表的创建。
#
• 默认最多可创建30个热词表。
#
• 每个热词表最多可添加128个词,每个词最长10个字,不能超出限制。
#
• 热词表可以通过数组或者本地文件形式上传。
#
• 本地文件必须为UTF-8编码格式,每行仅添加一个热词且不能包含标点和特殊字符。
#
• 热词权重取值范围为[1,10]之间的整数,权重越大代表该词被识别出来的概率越大。
# @param request: Request instance for CreateAsrVocab.
# @type request: :class:`Tencentcloud::asr::V20190614::CreateAsrVocabRequest`
# @rtype: :class:`Tencentcloud::asr::V20190614::CreateAsrVocabResponse`
def CreateAsrVocab(request)
body = send_request('CreateAsrVocab', request.serialize)
response = JSON.parse(body)
if response['Response'].key?('Error') == false
model = CreateAsrVocabResponse.new
model.deserialize(response['Response'])
model
else
code = response['Response']['Error']['Code']
message = response['Response']['Error']['Message']
reqid = response['Response']['RequestId']
raise TencentCloud::Common::TencentCloudSDKException.new(code, message, reqid)
end
rescue TencentCloud::Common::TencentCloudSDKException => e
raise e
rescue StandardError => e
raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
end
# 本接口用于对语音流进行准实时识别,通过异步回调来返回识别结果。适用于直播审核等场景。
#
• 支持rtmp、rtsp等流媒体协议,以及各类基于http协议的直播流(不支持hls)
#
• 音频流时长无限制,服务会自动拉取音频流数据,若连续10分钟拉不到流数据时,服务会终止识别任务
#
• 服务通过回调的方式来提供识别结果,用户需要提供CallbackUrl。回调时机为一小段话(最长15秒)回调一次。
#
• 签名方法参考 [公共参数](https://cloud.tencent.com/document/api/1093/35640) 中签名方法v3。
#
• 默认单账号限制并发数为20路,如您有提高并发限制的需求,请提[工单](https://console.cloud.tencent.com/workorder/category)进行咨询。
# @param request: Request instance for CreateAsyncRecognitionTask.
# @type request: :class:`Tencentcloud::asr::V20190614::CreateAsyncRecognitionTaskRequest`
# @rtype: :class:`Tencentcloud::asr::V20190614::CreateAsyncRecognitionTaskResponse`
def CreateAsyncRecognitionTask(request)
body = send_request('CreateAsyncRecognitionTask', request.serialize)
response = JSON.parse(body)
if response['Response'].key?('Error') == false
model = CreateAsyncRecognitionTaskResponse.new
model.deserialize(response['Response'])
model
else
code = response['Response']['Error']['Code']
message = response['Response']['Error']['Message']
reqid = response['Response']['RequestId']
raise TencentCloud::Common::TencentCloudSDKException.new(code, message, reqid)
end
rescue TencentCloud::Common::TencentCloudSDKException => e
raise e
rescue StandardError => e
raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
end
# 用户使用该接口可以创建自学习模型,以供识别调用。
# 注意:调用该接口后,模型会自动训练。新建模型成功后,调用ModifyCustomizationState接口修改为上线状态,即可在识别请求中使用对应模型ID。
# @param request: Request instance for CreateCustomization.
# @type request: :class:`Tencentcloud::asr::V20190614::CreateCustomizationRequest`
# @rtype: :class:`Tencentcloud::asr::V20190614::CreateCustomizationResponse`
def CreateCustomization(request)
body = send_request('CreateCustomization', request.serialize)
response = JSON.parse(body)
if response['Response'].key?('Error') == false
model = CreateCustomizationResponse.new
model.deserialize(response['Response'])
model
else
code = response['Response']['Error']['Code']
message = response['Response']['Error']['Message']
reqid = response['Response']['RequestId']
raise TencentCloud::Common::TencentCloudSDKException.new(code, message, reqid)
end
rescue TencentCloud::Common::TencentCloudSDKException => e
raise e
rescue StandardError => e
raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
end
# 本接口服务对时长5小时以内的录音文件进行识别,异步返回识别全部结果。
# • 支持中文普通话、英语、粤语、日语、上海话、四川话、武汉话、贵阳话、昆明话、西安话、郑州话、太原话、兰州话、银川话、西宁话、南京话、合肥话、南昌话、长沙话、苏州话、杭州话、济南话、天津话、石家庄话、黑龙江话、吉林话、辽宁话。
# • 支持wav、mp3、m4a、flv、mp4、wma、3gp、amr、aac、ogg-opus、flac格式。
# • 支持语音 URL 和本地语音文件两种请求方式。语音 URL 的音频时长不能长于5小时,文件大小不超过1GB。本地语音文件调用不能大于5MB。
# • 提交录音文件识别请求后,在3小时内完成识别(大多数情况下1小时音频约3分钟以内完成识别,半小时内发送超过1000小时录音或者2万条识别任务的除外),识别结果在服务端可保存7天。
# • 支持回调或轮询的方式获取结果,结果获取请参考[ 录音文件识别结果查询](https://cloud.tencent.com/document/product/1093/37822)。
# • 生成字幕场景可设置参数ResTextFormat为3,解析ResultDetail结构生成字幕,可参考 [生成字幕最佳实践](https://cloud.tencent.com/document/product/1093/84291)。
# • 签名方法参考 [公共参数](https://cloud.tencent.com/document/api/1093/35640) 中签名方法v3。
# • 默认接口请求频率限制:20次/秒,如您有提高请求频率限制的需求,请提[工单](https://console.cloud.tencent.com/workorder/category)进行咨询。
# @param request: Request instance for CreateRecTask.
# @type request: :class:`Tencentcloud::asr::V20190614::CreateRecTaskRequest`
# @rtype: :class:`Tencentcloud::asr::V20190614::CreateRecTaskResponse`
def CreateRecTask(request)
body = send_request('CreateRecTask', request.serialize)
response = JSON.parse(body)
if response['Response'].key?('Error') == false
model = CreateRecTaskResponse.new
model.deserialize(response['Response'])
model
else
code = response['Response']['Error']['Code']
message = response['Response']['Error']['Message']
reqid = response['Response']['RequestId']
raise TencentCloud::Common::TencentCloudSDKException.new(code, message, reqid)
end
rescue TencentCloud::Common::TencentCloudSDKException => e
raise e
rescue StandardError => e
raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
end
# 用户通过本接口进行热词表的删除。
# @param request: Request instance for DeleteAsrVocab.
# @type request: :class:`Tencentcloud::asr::V20190614::DeleteAsrVocabRequest`
# @rtype: :class:`Tencentcloud::asr::V20190614::DeleteAsrVocabResponse`
def DeleteAsrVocab(request)
body = send_request('DeleteAsrVocab', request.serialize)
response = JSON.parse(body)
if response['Response'].key?('Error') == false
model = DeleteAsrVocabResponse.new
model.deserialize(response['Response'])
model
else
code = response['Response']['Error']['Code']
message = response['Response']['Error']['Message']
reqid = response['Response']['RequestId']
raise TencentCloud::Common::TencentCloudSDKException.new(code, message, reqid)
end
rescue TencentCloud::Common::TencentCloudSDKException => e
raise e
rescue StandardError => e
raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
end
# 用户通过该接口可以删除自学习模型
# @param request: Request instance for DeleteCustomization.
# @type request: :class:`Tencentcloud::asr::V20190614::DeleteCustomizationRequest`
# @rtype: :class:`Tencentcloud::asr::V20190614::DeleteCustomizationResponse`
def DeleteCustomization(request)
body = send_request('DeleteCustomization', request.serialize)
response = JSON.parse(body)
if response['Response'].key?('Error') == false
model = DeleteCustomizationResponse.new
model.deserialize(response['Response'])
model
else
code = response['Response']['Error']['Code']
message = response['Response']['Error']['Message']
reqid = response['Response']['RequestId']
raise TencentCloud::Common::TencentCloudSDKException.new(code, message, reqid)
end
rescue TencentCloud::Common::TencentCloudSDKException => e
raise e
rescue StandardError => e
raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
end
# 本接口用于查询当前在运行的语音流异步识别任务列表。
#
• 签名方法参考 [公共参数](https://cloud.tencent.com/document/api/1093/35640) 中签名方法v3。
# @param request: Request instance for DescribeAsyncRecognitionTasks.
# @type request: :class:`Tencentcloud::asr::V20190614::DescribeAsyncRecognitionTasksRequest`
# @rtype: :class:`Tencentcloud::asr::V20190614::DescribeAsyncRecognitionTasksResponse`
def DescribeAsyncRecognitionTasks(request)
body = send_request('DescribeAsyncRecognitionTasks', request.serialize)
response = JSON.parse(body)
if response['Response'].key?('Error') == false
model = DescribeAsyncRecognitionTasksResponse.new
model.deserialize(response['Response'])
model
else
code = response['Response']['Error']['Code']
message = response['Response']['Error']['Message']
reqid = response['Response']['RequestId']
raise TencentCloud::Common::TencentCloudSDKException.new(code, message, reqid)
end
rescue TencentCloud::Common::TencentCloudSDKException => e
raise e
rescue StandardError => e
raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
end
# 在调用录音文件识别请求接口后,有回调和轮询两种方式获取识别结果。
#
• 当采用回调方式时,识别完成后会将结果通过 POST 请求的形式通知到用户在请求时填写的回调 URL,具体请参见[ 录音识别结果回调 ](https://cloud.tencent.com/document/product/1093/52632)。
#
• 当采用轮询方式时,需要主动提交任务ID来轮询识别结果,共有任务成功、等待、执行中和失败四种结果,具体信息请参见下文说明。
#
• 请求方法为 HTTP POST , Content-Type为"application/json; charset=utf-8"
#
• 签名方法参考 [公共参数](https://cloud.tencent.com/document/api/1093/35640) 中签名方法v3。
#
• 默认接口请求频率限制:50次/秒,如您有提高请求频率限制的需求,请提[工单](https://console.cloud.tencent.com/workorder/category)进行咨询。
# @param request: Request instance for DescribeTaskStatus.
# @type request: :class:`Tencentcloud::asr::V20190614::DescribeTaskStatusRequest`
# @rtype: :class:`Tencentcloud::asr::V20190614::DescribeTaskStatusResponse`
def DescribeTaskStatus(request)
body = send_request('DescribeTaskStatus', request.serialize)
response = JSON.parse(body)
if response['Response'].key?('Error') == false
model = DescribeTaskStatusResponse.new
model.deserialize(response['Response'])
model
else
code = response['Response']['Error']['Code']
message = response['Response']['Error']['Message']
reqid = response['Response']['RequestId']
raise TencentCloud::Common::TencentCloudSDKException.new(code, message, reqid)
end
rescue TencentCloud::Common::TencentCloudSDKException => e
raise e
rescue StandardError => e
raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
end
# 用户通过本接口进行热词表的下载,获得词表权重文件形式的 base64 值,文件形式为通过 “|” 分割的词和权重,即 word|weight 的形式。
# @param request: Request instance for DownloadAsrVocab.
# @type request: :class:`Tencentcloud::asr::V20190614::DownloadAsrVocabRequest`
# @rtype: :class:`Tencentcloud::asr::V20190614::DownloadAsrVocabResponse`
def DownloadAsrVocab(request)
body = send_request('DownloadAsrVocab', request.serialize)
response = JSON.parse(body)
if response['Response'].key?('Error') == false
model = DownloadAsrVocabResponse.new
model.deserialize(response['Response'])
model
else
code = response['Response']['Error']['Code']
message = response['Response']['Error']['Message']
reqid = response['Response']['RequestId']
raise TencentCloud::Common::TencentCloudSDKException.new(code, message, reqid)
end
rescue TencentCloud::Common::TencentCloudSDKException => e
raise e
rescue StandardError => e
raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
end
# 用户通过该接口可以下载自学习模型的语料
# @param request: Request instance for DownloadCustomization.
# @type request: :class:`Tencentcloud::asr::V20190614::DownloadCustomizationRequest`
# @rtype: :class:`Tencentcloud::asr::V20190614::DownloadCustomizationResponse`
def DownloadCustomization(request)
body = send_request('DownloadCustomization', request.serialize)
response = JSON.parse(body)
if response['Response'].key?('Error') == false
model = DownloadCustomizationResponse.new
model.deserialize(response['Response'])
model
else
code = response['Response']['Error']['Code']
message = response['Response']['Error']['Message']
reqid = response['Response']['RequestId']
raise TencentCloud::Common::TencentCloudSDKException.new(code, message, reqid)
end
rescue TencentCloud::Common::TencentCloudSDKException => e
raise e
rescue StandardError => e
raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
end
# 用户根据词表的ID可以获取对应的热词表信息
# @param request: Request instance for GetAsrVocab.
# @type request: :class:`Tencentcloud::asr::V20190614::GetAsrVocabRequest`
# @rtype: :class:`Tencentcloud::asr::V20190614::GetAsrVocabResponse`
def GetAsrVocab(request)
body = send_request('GetAsrVocab', request.serialize)
response = JSON.parse(body)
if response['Response'].key?('Error') == false
model = GetAsrVocabResponse.new
model.deserialize(response['Response'])
model
else
code = response['Response']['Error']['Code']
message = response['Response']['Error']['Message']
reqid = response['Response']['RequestId']
raise TencentCloud::Common::TencentCloudSDKException.new(code, message, reqid)
end
rescue TencentCloud::Common::TencentCloudSDKException => e
raise e
rescue StandardError => e
raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
end
# 用户通过该接口,可获得所有的热词表及其信息。
# @param request: Request instance for GetAsrVocabList.
# @type request: :class:`Tencentcloud::asr::V20190614::GetAsrVocabListRequest`
# @rtype: :class:`Tencentcloud::asr::V20190614::GetAsrVocabListResponse`
def GetAsrVocabList(request)
body = send_request('GetAsrVocabList', request.serialize)
response = JSON.parse(body)
if response['Response'].key?('Error') == false
model = GetAsrVocabListResponse.new
model.deserialize(response['Response'])
model
else
code = response['Response']['Error']['Code']
message = response['Response']['Error']['Message']
reqid = response['Response']['RequestId']
raise TencentCloud::Common::TencentCloudSDKException.new(code, message, reqid)
end
rescue TencentCloud::Common::TencentCloudSDKException => e
raise e
rescue StandardError => e
raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
end
# 查询自学习模型列表
# @param request: Request instance for GetCustomizationList.
# @type request: :class:`Tencentcloud::asr::V20190614::GetCustomizationListRequest`
# @rtype: :class:`Tencentcloud::asr::V20190614::GetCustomizationListResponse`
def GetCustomizationList(request)
body = send_request('GetCustomizationList', request.serialize)
response = JSON.parse(body)
if response['Response'].key?('Error') == false
model = GetCustomizationListResponse.new
model.deserialize(response['Response'])
model
else
code = response['Response']['Error']['Code']
message = response['Response']['Error']['Message']
reqid = response['Response']['RequestId']
raise TencentCloud::Common::TencentCloudSDKException.new(code, message, reqid)
end
rescue TencentCloud::Common::TencentCloudSDKException => e
raise e
rescue StandardError => e
raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
end
# 用户通过该接口可以更新自学习模型,如模型名称、模型类型、模型语料。
# @param request: Request instance for ModifyCustomization.
# @type request: :class:`Tencentcloud::asr::V20190614::ModifyCustomizationRequest`
# @rtype: :class:`Tencentcloud::asr::V20190614::ModifyCustomizationResponse`
def ModifyCustomization(request)
body = send_request('ModifyCustomization', request.serialize)
response = JSON.parse(body)
if response['Response'].key?('Error') == false
model = ModifyCustomizationResponse.new
model.deserialize(response['Response'])
model
else
code = response['Response']['Error']['Code']
message = response['Response']['Error']['Message']
reqid = response['Response']['RequestId']
raise TencentCloud::Common::TencentCloudSDKException.new(code, message, reqid)
end
rescue TencentCloud::Common::TencentCloudSDKException => e
raise e
rescue StandardError => e
raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
end
# 通过该接口,用户可以修改自学习模型状态,上下线自学习模型
# @param request: Request instance for ModifyCustomizationState.
# @type request: :class:`Tencentcloud::asr::V20190614::ModifyCustomizationStateRequest`
# @rtype: :class:`Tencentcloud::asr::V20190614::ModifyCustomizationStateResponse`
def ModifyCustomizationState(request)
body = send_request('ModifyCustomizationState', request.serialize)
response = JSON.parse(body)
if response['Response'].key?('Error') == false
model = ModifyCustomizationStateResponse.new
model.deserialize(response['Response'])
model
else
code = response['Response']['Error']['Code']
message = response['Response']['Error']['Message']
reqid = response['Response']['RequestId']
raise TencentCloud::Common::TencentCloudSDKException.new(code, message, reqid)
end
rescue TencentCloud::Common::TencentCloudSDKException => e
raise e
rescue StandardError => e
raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
end
# 本接口用于对60秒之内的短音频文件进行识别。
• 支持中文普通话、英语、粤语、日语、上海话、四川话、武汉话、贵阳话、昆明话、西安话、郑州话、太原话、兰州话、银川话、西宁话、南京话、合肥话、南昌话、长沙话、苏州话、杭州话、济南话、天津话、石家庄话、黑龙江话、吉林话、辽宁话。
• 支持本地语音文件上传和语音URL上传两种请求方式,音频时长不能超过60s,音频文件大小不能超过3MB。
• 音频格式支持wav、pcm、ogg-opus、speex、silk、mp3、m4a、aac。
• 请求方法为 HTTP POST , Content-Type为"application/json; charset=utf-8"
• 签名方法参考 [公共参数](https://cloud.tencent.com/document/api/1093/35640) 中签名方法v3。
• 默认接口请求频率限制:25次/秒,如您有提高请求频率限制的需求,请提[工单](https://console.cloud.tencent.com/workorder/category)进行咨询。
# @param request: Request instance for SentenceRecognition.
# @type request: :class:`Tencentcloud::asr::V20190614::SentenceRecognitionRequest`
# @rtype: :class:`Tencentcloud::asr::V20190614::SentenceRecognitionResponse`
def SentenceRecognition(request)
body = send_request('SentenceRecognition', request.serialize)
response = JSON.parse(body)
if response['Response'].key?('Error') == false
model = SentenceRecognitionResponse.new
model.deserialize(response['Response'])
model
else
code = response['Response']['Error']['Code']
message = response['Response']['Error']['Message']
reqid = response['Response']['RequestId']
raise TencentCloud::Common::TencentCloudSDKException.new(code, message, reqid)
end
rescue TencentCloud::Common::TencentCloudSDKException => e
raise e
rescue StandardError => e
raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
end
# 用户通过该接口可以设置热词表的默认状态。初始状态为0,用户可设置状态为1,即为默认状态。默认状态表示用户在请求识别时,如不设置热词表ID,则默认使用状态为1的热词表。
# @param request: Request instance for SetVocabState.
# @type request: :class:`Tencentcloud::asr::V20190614::SetVocabStateRequest`
# @rtype: :class:`Tencentcloud::asr::V20190614::SetVocabStateResponse`
def SetVocabState(request)
body = send_request('SetVocabState', request.serialize)
response = JSON.parse(body)
if response['Response'].key?('Error') == false
model = SetVocabStateResponse.new
model.deserialize(response['Response'])
model
else
code = response['Response']['Error']['Code']
message = response['Response']['Error']['Message']
reqid = response['Response']['RequestId']
raise TencentCloud::Common::TencentCloudSDKException.new(code, message, reqid)
end
rescue TencentCloud::Common::TencentCloudSDKException => e
raise e
rescue StandardError => e
raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
end
# 用户通过本接口进行对应的词表信息更新。
# @param request: Request instance for UpdateAsrVocab.
# @type request: :class:`Tencentcloud::asr::V20190614::UpdateAsrVocabRequest`
# @rtype: :class:`Tencentcloud::asr::V20190614::UpdateAsrVocabResponse`
def UpdateAsrVocab(request)
body = send_request('UpdateAsrVocab', request.serialize)
response = JSON.parse(body)
if response['Response'].key?('Error') == false
model = UpdateAsrVocabResponse.new
model.deserialize(response['Response'])
model
else
code = response['Response']['Error']['Code']
message = response['Response']['Error']['Message']
reqid = response['Response']['RequestId']
raise TencentCloud::Common::TencentCloudSDKException.new(code, message, reqid)
end
rescue TencentCloud::Common::TencentCloudSDKException => e
raise e
rescue StandardError => e
raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
end
end
end
end
end