Обзор

Метод checkSetupStatus проверяет текущий статус задания по настройке проекта по его уникальному идентификатору. Этот метод используется для отслеживания прогресса асинхронных операций настройки, инициированных методом setupProject. Процесс настройки включает задачи, такие как анализ корпуса, создание контекста, формирование глоссария и т. п.

Настройка запускается автоматически, когда отсутствуют элементы контекста. Обычно это означает, что при первом запуске перевода вы увидите выполняющееся задание настройки.

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

const status = await gt.checkSetupStatus('setup-job-123');
console.log(`Статус установки: ${status.status}`);

Справочник

Параметры

Возвращает

Promise<CheckSetupStatusResult> — содержит текущий статус задачи и сопутствующую информацию.

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

Статус задания по настройке

type SetupJobStatus = 'ожидает' | 'в обработке' | 'завершено' | 'сбой';

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

Примечания

• Инициализация запускается автоматически, если отсутствуют элементы контекста.
• Инициализация выполняет анализ корпуса, генерацию контекста, глоссария и т. д.
• Идентификаторы задач возвращаются методом setupProject и их следует сохранять для последующей проверки статуса

Дальнейшие шаги

• См. setupProject, чтобы запустить задачи по настройке
• См. shouldSetupProject, чтобы проверить, нужна ли настройка
• См. enqueueFiles, чтобы продолжить после завершения настройки
• См. getProjectData для сведений о проекте