参考
功能: Azure AI Translator →文档翻译
API 版本: 2024-05-01
HTTP 方法: POST
- 使用
translate document方法同步翻译单个文档。 - 该方法不需要有 Azure Blob 存储帐户。
- 最终响应包含翻译后的文档,会直接返回给调用客户端。
重要
对文档翻译功能的所有 API 请求都需要位于 Azure 门户中资源概述页上的自定义域终结点。
请求 URL
https://{your-document-translation-endpoint}/translator/document:translate?api-version=2024-05-01&sourceLanguage=en&targetLanguage=fr
请求标头
若要通过 REST API 调用同步翻译功能,需在每个请求中包含以下标头。
| 标头 | 值 | 条件 |
|---|---|---|
| Ocp-Apim-Subscription-Key | Azure 门户中的翻译器服务密钥。 | • 必需 |
请求参数
查询字符串参数:
必需的参数
| 查询参数 | 说明 |
|---|---|
| api-version | 必需参数。 客户端所请求的 API 的版本。 当前值是 2024-05-01。 |
| targetLanguage | 必需参数。 指定输出文档的语言。 目标语言必须是翻译范围中包含的支持的语言之一。 |
可选参数
| 查询参数 | 说明 |
|---|---|
| sourceLanguage | 指定输入文档的语言。 如果未指定 sourceLanguage 参数,则会应用自动语言检测来确定源语言。 |
| allowFallback | •一个布尔值,指定当自定义系统不存在时允许服务回退到的 generalnn 系统。 接受的值为: true (默认值)或 false。 • allowFallback=false 指定翻译应仅使用针对由此请求指定的类型而训练的系统。•如果未通过特定类别找到任何系统,此请求会返回 400 状态代码。 • allowFallback=true 指定当自定义系统不存在时允许服务回退到的 generalnn 系统。 |
注释
虽然 sourceLanguage 是可选的,但我们强烈建议显式指定它。 提供源语言比依靠自动检测可以生成质量更高的翻译。
请求正文
| 名称 | 说明 | 内容类型 | 条件 |
|---|---|---|---|
| 文档 | 要翻译的源文档。 | 任何一种受支持的文档格式。 | 必需 |
| 术语表 | 包含翻译过程中要使用的具有定义的术语列表的文档。 | 任何受支持的术语表格式。 | 可选 |
响应状态代码
| 状态代码 | 说明 |
|---|---|
| 200 | 请求成功,并返回翻译的文档。 |
| 400 | 无效或缺少请求参数。 |
| 401 | 身份验证失败。 检查订阅密钥或令牌。 |
| 429 | 超出速率限制。 在短暂延迟后重试。 |
| 500 | 意外的服务错误。 重试或联系支持人员以获取请求详细信息。 |
| 503 | 服务暂时不可用。 请稍后重试。 |
注释
错误返回一个包含error对象的JSON响应。
示例 JSON 错误响应
{
"error": {
"code": "InvalidRequest",
"message": "The 'targetLanguage' parameter is required.",
"innerError": {
"requestId": "d3e4f6a9-0000-4a9b-8ad3-bdcd1323aa00",
"date": "2025-10-15T10:05:23Z"
}
}
}
例子
翻译 Word 文档
curl --request POST \
--url 'https://{your-document-translation-endpoint}/translator/document:translate?api-version=2024-05-01&sourceLanguage=en&targetLanguage=fr' \
--header 'Ocp-Apim-Subscription-Key: <your-subscription-key>'
--form 'document=@<path-to-your-document>/your-document-file.docx' \
--output translated-document-fr.docx
参数
| 参数 | 说明 |
|---|---|
{your-document-translation-endpoint} |
文档翻译终结点。 示例: https://your-resource-name.cognitiveservices.azure.cn |
<your-subscription-key> |
翻译器订阅密钥。 |
sourceLanguage |
(可选) 源代码。 示例:en。 如果未指定,则自动检测。 |
targetLanguage |
(必需) 要翻译的目标语言代码。 示例:fr。 |
document |
要翻译的文件的路径。 |
有关更多详细信息 ,请参阅支持的文档格式 。
使用术语表翻译 Word 文档
curl --request POST \
--url 'https://{your-document-translation-endpoint}/translator/document:translate?api-version=2024-05-01&sourceLanguage=en&targetLanguage=fr' \
--header 'Ocp-Apim-Subscription-Key: <your-subscription-key>' \
--form 'document=@<path-to-your-document>/your-document-file.docx' \
--form 'glossary=@<path-to-your-document>/glossary.tsv' \
--output translated-document-fr.docx
参数
| 参数 | 说明 |
|---|---|
{your-document-translation-endpoint} |
文档翻译终结点。 示例: https://your-resource-name.cognitiveservices.azure.cn |
<your-subscription-key> |
翻译器订阅密钥。 |
sourceLanguage |
(可选) 源代码。 示例:en。 如果未指定,则自动检测。 |
targetLanguage |
(必需) 要翻译的目标语言代码。 示例:fr。 |
document |
要翻译的文件的路径。 |
glossary |
术语表文件的路径。 |
有关更多详细信息,请参阅 将术语表与文档翻译配合使用 。