GT ClassMethodsTranslation
checkSetupStatus
checkSetupStatus 方法的 API 参考：用于监控项目设置任务的进度
概览
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 | 要检查的设置任务的唯一标识符 |
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);注意事项
- 当缺少上下文要素时会自动运行 Setup。
- Setup 负责语料分析、上下文生成、术语表生成等。
- 作业 ID 由
setupProject返回，应保存以便检查状态
后续步骤
- 查看
setupProject以启动初始化作业 - 查看
shouldSetupProject以检查是否需要初始化 - 查看
enqueueFiles以在完成初始化后继续 - 查看
getProjectData以获取项目信息
这份指南怎么样？