tencent cloud

文档反馈

任务接口

最后更新时间:2024-03-13 11:32:21

    简介

    本文档提供关于语音识别任务接口的 API 概览以及 SDK 示例代码。
    API
    操作名
    操作描述
    提交语音识别任务
    提交语音识别任务
    用于提交一个语音识别任务
    查询指定的语音识别任务
    查询指定的语音识别任务
    用于查询指定的语音识别任务
    批量拉取语音识别任务
    拉取符合条件的语音识别任务
    用于拉取符合条件的语音识别任务

    提交语音识别任务

    功能说明

    ci_create_asr_job 接口用于提交一个语音识别任务。

    方法原型

    def ci_create_asr_job(self, Bucket, QueueId, InputObject, OutputBucket, OutputRegion, OutputObject, 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,
    QueueId='s0980xxxxxxxxxxxxxxxxff12',
    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,
    QueueId='s0980xxxxxxxxxxxxxxxxff12',
    InputObject='normal.mp4',
    OutputBucket=bucket_name,
    OutputRegion='ap-chongqing',
    OutputObject='result.txt',
    SpeechRecognition=body
    )
    print(response)
    return response

    参数说明

    参数名称
    描述
    类型
    Bucket
    对象所在存储桶
    String
    QueueId
    任务所在的队列 ID
    String
    InputObject
    待操作的文件对象
    Container
    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, 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,
    QueueId='p4bdxxxxxxxxxxxxxxxxxxxx57f1',
    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
    联系我们

    联系我们,为您的业务提供专属服务。

    技术支持

    如果你想寻求进一步的帮助,通过工单与我们进行联络。我们提供7x24的工单服务。

    7x24 电话支持