更新时间:2024-01-17 GMT+08:00
分享

文档翻译状态查询

功能介绍

该接口用于获取文档翻译识别状态以及临时url,临时url可以用于获取翻译后的文档,每个临时url有效期为十分钟。

本API调用限制为20次/秒。

调试

您可以在API Explorer中调试该接口。

前提条件

在使用本API之前,需要您完成服务申请和认证鉴权,具体操作流程请参见申请服务认证鉴权章节。

用户首次使用需要先申请开通。服务只需要开通一次即可,后面使用时无需再次申请。如未开通服务,调用服务时会提示ModelArts.4204报错,请在调用服务前先进入控制台开通服务,并注意开通服务区域与调用服务的区域保持一致。

URI

  • URI格式
    GET /v1/{project_id}/machine-translation/file-translation/jobs/{job_id}
  • 参数说明
    表1 URI参数说明

    参数名

    必选

    说明

    project_id

    项目ID。获取方法请参见获取项目ID

    job_id

    文档翻译任务标识符。通过文档翻译任务创建获取。

请求消息

NA

响应消息

响应参数说明请参见表 响应参数说明
表2 响应参数说明

参数名

参数类型

说明

status

String

当前翻译状态。具体状态如下所示:

  • WAITING 等待翻译。
  • BEGIN 开始翻译。
  • FINISHED 翻译已经完成。
  • ERROR 翻译过程中发生错误。

调用失败时无此字段。

url

String

临时url,使用GET请求下载翻译结果,有效期十分钟。过期后请再次调用接口获取新的url。

调用失败时或翻译状态非FINISHED时无此字段。

error_code

String

调用失败时的错误码,具体参见错误码

调用成功时无此参数。

error_msg

String

调用失败时的错误信息。

调用成功时无此参数。

请求示例

  • 请求示例(查询文档翻译状态)
    GET https://{endpoint}/v1/{project_id}/machine-translation/file-translation/567e6536-****-****-****-826321939656 
    
    Request Header:  
        Content-Type:application/json
        X-Auth-Token: MIINRwYJKoZIhvcNAQcCoIINODCCDTQCAQExDTALBglghkgBZQMEAgEwgguVBgkqhkiG...   
  • Python3语言请求代码示例(查询文档翻译状态)
    # -*- coding: utf-8 -*-
    # 此demo仅供测试使用,建议使用sdk。需提前安装requests,执行pip install requests
    import requests
    
    def nlp_demo():
        # endpoint和project_id需替换,job_id需要替换成[文档翻译任务创建]API返回的job_id信息。
        url = 'https://{endpoint}/v1/{project_id}/machine-translation/file-translation/jobs/{job_id}'
        token = '用户对应region的token'
        header = {
            'Content-Type': 'application/json',
            'X-Auth-Token': token
        }
        resp = requests.get(url, headers=header, verify=False)
        print(resp.json())
    
    if __name__ == '__main__':
        nlp_demo()
  • Java语言请求代码示例(查询文档翻译状态)
    import java.io.BufferedReader;
    import java.io.InputStream;
    import java.io.InputStreamReader;
    import java.io.OutputStreamWriter;
    import java.net.HttpURLConnection;
    import java.net.URL;
    
    /**
     * 此demo仅供测试使用,建议使用sdk
     */
    public class NLPDemo {
        public void nlpDemo() {
            try {
                //endpoint和projectId需要替换成实际信息。
                //job_id需要替换成[文档翻译任务创建]API返回的job_id信息。
                URL url = new URL("https://{endpoint}/v1/{project_id}/machine-translation/file-translation/jobs/{job_id}");
                String token = "对应region的token";
                HttpURLConnection connection = (HttpURLConnection) url.openConnection();
                connection.setRequestMethod("GET");
                connection.setDoInput(true);
                connection.setDoOutput(true);
                connection.addRequestProperty("Content-Type", "application/json");
                connection.addRequestProperty("X-Auth-Token", token);
    
                InputStream is = connection.getInputStream();
                BufferedReader br = new BufferedReader(new InputStreamReader(is, "UTF-8"));
                while (br.ready()) {
                    System.out.println(br.readLine());
                }
            } catch (Exception e) {
                e.printStackTrace();
            }
        }
    
        public static void main(String[] args) {
            NLPDemo nlpDemo = new NLPDemo();
            nlpDemo.nlpDemo();
        }
    }

响应示例

  • 成功响应示例
    {
        "status": "FINISHED",
        "url": "https://****.obs.****.huawei.com:443/****?AccessKeyId=****&Expires=****&Signature=*****"
    }
  • 失败响应示例
    {
        "error_code": "NLP.0101",
        "error_msg": "Authentication failed. Verify the token."
    }

相关文档