GitHub

概要

checkSetupStatus メソッドは、一意の識別子でプロジェクトのセットアップジョブの現在のステータスを確認します。このメソッドは、setupProject によって開始された非同期セットアップ処理の進行状況を監視するために使用されます。セットアップでは、コーパス分析、コンテキスト生成、用語集生成などのタスクを実行します。

コンテキストの要素が不足している場合、セットアップは自動的に実行されます。通常、初めて translate を実行すると、セットアップジョブが走っているのが確認できます。

const gt = new GT({ projectId: 'your-project-id', apiKey: 'your-api-key' });

const status = await gt.checkSetupStatus('setup-job-123');
console.log(`セットアップ状況: ${status.status}`);

セットアップジョブのステータスを確認するには、事前に uploadSourceFiles と setupProject の両方を呼び出しておく必要があります。

リファレンス

パラメーター

名称	型	説明
`jobId`	`string`	確認対象のセットアップジョブの一意のid
`timeoutMs?`	`number`	APIリクエストの任意のタイムアウト（ミリ秒）

戻り値

Promise<CheckSetupStatusResult> - 現在のジョブのステータスと関連情報を含みます。

type CheckSetupStatusResult = {
  jobId: string;
  status: SetupJobStatus;
  error?: { message: string };
}

プロパティ	型	説明
`jobId`	`string`	チェック済みのセットアップジョブの識別子
`status`	`SetupJobStatus`	セットアップジョブの現在のステータス
`error?`	`{ message: string }`	ステータスが `'failed'` の場合のエラー情報

セットアップジョブステータス

type SetupJobStatus = 'queued' | 'processing' | 'completed' | 'failed';

'queued' - ジョブは処理待ちです
'processing' - ジョブを実行中です
'completed' - ジョブは正常に完了しました
'failed' - ジョブはエラーにより失敗しました

例

基本的なステータスチェック

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);

async function checkJobStatus(jobId: string) {
  const status = await gt.checkSetupStatus(jobId);
  
  console.log(`ジョブ ${jobId}:`);
  console.log(`  ステータス: ${status.status}`);
  
  if (status.error) {
    console.log(`  エラー: ${status.error.message}`);
  }
  
  return status;
}

const jobStatus = await checkJobStatus(setupResult.setupJobId);

注意事項

コンテキストの要素が不足している場合、セットアップは自動的に実行されます。
セットアップは、コーパス分析、コンテキスト生成、用語集生成などを行います。
ジョブIDはsetupProjectによって返され、ステータスの確認のために保存しておく必要があります。

次のステップ

セットアップジョブを開始するには setupProject を参照してください
セットアップが必要かどうか確認するには shouldSetupProject を参照してください
セットアップ完了後の処理を進めるには enqueueFiles を参照してください
プロジェクト情報の取得については getProjectData を参照してください

概要

const gt = new GT({ projectId: 'your-project-id', apiKey: 'your-api-key' });

const status = await gt.checkSetupStatus('setup-job-123');
console.log(`セットアップ状況: ${status.status}`);

セットアップジョブのステータスを確認するには、事前に uploadSourceFiles と setupProject の両方を呼び出しておく必要があります。

リファレンス

パラメーター

名称	型	説明
`jobId`	`string`	確認対象のセットアップジョブの一意のid
`timeoutMs?`	`number`	APIリクエストの任意のタイムアウト（ミリ秒）

戻り値

Promise<CheckSetupStatusResult> - 現在のジョブのステータスと関連情報を含みます。

type CheckSetupStatusResult = {
  jobId: string;
  status: SetupJobStatus;
  error?: { message: string };
}

プロパティ	型	説明
`jobId`	`string`	チェック済みのセットアップジョブの識別子
`status`	`SetupJobStatus`	セットアップジョブの現在のステータス
`error?`	`{ message: string }`	ステータスが `'failed'` の場合のエラー情報

セットアップジョブステータス

type SetupJobStatus = 'queued' | 'processing' | 'completed' | 'failed';

'queued' - ジョブは処理待ちです
'processing' - ジョブを実行中です
'completed' - ジョブは正常に完了しました
'failed' - ジョブはエラーにより失敗しました

例

基本的なステータスチェック

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);

async function checkJobStatus(jobId: string) {
  const status = await gt.checkSetupStatus(jobId);
  
  console.log(`ジョブ ${jobId}:`);
  console.log(`  ステータス: ${status.status}`);
  
  if (status.error) {
    console.log(`  エラー: ${status.error.message}`);
  }
  
  return status;
}

const jobStatus = await checkJobStatus(setupResult.setupJobId);

注意事項

コンテキストの要素が不足している場合、セットアップは自動的に実行されます。
セットアップは、コーパス分析、コンテキスト生成、用語集生成などを行います。
ジョブIDはsetupProjectによって返され、ステータスの確認のために保存しておく必要があります。

次のステップ

セットアップジョブを開始するには setupProject を参照してください
セットアップが必要かどうか確認するには shouldSetupProject を参照してください
セットアップ完了後の処理を進めるには enqueueFiles を参照してください
プロジェクト情報の取得については getProjectData を参照してください

概要

const gt = new GT({ projectId: 'your-project-id', apiKey: 'your-api-key' });

const status = await gt.checkSetupStatus('setup-job-123');
console.log(`セットアップ状況: ${status.status}`);

セットアップジョブのステータスを確認するには、事前に uploadSourceFiles と setupProject の両方を呼び出しておく必要があります。

リファレンス

パラメーター

名称	型	説明
`jobId`	`string`	確認対象のセットアップジョブの一意のid
`timeoutMs?`	`number`	APIリクエストの任意のタイムアウト（ミリ秒）

戻り値

Promise<CheckSetupStatusResult> - 現在のジョブのステータスと関連情報を含みます。

type CheckSetupStatusResult = {
  jobId: string;
  status: SetupJobStatus;
  error?: { message: string };
}

プロパティ	型	説明
`jobId`	`string`	チェック済みのセットアップジョブの識別子
`status`	`SetupJobStatus`	セットアップジョブの現在のステータス
`error?`	`{ message: string }`	ステータスが `'failed'` の場合のエラー情報

セットアップジョブステータス

type SetupJobStatus = 'queued' | 'processing' | 'completed' | 'failed';

'queued' - ジョブは処理待ちです
'processing' - ジョブを実行中です
'completed' - ジョブは正常に完了しました
'failed' - ジョブはエラーにより失敗しました

例

基本的なステータスチェック

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);

async function checkJobStatus(jobId: string) {
  const status = await gt.checkSetupStatus(jobId);
  
  console.log(`ジョブ ${jobId}:`);
  console.log(`  ステータス: ${status.status}`);
  
  if (status.error) {
    console.log(`  エラー: ${status.error.message}`);
  }
  
  return status;
}

const jobStatus = await checkJobStatus(setupResult.setupJobId);

注意事項

コンテキストの要素が不足している場合、セットアップは自動的に実行されます。
セットアップは、コーパス分析、コンテキスト生成、用語集生成などを行います。
ジョブIDはsetupProjectによって返され、ステータスの確認のために保存しておく必要があります。

次のステップ

セットアップジョブを開始するには setupProject を参照してください
セットアップが必要かどうか確認するには shouldSetupProject を参照してください
セットアップ完了後の処理を進めるには enqueueFiles を参照してください
プロジェクト情報の取得については getProjectData を参照してください

checkSetupStatus

概要

リファレンス

パラメーター

戻り値

セットアップジョブステータス

例

基本的なステータスチェック

注意事項

次のステップ

このページについて

checkSetupStatus

概要

リファレンス

パラメーター

戻り値

セットアップジョブステータス

例

基本的なステータスチェック

注意事項

次のステップ

このページについて

checkSetupStatus

概要

リファレンス

パラメーター

戻り値

セットアップジョブステータス

例

基本的なステータスチェック

注意事項

次のステップ

このページについて

GitHub でスターする

GitHub でスターする

checkSetupStatus

このページについて

checkSetupStatus

このページについて

checkSetupStatus

このページについて

GitHubGitHub でスターする

GitHubGitHub でスターする

GitHub でスターする

GitHub でスターする