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 | 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以在完成设置后开始启动翻译
本指南如何?