文档目录

翻译任务API

创建翻译任务

/v1/translation/create

为文档/文件翻译创建新的翻译任务。

示例

curl
1curl -X POST 'https://shangyiai.com/api/v1/translation/create' \
2--header 'Authorization: [yourSecretKey]' \
3--form 'file=@bitcoin.pdf' \
4--form 'fromLang=English' \
5--form 'toLang=Simplified Chinese'

请求参数

参数类型默认描述示例
*filebinary-
  • 需要翻译的文件 - 支持的文件类型：查询- 需要翻译的文件 - 支持的文件类型：查询- 需要翻译的文件 - 支持的文件类型：查询- 需要翻译的文件 - 支持的文件类型：查询
bitcoin.pdf
*fromLangString-
  • 原语言，原语言不能和目标语言相同 - 支持语言：查询- 原语言，原语言不能和目标语言相同 - 支持语言：查询- 原语言，原语言不能和目标语言相同 - 支持语言：查询- 原语言，原语言不能和目标语言相同 - 支持语言：查询
English
*toLangString-
  • 目标语言，目标语言不能和原语言相同 - 支持语言：查询- 目标语言，目标语言不能和原语言相同 - 支持语言：查询- 目标语言，目标语言不能和原语言相同 - 支持语言：查询- 目标语言，目标语言不能和原语言相同 - 支持语言：查询
Simplified Chinese
modelString-
  • 翻译的AI模型 - 支持模型：查询- 翻译的AI模型 - 支持模型：查询- 翻译的AI模型 - 支持模型：查询- 翻译的AI模型 - 支持模型：查询
-
fileDescriptionString-

文档描述，通过提供额外的信息，提高翻译的质量，例如添加额外的文档背景信息和其他翻译需求等

-
glossaryString-

翻译时使用的术语表名称

-
previewBooleanfalse

是否仅生成预览，仅生成预览时，通过支付 2 credits 来生成文档翻译的预览

-
shouldTranslateImageBooleanfalse
  • 是否翻译文档中的图片 - 仅支持PDF/DOCX/PPTX/EPUB/ODS/ODT/ODF- 是否翻译文档中的图片 - 仅支持PDF/DOCX/PPTX/EPUB/ODS/ODT/ODF- 是否翻译文档中的图片 - 仅支持PDF/DOCX/PPTX/EPUB/ODS/ODT/ODF- 是否翻译文档中的图片 - 仅支持PDF/DOCX/PPTX/EPUB/ODS/ODT/ODF
-
shouldTranslateFileNameBooleantrue

是否翻译文件名

-
passwordString-

PDF文件的打开密码

-
ignoreCommentsBooleanfalse

是否忽略 DOCX、PPTX、XLSX 的批注

-
ignoreNotesBooleanfalse

是否忽略 PPTX 的备注

-
ignoreHeadersAndFootersBooleanfalse

是否忽略 DOCX 的页眉和页脚

-
ignoreHiddenBooleanfalse

是否忽略 PPTX 的隐藏页面

-
ignoreMastersBooleanfalse

是否忽略 PPTX 的母版文本

-
ignoreSheetNamesBooleanfalse

是否不翻译XLSX的表名

-
extractTextRegExpPatternString-
  • 仅翻译匹配正则表达式的内容，并将其替换为译文 - 仅支持txt- 仅翻译匹配正则表达式的内容，并将其替换为译文 - 仅支持txt- 仅翻译匹配正则表达式的内容，并将其替换为译文 - 仅支持txt- 仅翻译匹配正则表达式的内容，并将其替换为译文 - 仅支持txt
-
extractTextRegExpFlagsString-
  • 正则表达式的Flags：g、s、m、u、y - 仅支持txt- 正则表达式的Flags：g、s、m、u、y - 仅支持txt- 正则表达式的Flags：g、s、m、u、y - 仅支持txt- 正则表达式的Flags：g、s、m、u、y - 仅支持txt
-
webhookUrlString-

状态更新时的回调URL，回调的内容包含： {taskId, progress, status}

-

响应

参数类型默认描述示例
taskIdString-

任务ID

-
翻译任务API
查询翻译任务