GT ClassMethodsTranslation

setupProject

Справка по API для метода setupProject, который инициализирует настройку проекта перевода

Обзор

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

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.

Справка

Параметры

ИмяТипОписание
filesFileUploadRef[]Массив ссылок на ранее загруженные исходные файлы
timeoutMs?numberНеобязательный тайм-аут в миллисекундах для запроса к API

Структура FileUploadRef

type FileUploadRef = {
  fileId: string;
  versionId: string;
  fileName: string;
  fileFormat?: FileFormat;
  dataFormat?: DataFormat;
}

Возвращает

Promise<SetupProjectResult> — содержит идентификатор задания по настройке и начальный статус.

type SetupProjectResult = {
  setupJobId: string;
  status: 'queued';
}
СвойствоТипОписание
setupJobIdstringУникальный идентификатор задания настройки
status'queued'Начальный статус задания настройки

Примеры

Базовое использование

Инициализация проекта с загруженными файлами:

index.ts
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}`);

Примечания

  • Файлы необходимо загрузить с помощью uploadSourceFiles перед вызовом setupProject
  • Во время настройки проекта анализируются содержимое и структура файлов для оптимизации процессов перевода
  • Задача настройки выполняется асинхронно — отслеживайте ход выполнения с помощью checkSetupStatus
  • Настройка, как правило, требуется перед постановкой в очередь задач перевода для новых проектов

Дальнейшие действия

  • См. uploadSourceFiles, чтобы загрузить файлы до настройки
  • См. checkSetupStatus, чтобы отслеживать ход настройки
  • См. shouldSetupProject, чтобы проверить, требуется ли настройка
  • См. enqueueFiles, чтобы запустить переводы после настройки

Насколько полезно это руководство?

setupProject