サポートされる用語集の形式の取得

[アーティクル]
09/01/2024

リファレンス
機能: Azure AI Translator → Document Translation
API バージョン: 2024-05-01
HTTP メソッド: GET

このメソッドは、ドキュメント翻訳機能でサポートされている用語集の形式の一覧を返します。一覧には、一般的なファイル拡張子が含まれています。

要求 URL

重要

ドキュメント翻訳機能に対するすべての API 要求に、Azure portal のリソース概要ページにあるカスタムドメインエンドポイントが必要です。

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

要求ヘッダー

要求ヘッダーを次に示します。

ヘッダー	説明	条件
Ocp-Apim-Subscription-Key	Azure portal からの Translator サービス API キー。	必須
Ocp-Apim-Subscription-Region	リソースが作成されたリージョン。	必須米国. などのリージョン (地理的) リソースを使用する場合> 行頭文字。
Content-Type	ペイロードのコンテンツタイプ。許容される値は application/json または charset=UTF-8 です。	必須

応答状態コード

要求によって返される可能性のある HTTP 状態コードを次に示します。

状態コード	説明
200	OK です。サポートされている用語集ファイル形式の一覧を返します。
500	内部サーバーエラー。
その他の状態コード	• 要求が多すぎます • サーバーの一時的な利用不可

サポートされる用語集の形式の取得の応答

一覧の基本データ型が、サポートされる用語集の形式 API で返されます。

サポートされる用語集の形式の取得の応答の成功

一覧の基本データ型が、サポートされる用語集の形式 API で返されます。

Name	種類	説明
value	FileFormat []	FileFormat[] には一覧されている詳細が含まれています。
value.contentTypes	string []	この形式がサポートされているコンテンツの種類。
value.defaultVersion	string	何も指定されていない場合は既定のバージョンです。
value.fileExtensions	string []	この形式がサポートされているファイル拡張子。
value.format	string	形式の名前。
value.versions	string []	サポートされているバージョン。

エラー応答

名前	種類	説明
code	string	高レベルのエラーコードを含む列挙型。指定できる値 • InternalServerError • InvalidArgument • InvalidRequest • RequestRateTooHigh • ResourceNotFound • ServiceUnavailable •不正
message	string	高レベルのエラーメッセージを取得します。
innerError	InnerTranslationError	Azure AI サービス API のガイドラインに準拠した新しい内部エラー形式。このエラーメッセージには、必須プロパティ ErrorCode、message、および省略可能なプロパティターゲット、details(キー値ペア)、内部エラー (入れ子にできます) が含まれています。
innerError.code	string	コードエラー文字列を取得します。
innerError.message	string	高レベルのエラーメッセージを取得します。
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"
    }
  }
}

次のステップ

クイックスタートに従って、ドキュメント翻訳とクライアントライブラリの使用について学習します。

ドキュメント変換を使ってみる

次の方法で共有