1. 接口描述
接口请求域名: tmt.tencentcloudapi.com 。
提供13种语言的图片翻译服务,可自动识别图片中的文本内容并翻译成目标语言,识别后的文本按行翻译,后续会提供可按段落翻译的版本。
提示:对于一般开发者,我们建议优先使用SDK接入简化开发。SDK使用介绍请直接查看 5. 开发者资源 部分。
默认接口请求频率限制:5次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:ImageTranslate。 |
Version | 是 | String | 公共参数,本接口取值:2018-03-21。 |
Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
SessionUuid | 是 | String | 唯一id,返回时原样返回 示例值:session-00001 |
Scene | 是 | String | doc:文档扫描 示例值:doc |
Data | 是 | String | 图片数据的Base64字符串,经Base64编码后不超过 7M,分辨率建议600*800以上,支持PNG、JPG、JPEG、BMP、PDF格式。图片中包含文字需要少于6000字符。 示例值:iVBORw0KGgoAAAANSUhEUgAAAdkAAABPCAYAAACnD7%252FoAAAAAXNSR0IArs4c6QAAAARnQU1BAACxjwv8YQUAAAAJcEhZcwAADsMAAA7DAJ......CCyAAAAwCQgsgAAAMAkILIAAADAJCCyAAAAwCQgsgAAAMAkILIAAADAFJblX8%252F8oMOWYN6nAAAAAElFTkSuQmCC |
Source | 是 | String | 源语言,支持语言列表: 示例值:zh |
Target | 是 | String | 目标语言,各源语言的目标语言支持列表如下: 示例值:en |
ProjectId | 是 | Integer | 项目ID,可以根据控制台-账号中心-项目管理中的配置填写,如无配置请填写默认项目ID:0 示例值:0 |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
SessionUuid | String | 请求的SessionUuid返回 示例值:session-00001 |
Source | String | 源语言 示例值:zh |
Target | String | 目标语言 示例值:en |
ImageRecord | ImageRecord | 图片翻译结果,翻译结果按识别的文本每一行独立翻译,后续会推出按段落划分并翻译的版本 示例值:[{"SourceText":"你好","TargetText":"Hello","X":17,"Y":420,"W":301,"H":55}] |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 API调用
输入示例
POST / HTTP/1.1
Host: tmt.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ImageTranslate
<公共请求参数>
{
"Target": "en",
"SessionUuid": "session-00001",
"ProjectId": 0,
"Scene": "doc",
"Source": "zh",
"Data": "iVBORw0KGgoAAAANSUhEUgAAAdkAAABPCAYAAACnD7%252FoAAAAAXNSR0IArs4c6QAAAARnQU1BAACxjwv8YQUAAAAJcEhZcwAADsMAAA7DAJ\n......\nCCyAAAAwCQgsgAAAMAkILIAAADAJCCyAAAAwCQgsgAAAMAkILIAAADAFJblX8%252F8oMOWYN6nAAAAAElFTkSuQmCC"
}
输出示例
{
"Response": {
"ImageRecord": {
"Value": [
{
"H": 21,
"SourceText": " 我们可以比较容易的将字典(ict)类型转为字符串(string)类型。",
"TargetText": "We can easily convert the dictionary icttype to the string) type.",
"W": 373,
"X": 12,
"Y": 53
}
]
},
"Source": "zh",
"Target": "en",
"SessionUuid": "session-00001",
"RequestId": "6e698139-615a-4d42-8dea-6bfada24e83c"
}
}
5. 开发者资源
腾讯云 API 平台
腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。
API Inspector
用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。
SDK
云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。
- Tencent Cloud SDK 3.0 for Python: GitHub Gitee
- Tencent Cloud SDK 3.0 for Java: GitHub Gitee
- Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
- Tencent Cloud SDK 3.0 for Go: GitHub Gitee
- Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
- Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
- Tencent Cloud SDK 3.0 for C++: GitHub Gitee
- Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
FailedOperation.ErrorUserArea | 用户区域与请求服务区域不一致。 |
FailedOperation.NoFreeAmount | 本月免费额度已用完,如需继续使用您可以在机器翻译控制台升级为付费使用。 |
FailedOperation.ServiceIsolate | 账号因为欠费停止服务,请在腾讯云账户充值。 |
FailedOperation.StopUsing | 账号已停服。 |
FailedOperation.UserNotRegistered | 服务未开通,请在腾讯云官网机器翻译控制台开通服务。 |
InternalError | 内部错误。 |
InternalError.BackendTimeout | 后台服务超时,请稍后重试。 |
InternalError.ErrorUnknown | 未知错误。 |
InternalError.RequestFailed | 请求失败。 |
InvalidParameter | 参数错误。 |
InvalidParameter.MissingParameter | 参数错误。 |
LimitExceeded | 超过配额限制。 |
MissingParameter | 缺少参数错误。 |
UnauthorizedOperation.ActionNotFound | 请填写正确的Action字段名称。 |
UnsupportedOperation | 操作不支持。 |
UnsupportedOperation.TextTooLong | 单次请求text超过长度限制。 |
UnsupportedOperation.UnSupportedTargetLanguage | 不支持的目标语言,请参照语言列表。 |
UnsupportedOperation.UnsupportedLanguage | 不支持的语言,请参照语言列表。 |
UnsupportedOperation.UnsupportedSourceLanguage | 不支持的源语言,请参照语言列表。 |