tencent cloud

PrevNext

文档反馈

请输入关键字

Recent Pages

文档
文档

提交翻译任务

最后更新时间：2024-01-20 16:35:12

    功能描述

    提交一个翻译任务。
    

    请求

    请求示例

    POST /ai_jobs HTTP/1.1
    Host: <BucketName-APPID>.ci.<Region>.myqcloud.com
    Date: <GMT Date>
    Authorization: <Auth String>
    Content-Length: <length>
    Content-Type: application/xml
    
    <body>
    说明：
    Authorization: Auth String（详情请参见 请求签名 文档）。
    通过子账号使用时，需要授予相关的权限，详情请参见 授权粒度详情 文档。

    请求头

    此接口仅使用公共请求头部，详情请参见 公共请求头部 文档。

    请求体

    该请求操作的实现需要有如下请求体。
    <Request>
        <Tag>Translation</Tag>
        <Input>
            <Object>input/en.pdf</Object>
            <Lang>en</Lang>
            <Type>pdf</Type>
            <BasicType>pptx</BasicType>
        </Input>
        <Operation>
            <Translation>
                <Lang>zh</Lang>
                <Type>pdf</Type>
            </Translation>
            <Output>
                <Region>ap-chongqing</Region>
                <Bucket>test-123456789</Bucket>
                <Object>output/zh.pdf</Object>
            </Output>
            <UserData>This is my data.</UserData>
            <JobLevel>0</JobLevel>
        </Operation>
        <QueueId>pcd463e1467964d39ad2d3f66aacd8199</QueueId>
        <CallBack>http://callback.demo.com</CallBack>
        <CallBackFormat>JSON<CallBackFormat>
    </Request>
    具体的数据描述如下：
    节点名称（关键字）
    父节点
    描述
    类型
    是否必选
    Request
    无
    保存请求的容器
    Container
    是
    Container 类型 Request 的具体数据描述如下：
    节点名称（关键字）
    父节点
    描述
    类型
    是否必选
    Tag
    Request
    创建任务的 Tag：Translation
    String
    是
    Input
    Request
    待操作的对象信息
    Container
    是
    Operation
    Request
    操作规则
    Container
    是
    QueueId
    Request
    任务所在的队列 ID
    String
    是
    CallBackFormat
    Request
    任务回调格式，JSON 或 XML，默认 XML，优先级高于队列的回调格式
    String
    否
    CallBackType
    Request
    任务回调类型，Url 或 TDMQ，默认 Url，优先级高于队列的回调类型
    String
    否
    CallBack
    Request
    任务回调地址，优先级高于队列的回调地址。设置为 no 时，表示队列的回调地址不产生回调
    String
    否
    CallBackMqConfig
    Request
    任务回调 TDMQ 配置，当 CallBackType 为 TDMQ 时必填。详情见 CallBackMqConfig
    Container
    否
    
    Container 类型 Input 的具体数据描述如下：
    节点名称（关键字）
    父节点
    描述
    类型
    是否必选
    限制
    Object
    Request.Input
    源文档文件名
    String
    是
    单文件（docx/xlsx/html/markdown/txt）：800万字符 有页数的（pdf/pptx）：300页 文本文件（txt）：10MB 二进制文件（pdf\\docx\\pptx\\xlsx）：60MB 图片文件（jpg\\jpeg\\png）：10MB
    Lang
    Request.Input
    文档语言类型
    String
    是
    zh：简体中文 zh-hk：繁体中文 zh-tw：繁体中文 zh-tr：繁体中文 en：英语 ar：阿拉伯语 de：德语 es：西班牙语 fr：法语 id：印尼语 it：意大利语 ja：日语 pt：葡萄牙语 ru：俄语 ko：韩语 km：高棉语 lo：老挝语
    Type
    Request.Input
    文档类型
    String
    是
    pdf docx pptx xlsx txt xml html：只能翻译 HTML 里的文本节点，需要通过 JS 动态加载的不进行翻译 markdown jpg jpeg png
    BasicType
    Request.Input
    原始文档类型
    String
    否
    仅在 Type=pdf/jpg/jpeg/png 时使用， 当值为pdf时，仅支持 docx、pptx 当值为jpg/jpeg/png/webp时，仅支持txt，不填写此字段时，直接返回翻译结果
    Container 类型 Operation 的具体数据描述如下：
    节点名称（关键字）
    父节点
    描述
    类型
    是否必选
    Translation
    Request.Operation
    翻译参数
    Container
    是
    Output
    Request.Operation
    结果输出地址
    Container
    是（当NoNeedOutput为true时非必选）
    UserData
    Request.Operation
    透传用户信息, 可打印的 ASCII 码, 长度不超过1024
    String
    否
    JobLevel
    Request.Operation
    任务优先级，级别限制：0 、1 、2 。级别越大任务优先级越高，默认为0
    String
    否
    NoNeedOutput
    Request.Operation
    仅输出结果，不生成结果文件true/false。该参数原文档类型为图片时有效
    String
    否
    Container 类型 Translation 的具体数据描述如下：
    节点名称（关键字）
    父节点
    描述
    类型
    是否必选
    限制
    Lang
    Request.Operation.Translation
    目标语言类型
    String
    是
    源语言类型为 zh/zh-hk/zh-tw/zh-tr 时支持：en、ar、de、es、fr、id、it、ja、it、ru、ko、km、lo、pt en 时支持：zh、zh-hk、zh-tw、zh-tr、ar、de、es、fr、id、it、ja、it、ru、ko、km、lo、pt 其他类型时支持：zh、zh-hk、zh-tw、zh-tr、en
    Type
    Request.Operation.Translation
    文档类型
    String
    是
    源文件类型与目标文件类型映射关系如下： docx：docx pptx：pptx xlsx：xlsx txt：txt xml：xml html：html markdown：markdown pdf：pdf docx png：txt jpg：txt jpeg：txt
    Container 类型 Output 的具体数据描述如下：
    节点名称（关键字）
    父节点
    描述
    类型
    是否必选
    Region
    Request.Operation.Output
    存储桶的地域
    String
    是
    Bucket
    Request.Operation.Output
    存储结果的存储桶
    String
    是
    Object
    Request.Operation.Output
    输出结果的文件名
    String
    是

    响应

    响应头

    此接口仅返回公共响应头部，详情请参见 公共响应头部 文档。

    响应体

    该响应体返回为 application/xml 数据，包含完整节点数据的内容展示如下：
    <Response>
        <JobsDetail>
            <Code>Success</Code>
            <Message/>
            <JobId>ac7c990a00bf211ed946af9e0691f2b7a</JobId>
            <State>Submitted</State>
            <CreationTime>2022-06-27T14:44:10+0800</CreationTime>
            <StartTime>-</StartTime>
            <EndTime>-</EndTime>
            <QueueId>pcd463e1467964d39ad2d3f66aacd8199</QueueId>
            <Tag>Translation</Tag>
            <Input>
                <Object>input/en.pdf</Object>
                <Lang>en</Lang>
                <Type>pdf</Type>
                <BasicType>pptx</BasicType>
            </Input>
            <Operation>
                <Translation>
                    <Lang>zh</Lang>
                    <Type>pdf</Type>
                </Translation>
                <Output>
                    <Region>ap-chongqing</Region>
                    <Bucket>test-123456789</Bucket>
                    <Object>output/zh.pdf</Object>
                </Output>
                <UserData>This is my data.</UserData>
                <JobLevel>0</JobLevel>
            </Operation>
        </JobsDetail>
    </Response>
    具体的数据内容如下：
    节点名称（关键字）
    父节点
    描述
    类型
    Response
    无
    保存结果的容器
    Container
    Container 节点 Response 的内容：
    节点名称（关键字）
    父节点
    描述
    类型
    JobsDetail
    Response
    任务的详细信息
    Container
    Container 节点 JobsDetail 的内容：
    节点名称（关键字）
    父节点
    描述
    类型
    Code
    Response.JobsDetail
    错误码，只有 State 为 Failed 时有意义
    String
    Message
    Response.JobsDetail
    错误描述，只有 State 为 Failed 时有意义
    String
    JobId
    Response.JobsDetail
    新创建任务的 ID
    String
    Tag
    Response.JobsDetail
    新创建任务的 Tag：Translation
    String
    State
    Response.JobsDetail
    任务的状态，为 Submitted、Running、Success、Failed、Pause、Cancel 其中一个
    String
    CreationTime
    Response.JobsDetail
    任务的创建时间
    String
    StartTime
    Response.JobsDetail
    任务的开始时间
    String
    EndTime
    Response.JobsDetail
    任务的结束时间
    String
    QueueId
    Response.JobsDetail
    任务所属的队列 ID
    String
    Input
    Response.JobsDetail
    同请求中的 Request.Input 节点。
    Container
    Operation
    Response.JobsDetail
    该任务的规则
    Container
    Container 节点 Operation 的内容：
    节点名称（关键字）
    父节点
    描述
    类型
    Translation
    Response.JobsDetail.Operation
    同请求中的 Request.Operation.Translation
    Container
    Output
    Response.JobsDetail.Operation
    同请求中的 Request.Operation.Output
    Container
    UserData
    Response.JobsDetail.Operation
    透传用户信息
    String
    JobLevel
    Response.JobsDetail.Operation
    任务优先级
    String
    AITranslateResult
    Response.JobsDetail.Operation
    翻译结果详情
    Container
    Container 节点 AITranslateResult 的内容：
    节点名称（关键字）
    父节点
    描述
    类型
    Result
    Response.JobsDetail.Operation
    翻译结果内容
    String

    错误码

    该请求操作无特殊错误信息，常见的错误信息请参见 错误码 文档。

    实际案例

    请求

    POST /ai_jobs HTTP/1.1
    Authorization: q-sign-algorithm=sha1&q-ak=AKIDZfbOAo7cllgPvF9cXFrJD0a1ICvR****&q-sign-time=1497530202;1497610202&q-key-time=1497530202;1497610202&q-header-list=&q-url-param-list=&q-signature=28e9a4986df11bed0255e97ff90500557e0ea057
    Host: test-1234567890.ci.ap-beijing.myqcloud.com
    Content-Length: 166
    Content-Type: application/xml
    
    <Request>
        <Tag>Translation</Tag>
        <Input>
            <Object>input/en.pdf</Object>
            <Lang>en</Lang>
            <Type>pdf</Type>
            <BasicType>pptx</BasicType>
        </Input>
        <Operation>
            <Translation>
                <Lang>zh</Lang>
                <Type>pdf</Type>
            </Translation>
            <Output>
                <Region>ap-chongqing</Region>
                <Bucket>test-123456789</Bucket>
                <Object>output/zh.pdf</Object>
            </Output>
            <UserData>This is my data.</UserData>
            <JobLevel>0</JobLevel>
        </Operation>
        <QueueId>pcd463e1467964d39ad2d3f66aacd8199</QueueId>
        <CallBack>http://callback.demo.com</CallBack>
        <CallBackFormat>JSON<CallBackFormat>
    </Request>

    响应

    HTTP/1.1 200 OK
    Content-Type: application/xml
    Content-Length: 230
    Connection: keep-alive
    Date: Mon, 28 Jun 2022 15:23:12 GMT
    Server: tencent-ci
    x-ci-request-id: NTk0MjdmODlfMjQ4OGY3XzYzYzhf****
    
    <Response>
        <JobsDetail>
            <Code>Success</Code>
            <Message/>
            <JobId>ac7c990a00bf211ed946af9e0691f2b7a</JobId>
            <State>Submitted</State>
            <CreationTime>2022-06-27T14:44:10+0800</CreationTime>
            <StartTime>-</StartTime>
            <EndTime>-</EndTime>
            <QueueId>pcd463e1467964d39ad2d3f66aacd8199</QueueId>
            <Tag>Translation</Tag>
            <Input>
                <Object>input/en.pdf</Object>
                <Lang>en</Lang>
                <Type>pdf</Type>
                <BasicType>pptx</BasicType>
            </Input>
            <Operation>
                <Translation>
                    <Lang>zh</Lang>
                    <Type>pdf</Type>
                </Translation>
                <Output>
                    <Region>ap-chongqing</Region>
                    <Bucket>test-123456789</Bucket>
                    <Object>output/zh.pdf</Object>
                </Output>
                <UserData>This is my data.</UserData>
                <JobLevel>0</JobLevel>
            </Operation>
        </JobsDetail>
    </Response>
    
    Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
    隐私条款服务条款缓存条款