数据万象任务接口

简介
本文档提供关于语音识别任务接口的 API 概览以及 SDK 示例代码。
API
操作名
操作描述
提交语音识别任务
提交语音识别任务
用于提交一个语音识别任务
查询指定的语音识别任务
查询指定的语音识别任务
用于查询指定的语音识别任务
批量拉取语音识别任务
拉取符合条件的语音识别任务
用于拉取符合条件的语音识别任务
提交语音识别任务
功能说明
ci_create_asr_job 接口用于提交一个语音识别任务。
方法原型
def ci_create_asr_job(self, Bucket, OutputBucket, OutputRegion, OutputObject, 
                      QueueId=None, InputObject=None, Url=None, TemplateId=None,
                      SpeechRecognition=None, CallBack=None, CallBackFormat=None, 
                      CallBackType=None, CallBackMqConfig=None, **kwargs)
请求示例
def ci_create_asr_jobs():
    # 创建语音识别异步任务(使用模板)
    response = client.ci_create_asr_job(
        Bucket=bucket_name,
        TemplateId='t1ada6f282d29742dxxxxxxxxxxxxx',
        InputObject='normal.mp4',
        OutputBucket=bucket_name,
        OutputRegion='ap-chongqing',
        OutputObject='result.txt',
    )
    print(response)
    return response
﻿
def ci_create_asr_jobs():
    # 创建语音识别异步任务(使用参数)
    body = {
        'EngineModelType': '16k_zh',
        'ChannelNum': '1',
        'ResTextFormat': '1',
    }
    response = client.ci_create_asr_job(
        Bucket=bucket_name,
        InputObject='normal.mp4',
        OutputBucket=bucket_name,
        OutputRegion='ap-chongqing',
        OutputObject='result.txt',
        SpeechRecognition=body
    )
    print(response)
    return response
参数说明
参数名称
描述
类型
是否必选
Bucket
对象所在存储桶
String
是
QueueId
任务所在的队列 ID，开通语音识别服务后自动生成，请使用 查询队列 获取或通过 万象控制台 在存储桶中查询
String
否
InputObject
待操作的文件对象，InputObject与Url参数需传入其中一个，当都传入时，仅处理InputObject指向的文件
String
否
Url
外网可下载的Url，InputObject与Url参数需传入其中一个，当都传入时，仅处理InputObject指向的文件
String
否
OutputRegion
存储桶的地域
String
是
OutputBucket
存储结果的存储桶
String
是
OutputObject
输出文件路径
String
是
TemplateId
模板ID
String
否
SpeechRecognition
语音识别参数，详见 提交语音识别任务请求详情 中的 SpeechRecognition 详情
dict
否
CallBack
任务回调地址，优先级高于队列的回调地址。设置为 no 时，表示队列的回调地址不产生回调
string
否
CallBackFormat
任务回调格式，JSON 或 XML，默认 XML，优先级高于队列的回调格式
string
否
CallBackType
任务回调类型，Url 或 TDMQ，默认 Url，优先级高于队列的回调类型
string
否
CallBackMqConfig
任务回调 TDMQ 配置，当 CallBackType 为 TDMQ 时必填，详见 CallBackMqConfig 详情﻿
dict
否
返回结果说明
{
    'JobsDetail': {
        'Code': 'Success', 
        'CreationTime': '2022-09-14T22:31:38+0800', 
        'EndTime': '-', 
        'Input': {'BucketId': 'test-12539xxxxx', 'Object': 'normal.mp4', 'Region': 'ap-chongqing'}, 
        'JobId': 'sf1398ed0343911eda6d733209028ff12', 
        'Message': None, 
        'Operation': {
            'JobLevel': '0', 
            'Output': {'Bucket': 'test-12539xxxxx', 'Object': 'result.txt', 'Region': 'ap-chongqing'}, 
            'TemplateId': 't1ada6f282d29742db83244e085exxxxxx', 
            'TemplateName': 'name'
        }, 
        'QueueId': 'p7369ebcf8f93414c8250c966xxxxxxxx', 
        'StartTime': '-', 
        'State': 'Submitted', 
        'Tag': 'SpeechRecognition'
    }
}
﻿
参数名称
描述
类型
JobsDetail
任务的详细信息
Container
Code
错误码，只有 State 为 Failed 时有意义
String
Message
错误描述，只有 State 为 Failed 时有意义
String
JobId
新创建任务的 ID
String
Tag
新创建任务的 Tag：DocProcess
String
State
任务的状态，为 Submitted、Running、Success、Failed、Pause、Cancel 其中一个
String
CreationTime
任务的创建时间
String
QueueId
任务所在的队列 ID，开通语音识别服务后自动生成，请使用 查询队列 获取或通过 
万象控制台 在存储桶中查询
String
Input
该任务的输入文件路径
Container
Operation
该任务的规则
Container
查询指定语音识别任务
功能说明
ci_get_asr_job 用于查询指定的语音识别任务。
方法原型
def ci_get_asr_job(self, Bucket, JobID, **kwargs):
请求示例
def ci_get_asr_jobs():
    # 获取语音识别信息
    response = client.ci_get_asr_job(
        Bucket=bucket_name,
        JobID='s18a9xxxxxxxxxxxxxxxxxxxxff1aa',
    )
    print(response)
    return response
参数说明
参数名称
描述
类型
是否必选
Bucket
对象所在存储桶
String
是
JobID
语音识别任务 ID
String
是
返回结果说明
{
    'JobsDetail': [{
        'Code': 'Success', 
        'CreationTime': '2022-09-14T22:36:51+0800', 
        'EndTime': '2022-09-14T22:37:01+0800', 
        'Input': {'BucketId': 'testpic-1253960454', 'Object': 'gaobai.mp4', 'Region': 'ap-chongqing'}, 
        'JobId': 'sabfb88d6343a11ed8c375fe3d77ef1d7', 
        'Message': None, 
        'Operation': {
            'JobLevel': '0', 
            'Output': {'Bucket': 'testpic-1253960454', 'Object': 'result.txt', 'Region': 'ap-chongqing'}, 
            'SpeechRecognitionResult': {
                'AudioTime': '215.637', 
                'ObjectName': 'result.txt', 
                'Result': '[0:0.160,1:0.640]  测试测试\\n', 'ResultDetail': None
            }, 
            'TemplateId': 't1ada6f282d29742db83244e085e920b08', 
            'TemplateName': 'name'
        }, 
        'QueueId': 'p7369ebcf8f93414c8250c9663e1dff5a', 
        'StartTime': '2022-09-14T22:36:53+0800', 
        'State': 'Success', 
        'Tag': 'SpeechRecognition'
    }]
}
参数名称
描述
类型
JobsDetail
任务的详细信息， 同 CreateSpeechRecognitionJobs 接口的 Response.JobsDetail 节点
Container
NonExistJobIds
查询的 ID 中不存在的任务，所有任务都存在时不返回
String
拉取符合条件的语音识别任务
功能说明
ci_list_doc_jobs 用于拉取符合条件的语音识别任务。
方法原型
def ci_list_asr_jobs(self, Bucket, QueueId=None, StartCreationTime=None, 
                     EndCreationTime=None, OrderByTime='Desc', States='All', 
                     Size=10, NextToken='', **kwargs):
请求示例
def ci_list_asr_jobs():
    # 获取语音识别任务信息列表
    response = client.ci_list_asr_jobs(
        Bucket=bucket_name,
        Size=10,
    )
    print(response)
    return response
参数说明
参数名称
描述
类型
是否必选
Bucket
任务所在存储桶
String
是
QueueId
任务所在的队列 ID，开通语音识别服务后自动生成，请使用 查询队列 获取或通过 万象控制台 在存储桶中查询
String
否
OrderByTime
Desc 或者 Asc。默认为 Desc
String
否
NextToken
请求的上下文，用于翻页。上次返回的值
String
否
Size
拉取的最大任务数。默认为10，最大值为100
Int
否
States
拉取该状态的任务，以“,”分割，支持多状态：All、Submitted、Running、Success、Failed、Pause、Cancel。默认为 All
String
否
StartCreationTime
拉取创建时间大于该时间的任务。格式为：%Y-%m-%dT%H:%m:%S%z
String
否
EndCreationTime
拉取创建时间小于该时间的任务。格式为：%Y-%m-%dT%H:%m:%S%z
String
否
返回结果说明
{
    'JobsDetail': [{
        'Code': 'Success', 
        'CreationTime': '2022-09-14T22:36:51+0800', 
        'EndTime': '2022-09-14T22:37:01+0800', 
        'Input': {'BucketId': 'test-125396xxxx', 'Object': 'gaobai.mp4', 'Region': 'ap-chongqing'}, 
        'JobId': 'sabfb88d6343a11ed8c375fe3dxxxxxxx', 
        'Message': None, 
        'Operation': {
            'JobLevel': '0', 
            'Output': {'Bucket': 'test-125396xxxx', 'Object': 'result.txt', 'Region': 'ap-chongqing'}, 
            'SpeechRecognitionResult': {
                'AudioTime': '215.637', 
                'ObjectName': 'result.txt', 
                'Result': '[0:0.160,1:0.640]  测试测试。\\n', 
                'ResultDetail': None
            }, 
            'TemplateId': 't1ada6f282d29742db83244e085xxxxxx', 
            'TemplateName': 'name'
        }, 
        'QueueId': 'p7369ebcf8f93414c8250c966xxxxxxx', 
        'StartTime': '2022-09-14T22:36:53+0800', 
        'State': 'Success', 
        'Tag': 'SpeechRecognition'
    }], 
    'NextToken': '15966'
}
﻿
参数名称
描述
类型
JobsDetail
任务的详细信息，同 CreateSpeechRecognitionJobs 接口中的 Response.JobsDetail 节点
Container
NextToken
翻页的上下文 Token
String
﻿

API	操作名	操作描述
提交语音识别任务	提交语音识别任务	用于提交一个语音识别任务
查询指定的语音识别任务	查询指定的语音识别任务	用于查询指定的语音识别任务
批量拉取语音识别任务	拉取符合条件的语音识别任务	用于拉取符合条件的语音识别任务

参数名称	描述	类型	是否必选
Bucket	对象所在存储桶	String	是
QueueId	任务所在的队列 ID，开通语音识别服务后自动生成，请使用查询队列获取或通过万象控制台在存储桶中查询	String	否
InputObject	待操作的文件对象，InputObject与Url参数需传入其中一个，当都传入时，仅处理InputObject指向的文件	String	否
Url	外网可下载的Url，InputObject与Url参数需传入其中一个，当都传入时，仅处理InputObject指向的文件	String	否
OutputRegion	存储桶的地域	String	是
OutputBucket	存储结果的存储桶	String	是
OutputObject	输出文件路径	String	是
TemplateId	模板ID	String	否
SpeechRecognition	语音识别参数，详见提交语音识别任务请求详情中的 SpeechRecognition 详情	dict	否
CallBack	任务回调地址，优先级高于队列的回调地址。设置为 no 时，表示队列的回调地址不产生回调	string	否
CallBackFormat	任务回调格式，JSON 或 XML，默认 XML，优先级高于队列的回调格式	string	否
CallBackType	任务回调类型，Url 或 TDMQ，默认 Url，优先级高于队列的回调类型	string	否
CallBackMqConfig	任务回调 TDMQ 配置，当 CallBackType 为 TDMQ 时必填，详见 CallBackMqConfig 详情	dict	否

任务接口

本页目录：

简介

提交语音识别任务

功能说明

方法原型

请求示例

参数说明

返回结果说明

查询指定语音识别任务

功能说明

方法原型

请求示例

参数说明

返回结果说明

拉取符合条件的语音识别任务

功能说明

方法原型

请求示例

参数说明

返回结果说明