Descripción general

El método checkSetupStatus comprueba el estado actual de un trabajo de configuración de proyecto mediante su identificador único. Este método se usa para supervisar el progreso de operaciones de configuración asíncronas iniciadas por setupProject. La configuración se encarga de tareas como el análisis de corpus, la generación de contexto, la generación de glosarios, etc.

La configuración se ejecuta automáticamente cuando faltan elementos del contexto. Por lo general, esto significa que, la primera vez que ejecutes translate, verás que se está ejecutando un trabajo de configuración.

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

const status = await gt.checkSetupStatus('setup-job-123');
console.log(`Estado de configuración: ${status.status}`);

Referencias

Parámetros

Devuelve

Promise<CheckSetupStatusResult> - Incluye el estado actual de la tarea y la información relacionada.

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

EstadoDelTrabajoDeConfiguración

type SetupJobStatus = 'queued' | 'processing' | 'completed' | 'failed';

• 'queued' - El trabajo está en espera de procesamiento
• 'processing' - El trabajo se está ejecutando
• 'completed' - El trabajo se completó correctamente
• 'failed' - El trabajo encontró un error y falló

Ejemplo

Comprobación básica del estado

import { GT } from 'generaltranslation';

const gt = new GT({
  projectId: 'tu-projectId',
  apiKey: 'tu-apiKey'
});


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(`Job ${jobId}:`);
  console.log(`  Estado: ${status.status}`);
  
  if (status.error) {
    console.log(`  Error: ${status.error.message}`);
  }
  
  return status;
}

const jobStatus = await checkJobStatus(setupResult.setupJobId);

Notas

• La configuración se ejecuta automáticamente cuando faltan elementos del contexto.
• La configuración se encarga del análisis del corpus, la generación de contexto, la generación del glosario, etc.
• Los ID de tarea los devuelve setupProject y deben almacenarse para comprobar el estado

Próximos pasos

• Consulta setupProject para iniciar tareas de configuración
• Consulta shouldSetupProject para comprobar si es necesaria la configuración
• Consulta enqueueFiles para continuar una vez completada la configuración
• Consulta getProjectData para obtener información del proyecto