globalese by memoQ APIを使用したファイルの翻訳

役立つちページ

APIエンドポイントの詳細なドキュメンテーション:globalese by memoQ API v3

ワークフローを説明する関連するエンドユーザードキュメンテーション:ドキュメント翻訳

一般要件

  1. すべてのリクエストは認証されなければなりません。

  2. ペイロードを POST/PUT/PATCH リクエストで送信する際には、適切な Content-Type および Content-Length ヘッダーを常に設定する必要があります。

定義

globalese by memoQ インスタンス

ユーザーのglobalese by memoQシステム。https://acme.globalese.aiのようなURLでアクセス可能です。

エンジン

ある言語から別の言語へ翻訳できる機械翻訳モデル。

グループ

globalese by memoQでは、複数のグループを作成して使用できます。エンジンは常に特定の1つのグループに属します。ユーザーは複数のグループのメンバーであることができ、それぞれのグループで異なる権限を持つことができます。

プロジェクト

同じ設定 (言語、グループ、エンジンなど) を使用して翻訳されるファイルのコレクション。

複数のソース言語またはターゲット言語を含む翻訳プロジェクトでは、globalese by memoQで複数のプロジェクトが必要になります。

始めるのに必要なもの

globalese by memoQ インスタンスのベースURL

globalese by memoQインスタンスのURL、例:https://acme.globalese.ai。リクエストは、このベースURL + /api/v3 + エンドポイントに送信する必要があります。

ユーザー名とAPIキー

両方ともユーザーのプロファイルページにあります。以下に記載されたAPIエンドポイントへのすべての呼び出しは、有効なglobalese by memoQユーザー名とAPIキーを使用して認証されなければなりません。

推奨手順

概要

  1. プロジェクトを作成する

  2. ファイルをアップロードする

  3. 翻訳ジョブを作成する

  4. プロジェクト/ファイルのステータスをポーリングする

  5. 翻訳済みファイルをダウンロードする

  6. クリーンアップする

1.プロジェクトを作成する

グループを一覧表示するには GET /groups を、エンジンを一覧表示するには GET /engines を参照してください。

注意:

  1. グループのメンバーであることは、必ずしもファイルを翻訳するために必要な権限を持っていることを意味しません。ここで説明する手順では、認証されたユーザーは選択したグループでMANAGE_PROJECTS権限を持っている必要があります。

  2. プロジェクトは、選択したエンジンが属するのと同じグループで作成する必要があります。

  3. 選択したエンジンの状況は重要です。エンジンは、GET /engines レスポンスの actions.translate プロパティが true の場合にのみ翻訳の準備ができています。

    published プロパティによっては、一部のユーザーがエンジンを使って翻訳できる場合とできない場合があります。エンジンを公開するを参照してください。

  4. プロジェクトには、1つのエンジンのみを割り当てることができます。既存のプロジェクトのエンジンは変更可能ですが、通常は必要ありません。

リクエスト:

GET /engines
GET /groups
POST /projects

2.ファイルをアップロードする

ファイルは一度に1つずつアップロードする必要があります。

同じプロジェクトのファイルは、対応する単一のglobalese by memoQプロジェクトにグループ化することをお勧めします。globalese by memoQ プロジェクトは、ソース(またはCATツール)プロジェクトのライフタイム全体にわたって存在するのが理想的であり、新たに追加されたり再インポートされたファイルが同じ globalese by memoQ プロジェクトで処理されることを可能にします。

同じプロジェクトのソースにファイルがある場合、globalese by memoQ に送信されたファイルごとに1つのプロジェクトを作成することは推奨しません。これは不要なオーバーヘッドと余分なAPIコールを生み出すためです。

ファイルがプロジェクトに再インポートされる場合は、globalese by memoQ プロジェクト内の古いバージョンのファイルを削除し、ファイルを再アップロードすることをお勧めします。

サポートされているファイル形式のリストはこちらをご覧ください:インテグレーション

リクエスト:

POST /projects/{projectId}/files

3.翻訳ジョブを作成する

プロジェクト内のファイルの翻訳を1回のバッチで開始することをお勧めします。つまり、前のリクエストからの応答を受け取った直後に、各ファイルの翻訳ジョブを1つずつ作成します。

リクエスト:

POST /jobs/translation

4.プロジェクト/ファイルのステータスをポーリングする

この動作は将来的に変更される予定です。

現時点では、翻訳ジョブのステータスを追跡することはできませんが、これを可能にする新しいエンドポイントが計画されています。将来的には、ファイルのステータスを追跡する代わりに、ジョブのステータスを追跡する必要があります。

プロジェクト全体の状況、または個々のファイルの状況を追跡します。1分間に1回以上のポーリングリクエストを送信することはお勧めしません。

リクエスト:

GET /projects/{projectId}/files/{fileId}
GET /projects/{projectId}/files
GET /projects/{projectId}

5.翻訳済みファイルをダウンロードする

ファイルはステータスがtranslatedに変わるとダウンロードできます。プロジェクトレベルで追跡している場合、プロジェクトのステータスがtranslatedに変わると、すべてのプロジェクトファイルがダウンロード可能になります。

リクエスト:

GET /projects/{projectId}/files/{fileId}/translated-file
GET /projects/{projectId}/translated-files

6.クリーンアップする

翻訳されたファイルをダウンロードした後は、globalese by memoQからすべてのファイルとプロジェクトを削除して、globalese by memoQに永久に存在しないようにする (つまり、不必要にスペースを占有しないようにする) ことをお勧めします。

リクエスト:

DELETE /projects/{projectId}/files/{fileId}
DELETE /projects/{projectId}