Panoramica

Il metodo checkSetupStatus verifica lo stato attuale di un processo di configurazione del progetto tramite il suo identificatore univoco. Questo metodo viene usato per monitorare l’avanzamento delle operazioni di configurazione asincrone avviate da setupProject. La procedura di setup gestisce attività come l’analisi del corpus, la generazione del contesto, la creazione del glossario, ecc.

Il setup viene eseguito automaticamente quando mancano elementi di contesto. In genere, ciò significa che alla prima esecuzione della traduzione vedrai un processo di setup in esecuzione.

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

const status = await gt.checkSetupStatus('setup-job-123');
console.log(`Stato configurazione: ${status.status}`);

Riferimenti

Parametri

Restituisce

Promise<CheckSetupStatusResult> - Contiene lo stato attuale dell’attività e le relative informazioni.

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

StatoProcessoSetup

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

• 'queued' - Il job è in coda in attesa di elaborazione
• 'processing' - Il job è in esecuzione
• 'completed' - Il job è stato completato con successo
• 'failed' - Il job non è andato a buon fine a causa di un errore

Esempio

Verifica dello stato di base

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

const jobStatus = await checkJobStatus(setupResult.setupJobId);

Note

• La configurazione viene eseguita automaticamente quando mancano elementi del contesto.
• La configurazione si occupa dell’analisi del corpus, della generazione del contesto, della creazione del glossario, ecc.
• Gli ID dei job vengono restituiti da setupProject e devono essere salvati per verificarne lo stato

Prossimi passaggi

• Consulta setupProject per avviare i lavori di configurazione
• Consulta shouldSetupProject per verificare se la configurazione è necessaria
• Consulta enqueueFiles per procedere dopo il completamento della configurazione
• Consulta getProjectData per informazioni sul progetto