Überblick

Die Methode setupProject startet den Einrichtungsprozess für ein Übersetzungsprojekt anhand zuvor hochgeladener files. Dabei wird ein asynchroner Einrichtungsauftrag erstellt, der die files analysiert und für Übersetzungs-Workflows vorbereitet.

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

const setupResult = await gt.setupProject(fileRefs, 30000);
console.log(`Setup-Job erstellt: ${setupResult.setupJobId}`);

Referenzen

Parameter

Struktur von FileUploadRef

type FileUploadRef = {
  fileId: string;
  versionId: string;
  fileName: string;
  fileFormat?: FileFormat;
  dataFormat?: DataFormat;
}

Rückgabe

Promise<SetupProjectResult> – enthält die Kennung des Setup-Jobs und den anfänglichen Status.

type SetupProjectResult = {
  setupJobId: string;
  status: 'queued';
}

Beispiele

Grundlegende Verwendung

Initialisieren Sie das Projektsetup mit hochgeladenen files:

import { GT } from 'generaltranslation';

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

// Dateireferenzen aus dem vorherigen Upload
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);
console.log(`Setup mit Job-ID gestartet: ${setupResult.setupJobId}`);

Hinweise

• files müssen mit uploadSourceFiles hochgeladen werden, bevor setupProject aufgerufen wird
• Die Projekteinrichtung analysiert Dateiinhalt und -struktur, um Übersetzungs-Workflows zu optimieren
• Der Setup-Job wird asynchron ausgeführt – überwachen Sie den Fortschritt mit checkSetupStatus
• Die Einrichtung ist in der Regel erforderlich, bevor Übersetzungsjobs für neue Projekte in die Warteschlange gestellt werden

Nächste Schritte

• Siehe uploadSourceFiles, um files vor der Einrichtung hochzuladen
• Siehe checkSetupStatus, um den Einrichtungsfortschritt zu überwachen
• Siehe shouldSetupProject, um zu prüfen, ob eine Einrichtung erforderlich ist
• Siehe enqueueFiles, um Übersetzungen nach der Einrichtung zu starten