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 utiliza para supervisar el progreso de operaciones de configuración asíncronas iniciadas por setupProject. La configuración gestiona tareas como el análisis del corpus, la generación de contexto, la generación del glosario, etc.

La configuración se ejecuta automáticamente cuando faltan elementos de contexto. Esto suele significar que, cuando ejecutas translate por primera vez, verás un trabajo de configuración en ejecució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> - Contiene el estado actual de la tarea y la información relacionada.

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

Estado del trabajo de configuració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: '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(`Trabajo ${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 de un glosario, etc.
• Los id de trabajos los devuelve setupProject y deben almacenarse para comprobar el estado.

Próximos pasos

• Consulta setupProject para iniciar las tareas de configuración
• Consulta shouldSetupProject para verificar si la configuración es necesaria
• Consulta enqueueFiles para continuar tras completar la configuración
• Consulta getProjectData para obtener información del proyecto