Share via

翻訳の取り消し

  • [アーティクル]

リファレンス
サービス: Azure AI ドキュメント翻訳
API バージョン: v1.1

現在処理中またはキューに入っている操作をキャンセルします。 完了した場合、失敗した場合、または取り消された場合、操作は取り消されません。 不正な要求が返されます。 完了した翻訳は取り消されず、課金されます。 可能であれば、保留中のすべての翻訳が取り消されます。

要求 URL

DELETE 要求の送信先は次のとおりです。

https://<NAME-OF-YOUR-RESOURCE>.cognitiveservices.azure.com/translator/text/batch/v1.1/batches/{id}

カスタム ドメイン名を見つける方法について説明します。

重要

  • ドキュメント翻訳サービスへのすべての API 要求には、カスタム ドメイン エンドポイントが必要です。
  • ドキュメント翻訳への HTTP 要求を行うために、Azure portal リソースの [キーとエンドポイント] ページで見つかるエンドポイントも、グローバル Translator エンドポイント api.cognitive.microsofttranslator.com も使用することはできません。

要求パラメーター

クエリ文字列に渡される要求パラメーターを次に示します。

Query parameter (クエリ パラメーター) 必須 説明
id True 操作の ID。

要求ヘッダー

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

ヘッダー 説明
Ocp-Apim-Subscription-Key 必要な要求ヘッダー

応答状態コード

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

状態コード 説明
200 OK です。 送信された要求を取り消す
401 権限がありません。 資格情報を確認してください。
404 見つかりません。 リソースが見つかりません。
500 内部サーバー エラー。
その他の状態コード • 要求が多すぎます
• サーバーの一時的な利用不可

翻訳の取り消しの応答

成功応答

成功した応答では、次の情報が返されます。

名前 種類 説明
id string 操作の ID。
createdDateTimeUtc string 操作が作成された日時。
lastActionDateTimeUtc string 操作の状態が更新される日時。
status String ジョブまたはドキュメントで使用可能な状態の一覧: • 取り消されました
•キャンセル
•失敗 しました
• NotStarted
•実行
•成功
• ValidationFailed
まとめ StatusSummary 詳細の一覧を含む概要。
summary.total 整数 (integer) ドキュメントの合計数。
summary.failed 整数 (integer) ドキュメントの失敗数。
summary.success 整数 (integer) 正常に翻訳されたドキュメントの数。
summary.inProgress 整数 (integer) 進行中のドキュメントの数。
summary.notYetStarted 整数 (integer) まだ処理を開始していないドキュメントの数。
summary.cancelled 整数 (integer) 取り消された数。
summary.totalCharacterCharged 整数 (integer) API によって課金される文字数合計。

エラー応答

名前 種類 説明
code string 高レベルのエラー コードを含む列挙型。 指定できる値
• InternalServerError
• InvalidArgument
• InvalidRequest
• RequestRateTooHigh
• ResourceNotFound
• ServiceUnavailable
•不正
message string 高レベルのエラー メッセージを取得します。
ターゲット (target) string エラーのソースを取得します。 たとえば、無効なドキュメントの場合 "documents" または document id となります。
innerError InnerTranslationError Azure AI サービス API のガイドラインに準拠した新しい内部エラー形式。 必須プロパティとして ErrorCode、message、省略可能プロパティとして target、details (キーと値のペア)、inner error (入れ子が可能) がこのエラー メッセージに含まれています。
innerError.code string コード エラー文字列を取得します。
innerError.message string 高レベルのエラー メッセージを取得します。
innerError.target string エラーのソースを取得します。 たとえば、無効なドキュメントがあった場合には documents か document id になります。

例

成功した応答の例

次の JSON オブジェクトは、成功時の応答の例です。

状態コード:200

{
  "id": "727bf148-f327-47a0-9481-abae6362f11e",
  "createdDateTimeUtc": "2020-03-26T00:00:00Z",
  "lastActionDateTimeUtc": "2020-03-26T01:00:00Z",
  "status": "Succeeded",
  "summary": {
    "total": 10,
    "failed": 1,
    "success": 9,
    "inProgress": 0,
    "notYetStarted": 0,
    "cancelled": 0,
    "totalCharacterCharged": 0
  }
}

エラー応答の例

次の JSON オブジェクトは、エラー応答の例です。 他のエラー コードのスキーマも同じです。

状態コード: 500

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

次のステップ

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

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