调用方式

image.png

接口定义

  1. <dependency>
  2.    <groupId>com.alibaba.alifanyi.pixar.biz</groupId>
  3.     <artifactId>pixar-api</artifactId>
  4.     <version>1.1.0-SNAPSHOT</version>
  5. </dependency>

取最新二方包即可：http://repo.alibaba-inc.com/nexus/#nexus-search;quick~pixar-api

接口说明

com.alibaba.alifanyi.pixar.biz.api.project.ProjectApiClientService
serviceGroup = “HSF” serviceVersion = “1.0.0”

创建项目

  1. /**
  2. * 创建项目
  3. * @param projectCreate
  4. * @return Long
  5. */
  6. ResMsgClientDTO<Long> createPorject(ProjectCreateApiDTO projectCreate);

判断项目是否可以工作

  1. /**
  2. * 判断项目是否可以工作
  3. * @param projectAppQuery
  4. * @return ProjectWorkApiDTO
  5. */
  6. ResMsgClientDTO<ProjectWorkApiDTO> checkProjectAvailableWork(ProjectAppQueryApiDTO projectAppQuery);

获取项目结果

  1. /**
  2. * 获取项目结果
  3. * @param projectAppQuery
  4. * @return List<DataClientDTO>
  5. */
  6. ResMsgClientDTO<List<DataClientDTO>> getProjectResult(ProjectAppQueryApiDTO projectAppQuery);

实体说明

ProjectCreateApiDTO

  1. public class ProjectCreateApiDTO extends BaseClientPojo {
  3.     private static final long serialVersionUID = 1L;
  5.     /**
  6.      * 必填，项目基础信息
  7.      */
  8.     @NotNull(message = "projectBase is not null")
  9.     private ProjectBaseApiDTO projectBase;
  11.     /**
  12.      * 必填，项目数据信息
  13.      */
  14.     @NotNull(message = "dataList is not null")
  15.     private List<DataClientDTO> dataList;
  17.     /**
  18.      * 选填，项目分发信息
  19.      */
  20.     private ProjectAssignApiDTO projectAssign;
  22.     /**
  23.      * 选填，项目配置信息
  24.      */
  25.     private ProjectSettingApiDTO projectSetting;
  26. }

ProjectBaseApiDTO

  1. public class ProjectBaseApiDTO extends BaseClientPojo {
  3.     private static final long serialVersionUID = 1L;
  5.     /**
  6.      * 选填，top调用系统属性，AppKey
  7.      */
  8.     private String appkey;
  10.     /**
  11.      * 选填，top调用系统属性， appKey拥有者淘宝用户ID
  12.      */
  13.     private String isvId;
  15.     /**
  16.      * 选填，top调用系统属性，api请求来源ID
  17.      */
  18.     private String ip;
  20.     /**
  21.      * 必填，接口对接唯一标示，需要保证全局唯一
  22.      */
  23.     @NotNull(message = "appId is not null")
  24.     private String appId;
  26.     /**
  27.      * 必填，接口对接业务方标识
  28.      */
  29.     @NotNull(message = "appName is not null")
  30.     private String appName;
  32.     /**
  33.      * 必填，项目名
  34.      */
  35.     @NotNull(message = "projectName is not null")
  36.     private String projectName;
  38.     /**
  39.      * 必填，项目类型
  40.      */
  41.     @NotNull(message = "projectTypeEnum is not null")
  42.     private ProjectTypeEnum projectType;
  44.     /**
  45.      * 必填，源语言
  46.      */
  47.     @NotNull(message = "sourceLanguage is not null")
  48.     private String sourceLanguage;
  50.     /**
  51.      * 必填，目标语言
  52.      */
  53.     @NotNull(message = "targetLanguage is not null")
  54.     private String targetLanguage;
  56.     /**
  57.      * 选填，项目要求返稿时间
  58.      */
  59.     private Date dueDate;
  61.     /**
  62.      * 选填，项目要求/描述
  63.      */
  64.     private String description;
  65. }

DataClientDTO

  1. public class DataClientDTO extends BaseClientPojo {
  2.     private static final long         serialVersionUID = 1L;
  4.     /**
  5.      * 必填，数据的唯一标识
  6.      */
  7.     private Number dataId;
  9.     /**
  10.      * 必填，数据类型 [file,url]
  11.      */
  12.     private              DataTypeEnum dataType;
  14.     /**
  15.      * 选填，文件名
  16.      */
  17.     private              String       fileName;
  19.     /**
  20.      * 选填，公网可访问的文件URL地址
  21.      */
  22.     private              String       fileUrl;
  24.     /**
  25.      * 选填，文本
  26.       */
  27.     private              String       textContent;
  29.     /**
  30.      * 文档创建时间
  31.      */
  32.     private             Date createTime;
  33. }

ProjectAssignApiDTO

  1. public class ProjectAssignApiDTO extends BaseClientPojo {
  3.     private static final long serialVersionUID = 1L;
  5.     /**
  6.      * 必填，需要分配的译员用户名
  7.      */
  8.     private String userName;
  9. }

ProjectSettingApiDTO

  1. public class ProjectSettingApiDTO extends BaseClientPojo {
  3.     private static final long serialVersionUID = 1L;
  5.     /**
  6.      * 选填，记忆库(语料库)配置
  7.      */
  8.     private TmConfigClientDTO tmConfig;
  10.     /**
  11.      * 选填，机器翻译引擎配置
  12.      */
  13.     private MtConfigClientDTO mtConfig;
  15.     /**
  16.      * 选填，术语库配置
  17.      */
  18.     private List<Long> tbIdList;
  20.     /**
  21.      * 选填，文件解析配置
  22.      */
  23.     private FileParserConfigClientDTO fileParserConfig;
  24. }

TmConfigClientDTO

  1. public class TmConfigClientDTO extends BaseClientPojo {
  2.     private static final long                    serialVersionUID = 1L;
  4.     /**
  5.      * 选填，记忆库最小匹配率
  6.      * 默认：75%
  7.      */
  8.     private              Integer                          minMatchingRatio;
  9.     /**
  10.      * 选填，需要使用的记忆库
  11.      */
  12.     private              List<TmGroupWithWeightClientDTO> tmGroupList;
  13. }

TmGroupWithWeightClientDTO

  1. public class TmGroupWithWeightClientDTO extends BaseClientPojo {
  3.     private static final long serialVersionUID = 1L;
  5.     /**
  6.      * 必填，记忆库ID
  7.      */
  8.     private Long                      groupId;
  9.     /**
  10.      * 选填，记忆库匹配权重，默认100%
  11.      */
  12.     private Integer                   weight;
  13.     /**
  14.      * 选填，记忆库匹配属性
  15.      */
  16.     private List<TmPropertyClientDTO> matchProperties;
  17.     /**
  18.      * 选填，项目完成后是否加入该记忆库组，默认：false
  19.      */
  20.     private Boolean joinGroup;
  21. }

MtConfigClientDTO

  1. public class MtConfigClientDTO extends BaseClientPojo {
  2.     private static final long         serialVersionUID = 1L;
  4.     // ===== 通过申请的appName 直接调用 ====
  5.     /**
  6.      * 必填，机器翻译引擎用户名
  7.      */
  8.     private String appName;
  9.     /**
  10.      * 必填，机器翻译引擎平台业务方所属平台
  11.      */
  12.     private String platform;
  13.     /**
  14.      * 必填，机器翻译引擎服务类型，ex: general、offer
  15.      */
  16.     private String fieldType;
  17. }

FileParserConfigClientDTO

  1. public class FileParserConfigClientDTO extends BaseClientPojo {
  2.     private static final long         serialVersionUID = 1L;
  4.     /**
  5.      * 是否翻译Word页眉、页脚
  6.      */
  7.     private Boolean translateWordHeaderFooter;
  9.     /**
  10.      * 是否翻译Word批注
  11.      */
  12.     private Boolean translateWordComments;
  14.     /**
  15.      * 不翻译的word样式
  16.      */
  17.     private Set<String> excludeWordStyles;
  19.     /**
  20.      * 是否翻译Excel隐藏行、列
  21.      */
  22.     private Boolean translateExcelHiddenRowsCols;
  24.     /**
  25.      * 是否翻译Excel的sheet表名
  26.      */
  27.     private Boolean translateExcelSheetName;
  29.     /**
  30.      * 是否翻译Excel批注
  31.      */
  32.     private Boolean translateExcelComments;
  34.     /**
  35.      * 是否翻译PPT批注
  36.      */
  37.     private Boolean translatePptComments;
  39.     /**
  40.      * 是否翻译PPT备注
  41.      */
  42.     private Boolean translatePptNotes;
  44.     /**
  45.      * 是否翻译PPT页眉、页脚
  46.      */
  47.     private Boolean translatePptHeaderFooter;
  49.     /**
  50.      * 跳过不翻译的xml节点
  51.      */
  52.     private List<String> excludeXmlTagList;
  54.     /**
  55.      * 指定翻译html中img标记对的alt属性值
  56.      */
  57.     private Boolean isTranslateHtmlAlt;
  59.     /**
  60.      * xml 行内配置文件，保障分句的正确性
  61.      */
  62.     private List<String> inlineXmlTagList;
  63. }

ProjectAppQueryApiDTO

  1. public class ProjectAppQueryApiDTO extends BaseClientPojo {
  3.     private static final long serialVersionUID = 1L;
  5.     /**
  6.      * 选填，top调用系统属性，AppKey
  7.      */
  8.     private String appkey;
  10.     /**
  11.      * 选填，top调用系统属性， appKey拥有者淘宝用户ID
  12.      */
  13.     private String isvId;
  15.     /**
  16.      * 选填，top调用系统属性，api请求来源ID
  17.      */
  18.     private String ip;
  20.     /**
  21.      * 必填，接口对接业务方标识
  22.      */
  23.     private String appName;
  25.     /**
  26.      * 选填，接口对接唯一标示
  27.      */
  28.     private String appId;
  30.     /**
  31.      * 选填，项目ID
  32.      * 可以直接通过项目ID来查找
  33.      */
  34.     private Long projectId;
  35. }

ProjectWorkApiDTO

  1. public class ProjectWorkApiDTO extends BaseClientPojo {
  3.     private static final long serialVersionUID = 1L;
  4.     /**
  5.      * 是否可以开始工作
  6.      */
  7.     private Boolean availableWork;
  9.     /**
  10.      * 项目ID
  11.      */
  12.     private Long projectId;
  14.     /**
  15.      * 项目详情页地址
  16.      */
  17.     private String projectDetailUrl;
  19.     /**
  20.      * 项目工作地址
  21.      */
  22.     private String projectWorkUrl;
  24.     /**
  25.      * 项目认领地址
  26.      */
  27.     private String projectAssignUrl;
  28. }

枚举说明

支持语项

  1. en-US : 英文（美国）
  2. zh-CN : 简体中文
  3. de-DE : 德语
  4. ja-JP : 日语
  5. fr-FR : 法语（法国）
  6. ko-KR : 韩语
  7. es-ES : 西班牙文（西班牙）
  8. ru-RU : 俄语
  9. pt-PT : 葡萄牙文（葡萄牙）
  10. it-IT : 意大利语
  11. id-ID : 印尼语
  12. vi-VN : 越南语
  13. th-TH : 泰语
  14. zh-TW : 繁体中文（台湾）
  15. zh-HK : 繁体中文（香港）
  16. ar-AR : 阿拉伯语
  17. tr-TR : 土耳其语
  18. he-HE : 希伯来语
  19. pt-BR : 葡萄牙文（巴西
  20. en-GB : 英文（英国）
  21. hi-IN : 印地语
  22. nl-NL : 荷兰语
  23. ms-ms : 马来西亚
  24. en-HK : 英文（香港）
  25. pl-PL : 波兰语
  26. uk-UA : 乌克兰语
  27. es-LAR : 拉丁西班牙语

其他说明

  • appId 调用方自己定义即可，需要保证全局唯一
  • appName 调用前联系 谦雅