デプロイされたエンジンを使用したセグメントベースの翻訳
ここに記載されているすべてのAPIは、JSONを使用する（つまり、受け入れと返却を行う）REST APIです。
一般要件
-
すべてのリクエストは認証されなければなりません。
-
ペイロードを
POST/PUT/PATCHリクエストで送信する際には、適切なContent-TypeおよびContent-Lengthヘッダーを常に設定する必要があります。
定義
globalese by memoQ インスタンス
ユーザーのglobalese by memoQシステム。https://acme.globalese.aiのようなURLでアクセス可能です。
翻訳サービス
セグメントベースの翻訳リクエストを受け入れて処理するサービス。このサービスはglobalese by memoQインスタンスとは独立しています。
エンジン
ある言語から別の言語へ翻訳できる機械翻訳モデル。複数のソース言語またはターゲット言語を含む翻訳プロジェクトでは、複数のエンジンが必要になります。
グループ
globalese by memoQでは、複数のグループを作成して使用できます。エンジンは常に特定の1つのグループに属します。ユーザーは複数のグループのメンバーであることができ、それぞれのグループで異なる権限を持つことができます。
制限事項
-
この機能は、globalese by memoQのクラウドベースのバージョンでのみ利用可能です。
-
ストックエンジンはデプロイできません。
推奨手順
以下は、セグメントベースの翻訳機能を統合する際の推奨方法の概要と例です。
APIのドキュメンテーションに基づいて独自のアプローチを検討していただいて構いませんが、globalese by memoQで想定している統合の方法にAPIが偏っていることを念頭に置いてください。
概要
-
APIコールを行うために必要な基本情報をユーザーから収集します。
-
使用するエンジンをユーザーに選択させます。
-
選択したエンジンを使用して、1つまたは複数のセグメントを翻訳します。
1.ユーザーから必要な情報を収集する
ここで取得されたデータは、セッションをまたいで長期間保存される場合がありますが、ユーザーは将来的にそれらを変更できる必要があります。
接続を設定するユーザーは以下を提供する必要があります：
-
globalese by memoQインスタンスのベースURL（例：
https://acme.globalese.ai） -
認証手段。これは：
-
globalese by memoQユーザーのAPIキー（ユーザーは必要な権限を持っている必要があります）。
-
セグメントベースの翻訳に特定のエンジンを使用するために特別に作成されたAPIキー。これらのAPIキーはglobalese by memoQのいかなるユーザーにも関連付けられておらず、一般的には外部のユーザー（翻訳者やポストエディタなど）がglobalese by memoQでユーザーアカウントを作成せずに翻訳機能を使用できるようにするために使用されます。
-
2.globalese by memoQインスタンスAPIを使用したエンジン情報のクエリ
APIドキュメンテーションはこちらをご覧ください：エンジン情報の照会とエンジンインスタンスの管理
前提条件：
-
ユーザーから取得したベースURL
-
ユーザーから取得した認証情報
2.1.ユーザーが接続ボタンをクリックすると、globalese by memoQからエンジン、エンジンインスタンス、言語、およびグループのリストを取得します。
すでに必要な言語コンビネーションがわかっている場合は、GET /engines コールにフィルタを追加します。
エンジン
空でない instance_ids 配列を持つエンジンは、少なくとも1つのインスタンスがデプロイされています。
翻訳サービスをコールする際には、uuidの値を使用しなければなりません。
エンジンインスタンス
engine_idの値は、インスタンスが作成されたエンジンのIDです。
status が on であれば、エンジンインスタンスは翻訳リクエストを受け付ける準備ができています。
dispatcher_url の値は、翻訳サービスへのコールに必要なサービスの基本URLです。
リクエスト：
GET <Globalese instance URL>/api/v3/engines?sort=name:asc GET <Globalese instance URL>/api/v3/engine-instances GET <Globalese instance URL>/api/v3/languages?usage=engines:source GET <Globalese instance URL>/api/v3/languages?usage=engines:target GET <Globalese instance URL>/api/v3/groups?sort=name:asc
2.2.アルファベット順にソートされたエンジンのリストをユーザーに表示します。ステータスがonのインスタンスを持たないエンジンは、コンテキストを改善するためにリストに表示されますが、非アクティブである (つまり選択できない) 必要があります。
2.3.組織が大きくなるほど、エンジンの数も多くなる可能性が高くなります。したがって、以下のオプションのフィルタリングオプションを提供することをお勧めします：
-
エンジンで使用されるソース言語
-
エンジンで使用されるターゲット言語
-
グループ
認証の種類による違い
認証に使用されるAPIキーがglobalese by memoQユーザーアカウントに属している場合、グループを照会できます。翻訳専用のAPIキーの場合、GET /groupsエンドポイントは403レスポンスを返します。この場合、グループドロップダウンは非アクティブにするか、表示する必要がありません。
2.4 これらのいずれかが選択された場合、source_language、target_language、または group_ids クエリパラメータを使用してエンジンの新しいクエリを実行します。
リクエスト：
GET <Globalese instance URL>/api/v3/engines?sort=name:asc&group_ids=1,2&source_language=en&target_language=de
3.翻訳サービスAPIを使用してセグメントを翻訳する
APIドキュメンテーションはこちらをご覧ください：セグメントを翻訳する
前提条件：
-
GET /engine-instancesエンドポイントから取得した翻訳サービスのベースURL -
GET /enginesエンドポイントから取得したエンジンUUID