Übersicht

Die Methode checkSetupStatus prüft den aktuellen Status eines Projekt-Setup-Jobs anhand seiner eindeutigen Kennung. Sie dient dazu, den Fortschritt asynchroner Setup-Vorgänge zu überwachen, die von setupProject gestartet wurden. Das Setup übernimmt Aufgaben wie Korpusanalyse, Kontextgenerierung, Glossarerstellung usw.

Das Setup wird automatisch ausgeführt, wenn Kontextelemente fehlen. Das bedeutet in der Regel, dass beim ersten Ausführen von translate ein laufender Setup-Job angezeigt wird.

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

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

Referenzen

Parameter

Rückgabewert

Promise<CheckSetupStatusResult> – Enthält den aktuellen Auftragsstatus und zugehörige Informationen.

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

SetupJobStatus

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

• 'queued' - Auftrag wartet auf Verarbeitung
• 'processing' - Auftrag wird aktuell ausgeführt
• 'completed' - Auftrag wurde erfolgreich abgeschlossen
• 'failed' - Beim Auftrag ist ein Fehler aufgetreten; er ist fehlgeschlagen

Beispiel

Einfache Statusprüfung

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

const jobStatus = await checkJobStatus(setupResult.setupJobId);

Hinweise

• Die Einrichtung wird automatisch ausgeführt, wenn Kontextelemente fehlen.
• Die Einrichtung übernimmt die Korpusanalyse, die Kontextgenerierung, die Glossarerstellung usw.
• Job-IDs werden von setupProject zurückgegeben und sollten zur Statusabfrage gespeichert werden

Nächste Schritte

• Siehe setupProject, um Einrichtungsaufträge zu starten
• Siehe shouldSetupProject, um zu prüfen, ob eine Einrichtung erforderlich ist
• Siehe enqueueFiles, um nach Abschluss der Einrichtung fortzufahren
• Siehe getProjectData für Projektinformationen