Vue d’ensemble

La méthode checkSetupStatus vérifie l’état actuel d’une tâche de configuration de projet à l’aide de son identifiant unique. Elle sert à suivre l’avancement des opérations de configuration asynchrones lancées par setupProject. La configuration prend en charge des tâches telles que l’analyse du corpus, la génération du contexte, la création du glossaire, etc.

La configuration s’exécute automatiquement lorsque des éléments de contexte sont manquants. Concrètement, lors de la première exécution de translate, vous verrez une tâche de configuration en cours.

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

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

Références

Paramètres

Renvoie

Promise<CheckSetupStatusResult> - Contient l’état actuel de la tâche et les informations associées.

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

ÉtatDuJobDeConfiguration

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

• 'queued' - La tâche est en attente de traitement
• 'processing' - La tâche est en cours d’exécution
• 'completed' - La tâche s’est terminée avec succès
• 'failed' - La tâche a rencontré une erreur et a échoué

Exemple

Vérification de l’état de 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(`Travail ${jobId}:`);
  console.log(`  Statut: ${status.status}`);
  
  if (status.error) {
    console.log(`  Erreur: ${status.error.message}`);
  }
  
  return status;
}

const jobStatus = await checkJobStatus(setupResult.setupJobId);

Notes

• La configuration s’exécute automatiquement lorsque des éléments de contexte sont manquants.
• La configuration gère l’analyse du corpus, la génération du contexte, la génération du glossaire, etc.
• Les IDs de job sont renvoyés par setupProject et doivent être conservés pour vérifier l’état

Prochaines étapes

• Consultez setupProject pour lancer les tâches de configuration
• Consultez shouldSetupProject pour vérifier si une configuration est nécessaire
• Consultez enqueueFiles pour poursuivre après la fin de la configuration
• Consultez getProjectData pour obtenir des informations sur le projet