获取支持的词汇表格式

项目
09/09/2024

参考
功能：Azure AI 翻译 → 文档翻译
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 门户的 Translator 服务 API 密钥。	必需
Ocp-Apim-Subscription-Region	创建资源的区域。	使用区域（地理）资源（如“中国北部”）时为必需。 &bullet.
Content-Type	有效负载的内容类型。接受的值为 application/json 或 charset=UTF-8。	必需

响应状态代码

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

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

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

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

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

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

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

错误响应

名称	Type	说明
code	string	包含错误代码概要的枚举。可能的值： • InternalServerError • InvalidArgument • InvalidRequest • RequestRateTooHigh • ResourceNotFound • ServiceUnavailable • 未授权
message	字符串	获取概要错误消息。
innerError	InnerTranslationError	符合 Azure AI 服务 API 准则的新的内部错误格式。此错误消息包含必需的属性 ErrorCode、消息和可选属性目标、详细信息（键值对）、内部错误（可以嵌套）。
innerError.code	字符串	获取代码错误字符串。
innerError.message	字符串	获取概要错误消息。
innerError.target	string	获取错误的源。例如，如果存在无效文档，它为 `documents` 或 `document 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"
    }
  }
}

后续步骤

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

文档翻译入门

通过