仪表板
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 上传源文件。

参考资料

参数

名称类型描述
filesFileUploadRef[]先前上传的源文件对应的文件引用数组
timeoutMs?numberAPI 请求的可选超时（毫秒）

FileUploadRef 结构体

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

返回

Promise<SetupProjectResult> - 包含设置任务的标识符与初始状态。

type SetupProjectResult = {
  setupJobId: string;
  status: 'queued';
}
属性类型说明
setupJobIdstring设置任务的唯一标识符
status'queued'设置任务的初始状态

示例

基本用法

使用已上传的 files 初始化项目配置：

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

注意事项

  • 在调用 setupProject 之前，必须先通过 uploadSourceFiles 上传文件
  • 项目设置会分析文件内容与结构，以优化翻译流程
  • 设置任务以异步方式运行——可使用 checkSetupStatus 监控进度
  • 在为新项目加入翻译队列之前，通常需要先完成设置

后续步骤

这份指南怎么样？

querySourceFile

querySourceFile 方法的 API 参考：获取源文件及其翻译信息

shouldSetupProject

shouldSetupProject 方法的 API 参考：用于检查是否需要进行项目设置

本页内容

概览
参考资料
参数
FileUploadRef 结构体
返回
示例
基本用法
注意事项
后续步骤
setupProject