你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn

获取支持的词汇表格式

参考
功能: Azure Translator → 文档翻译
API 版本: 2024-05-01
HTTP 方法: GET

此方法返回文档翻译功能支持的术语表格式列表。 此列表包括常用文件扩展名。

请求 URL

重要

对文档翻译功能的所有 API 请求都需要位于 Azure 门户中资源概述页上的自定义域终结点

curl -i -X GET "{document-translation-endpoint}/translator/document/formats?api-version={date}&type=glossary"

请求标头

请求标头为:

头文件 说明 条件
Ocp-Apim-Subscription-Key Azure 门户中的翻译 API 密钥。 必需
Ocp-Apim-Subscription-Region 创建资源的区域。 &项目符号。
内容类型 有效负载的内容类型。 接受的值为 application/jsoncharset=UTF-8 必需

响应状态代码

下面是请求可能返回的 HTTP 状态代码。

状态代码 说明
200 没问题。 返回受支持术语表文件格式的列表。
500 内部服务器错误。
其他状态代码 • 请求过多
• 服务器暂不可用

获取支持的术语表格式响应

获取支持的术语表格式 API 中将返回基类型列表。

成功获取支持的术语表格式响应

获取支持的术语表格式 API 中将返回基类型列表。

名称 类型 说明
FileFormat [] FileFormat[] 包含列出的详细信息。
value.contentTypes string [] 此格式受支持的内容类型。
value.defaultVersion 字符串 如果未指定,则为默认版本
value.fileExtensions string [] 此格式支受持的文件扩展名。
value.format 字符串 格式名称。
value.versions string [] 受支持的版本。

错误响应

名称 类型 说明
代码 字符串 包含错误代码概要的枚举。 接受的值:
• InternalServerError
• InvalidArgument
• InvalidRequest
• RequestRateTooHigh
• ResourceNotFound
• ServiceUnavailable
• 未授权
消息 字符串 获取概要错误消息。
innerError InnerTranslationError 符合 Foundry 工具 API 指南的新内部错误格式。 此错误消息包含必需的属性 ErrorCode、消息和可选属性目标、详细信息(键值对)、内部错误(可以嵌套)。
innerError.code 字符串 获取代码错误字符串。
innerError.message 字符串 获取概要错误消息。
innerError.target 字符串 获取错误的源。 例如,如果存在无效文档,它为 documentsdocument id

示例

成功响应示例

以下 JSON 对象是成功响应的示例。

{
    "value": [
        {
            "format": "XLIFF",
            "fileExtensions": [
                ".xlf"
            ],
            "contentTypes": [
                "application/xliff+xml"
            ],
            "defaultVersion": "1.2",
            "versions": [
                "1.0",
                "1.1",
                "1.2"
            ]
        },
        {
            "format": "TSV",
            "fileExtensions": [
                ".tsv",
                ".tab"
            ],
            "contentTypes": [
                "text/tab-separated-values"
            ]
        },
        {
            "format": "CSV",
            "fileExtensions": [
                ".csv"
            ],
            "contentTypes": [
                "text/csv"
            ]
        }
    ]
}

错误响应示例

以下 JSON 对象是错误响应的示例。 其他错误代码的架构相同。

状态代码:500

{
  "error": {
    "code": "InternalServerError",
    "message": "Internal Server Error",
    "innerError": {
      "code": "InternalServerError",
      "message": "Unexpected internal server error has occurred"
    }
  }
}

后续步骤

按照快速入门详细了解如何使用文档翻译和客户端库。