APIジョブに人によるレビューを組み込む

翻訳をレビュー担当者に振り分け、判定状況を追跡し、最終的なドキュメントを取得します。

納品前に人の判断が必要な翻訳には、人によるレビューを追加します。エンジンは、ドキュメントと対象言語の組み合わせごとに判定プールへ振り分けます。レビュー担当者が対象ユニットを承認または編集すると、パイプラインはダウンロード可能なファイルの生成に向けて処理を続行します。

まず、APIによる翻訳が動作する状態を用意してください。人によるレビューを利用できるプラン機能、判定プール、エンジンの翻訳にアクセスできるレビュー担当者も必要です。

開始前にレビューを設定する #

エンジンのパイプラインタブを開き、人によるレビューを有効にします。判定プールと言語を選択し、必要に応じて対象ディレクトリの範囲も指定します。ディレクトリによる振り分けでは、ドキュメントごとに送信するkeyが照合されるため、emails/order-confirmation.jsonのような変更されにくいパスを使用してください。

振り分け対象のうち、新たに翻訳されたコンテンツをすべてレビューするには、すべてを選択します。この場合、品質ゲートは無効のままになります。対象を絞ってレビューするには、厳格、中程度、緩やかのいずれかを選択します。品質ゲートにはエラーが重大度とカテゴリ別に表示され、選択したレベルによって、どの重大度のエラーにレビューが必要かが決まります。品質ゲートで確認できなかった翻訳もレビューに送られます。各レベルの説明は、品質ゲートのレベルをご覧ください。再利用された翻訳は読み取り専用の参考情報として表示され、自動的に新たなレビュー対象になることはありません。

レビューチームに合ったタイムアウト時間を設定します。対象の翻訳の準備が整うと期限までのカウントが始まり、期限を過ぎると、未回答のユニットはレビュー前の翻訳のまま処理を続行できます。公開するすべての翻訳に人による判定が必要な場合は、アプリケーションの公開時チェックで、その要件が必ず満たされるようにしてください。

エンジンの設定をアプリケーションに組み込む場合は、API経由でパイプラインを設定してください。

コンテンツを送信する #

ジョブを作成し、不足している成果物をアップロードして、/startを呼び出します。ジョブの識別子を、ソースのリビジョンおよび適用するレビューポリシーとともに保存してください。エンジンのパイプライン設定は、ジョブの開始時点で取り込まれます。その後に設定を変更しても、実行中のジョブのレビューポリシーには反映されません。

ジョブのドキュメント識別子と対象ロケールを取得します。対象の翻訳のステージ進捗にあるhumanEditはレビュー作業を示し、実際のユニットと判定はレビューAPIで取得できます。レビュー担当者が作業している間、ジョブはRunningのままになることがあります。

レビュー担当者に必要な情報を提供する #

レビュー担当者は、ダッシュボードのキュー → 種類 → 人によるレビューから作業できます。品質ゲートの検出結果は翻訳の横に表示されます。翻訳は変更せずに承認することも、編集してから送信することもできます。原文、対象言語、プレースホルダー、使用すべき用語をレビュー担当者が確認できるようにしてください。

アプリケーション独自のレビュー画面を使用する場合は、GET /v2/organizations/:orgId/localization/reviewsで未完了のレビューを一覧取得し、選択したドキュメントとロケールのレビューを取得します。判定を送信する際は、バックグラウンドサービスの組織キーではなく、個人キーまたはユーザーセッションを使い、レビュー担当者として認証してください。

必須ユニットに対してApprovedまたはEditedの判定を送信します。内部レビューでは、一部の判定だけを送信できます。外部レビューを引き継ぐ場合は、残りの必須ユニットすべての判定を一度に送信する必要があり、その場合でも提供元の料金が発生することがあります。正確なペイロードとエラーについては、レビューのリファレンスをご覧ください。

最終結果を取得して検証する #

レビュー担当者が判定を送信した後も、ローカライズジョブの取得を続けます。対象の翻訳は、ステータスがCompletedになってからダウンロードしてください。レビュー後の編集、長さの調整、逆翻訳が引き続き実行される場合があるため、レビューの完了とファイルの完成は別です。

人が承認した文言をそのまま使用する必要がある場合は、後続の書き換えステージを無効にし、最終出力を確認してください。承認の証拠が必要な場合は、レビューの判定とタイムアウトしたユニットを確認してください。ステージの完了だけをもって、人がすべてのユニットを承認した証拠とみなさないでください。

ソースのリビジョンが引き続き一致し、必要なレビューポリシーが満たされている場合にのみ公開します。遅れて届いた翻訳で、より新しいソースリビジョンの出力を置き換えてはいけません。

中断から復旧する #

クライアントがタイムアウトした後も、元のジョブとレビューの識別情報を保持してください。新しいジョブを作成すると、別の翻訳・レビュープロセスが始まります。判定の送信に対する応答が失われた場合は、レビューを取得し、保存された判定とレビュー担当者の識別子を確認します。対象の翻訳がまだ送信を受け付けていれば、同じレビュー担当者が同一の判定を再送信できます。ただし、対象の翻訳が完了済みの場合は、最初の送信が成功していても409が返されることがあります。正常に受け付けられた判定は確定し、変更できません。

レビューの期限に達したら、受け付けられた判定、未回答のユニット、生成されたファイルを確認してください。完了した作業を保持したうえで、公開を保留する、別のレビューを受ける、明示的に定義した代替処理を受け入れるなど、次の対応を慎重に選択してください。