GT ClassMethodsTranslation
setupProject
翻訳プロジェクトの初期設定を行う setupProject メソッドのAPIリファレンス
概要
setupProject メソッドは、事前にアップロードされた files を使用して、翻訳プロジェクトのセットアップ処理を開始します。
これにより、非同期のセットアップジョブが作成され、files を解析して翻訳ワークフローの準備が行われます。
const gt = new GT({ projectId: 'your-project-id', apiKey: 'your-api-key' });
const setupResult = await gt.setupProject(fileRefs, 30000);
console.log(`セットアップジョブを作成しました: ${setupResult.setupJobId}`);setupProject を呼び出す前に、あらかじめ uploadSourceFiles を使って files をアップロードしておく必要があります。
リファレンス
パラメーター
| 名称 | 型 | 説明 |
|---|---|---|
files | FileUploadRef[] | 以前にアップロードしたソースファイルの参照をまとめた配列 |
timeoutMs? | number | API リクエストのタイムアウト（ミリ秒）※任意 |
FileUploadRef の構造体
type FileUploadRef = {
fileId: string;
versionId: string;
fileName: string;
fileFormat?: FileFormat;
dataFormat?: DataFormat;
}戻り値
Promise<SetupProjectResult> - セットアップジョブの識別子と初期ステータスを含みます。
type SetupProjectResult = {
setupJobId: string;
status: 'queued';
}| プロパティ | 型 | 説明 |
|---|---|---|
setupJobId | string | セットアップジョブの一意識別子 |
status | 'queued' | セットアップジョブの初期状態 |
例
基本的な使い方
アップロードしたfilesでプロジェクトのセットアップを初期化します。
import { GT } from 'generaltranslation';
const gt = new GT({
projectId: 'your-project-id',
apiKey: 'your-api-key'
});
// 前回のアップロードで生成されたファイル参照
const fileRefs = [
{
fileId: 'file-123',
versionId: 'version-456',
fileName: 'app.json',
fileFormat: 'JSON'
},
{
fileId: 'file-789',
versionId: 'version-012',
fileName: 'content.md',
fileFormat: 'MD'
}
];
const setupResult = await gt.setupProject(fileRefs);
console.log(`ジョブID: ${setupResult.setupJobId} でセットアップを開始しました`);注意事項
setupProjectを呼び出す前に、uploadSourceFilesを使ってファイルをアップロードする必要があります- プロジェクトのセットアップでは、翻訳ワークフローを最適化するためにファイルの内容と構造を分析します
- セットアップジョブは非同期で実行されます。進捗は
checkSetupStatusで確認してください - 新規プロジェクトで翻訳ジョブをエンキューする前に、通常はセットアップが必要です
次のステップ
- セットアップ前にファイルをアップロードするには、
uploadSourceFilesを参照してください - セットアップの進行状況を確認するには、
checkSetupStatusを参照してください - セットアップが必要かどうかを確認するには、
shouldSetupProjectを参照してください - セットアップ後に翻訳を開始するには、
enqueueFilesを参照してください
このガイドはどうでしたか？