翻訳の取り消し
リファレンス
機能: Azure AI Translator → Document Translation
API バージョン: 2024-05-01
HTTP メソッド: DELETE
- このメソッドは、
idクエリ パラメーターによって要求に示されているように、現在処理中またはキューに登録されている (保留中) 翻訳ジョブを取り消します。 - 既に完了している場合、失敗した場合、または取り消し中の場合、操作は取り消されません。 これらのインスタンスでは、無効な要求が返されます。
- 完了した翻訳はキャンセルできません。また、課金されます。
要求 URL
重要
ドキュメント翻訳機能に対するすべての API 要求に、Azure portal のリソース概要ページにあるカスタム ドメイン エンドポイントが必要です。
curl -i -X DELETE "{document-translation-endpoint}/translator/document/batches/{id}?api-version={date}"
要求パラメーター
クエリ文字列に渡される要求パラメーターを次に示します。
| Query parameter (クエリ パラメーター) | 必須 | 説明 |
|---|---|---|
id |
True | 操作の ID。 |
id 値の検索
ジョブ id は、POST start-batch-translation メソッドの応答ヘッダー Operation-Location の URL 値で確認します。 /document/ パラメーターの後に続く英数字の文字列は、操作のジョブ id です。
| 応答ヘッダー | 応答 URL |
|---|---|
| Operation-Location | {document-translation-endpoint}/translator/document/9dce0aa9-78dc-41ba-8cae-2e2f3c2ff8ec?api-version=2024-05-01 |
- また、get-translations-status 要求を使用して、翻訳 "ジョブ" とその
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"
}
}
}
次のステップ
クイックスタートに従って、ドキュメント翻訳とクライアント ライブラリの使用について学習します。