Aperçu

La méthode checkSetupStatus vérifie l’état en cours d’un job 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 couvre des tâches comme l’analyse du corpus, la génération du contexte, la génération du glossaire, etc.

La configuration s’exécute automatiquement lorsque des éléments de contexte sont manquants. Concrètement, lors de votre première exécution de Traduire, vous verrez un job 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érence

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 };
}

StatutDuSetupJob

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 Error et a échoué

Exemple

Vérification de l’état de base

import { GT } from 'generaltranslation';

const gt = new GT({
  projectId: 'votre-id-de-projet',
  apiKey: 'votre-clé-api'
});


const fileRefs = [
  {
    fileId: 'file-123',
    versionId: 'version-456',
    fileName: 'app.json',
    fileFormat: 'JSON'
  },
  {
    fileId: 'file-789',
    versionId: 'version-012',
    fileName: 'contenu.md',
    fileFormat: 'MD'
  }
];

const setupResult = await gt.setupProject(fileRefs);

async function checkJobStatus(jobId: string) {
  const status = await gt.checkSetupStatus(jobId);
  
  console.log(`Tâche ${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 se charge de l’analyse du corpus, de la génération du contexte, de la création du glossaire, etc.
• Les ID de tâche sont retournés par setupProject et doivent être conservés pour vérifier l’état

Prochaines étapes

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