GT ClassMethodsTranslation

enqueueFiles

API-Referenz zur Methode enqueueFiles zum Einreihen von Übersetzungsaufträgen für Dateien

Überblick

Die Methode enqueueFiles stellt Übersetzungsaufträge für zuvor hochgeladene Dateien in der General Translation API in die Warteschlange. Diese Methode nimmt Dateireferenzen entgegen und erstellt Übersetzungsaufträge für die angegebenen Ziel-Locales.

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

const result = await gt.enqueueFiles(fileRefs, {
  sourceLocale: 'en',
  targetLocales: ['es', 'fr', 'de']
});

Sie können Dateien erst zur Übersetzung in die Warteschlange stellen, nachdem sie hochgeladen wurden.

Referenzen

Parameter

NameTypBeschreibung
filesFileUploadRef[]Array von Dateiverweisen aus zuvor hochgeladenen Dateien
optionsEnqueueOptionsKonfigurationsoptionen für den Übersetzungsauftrag

EnqueueOptions

NameTypeBeschreibung
sourceLocale?stringQuell-Locale für die Übersetzung (standardmäßig die Instanz-sourceLocale)
targetLocales?string[]Array der Ziel-Locales für die Übersetzung (standardmäßig die Instanz-targetLocale)
publish?booleanOb Übersetzungen nach Abschluss automatisch veröffentlicht werden sollen
requireApproval?booleanOb Übersetzungen vor der Veröffentlichung eine Freigabe erfordern
modelProvider?stringKonkreter KI-Modellanbieter für die Übersetzung
force?booleanNeuübersetzung erzwingen, selbst wenn bereits Übersetzungen vorhanden sind
timeout?numberZeitüberschreitung für Anfragen in Millisekunden

Rückgabe

Promise<EnqueueFilesResult> – Enthält Auftragsinformationen und Verarbeitungsdetails.

type EnqueueFilesResult = {
  translations: CompletedFileTranslationData[];
  data: Record<string, { fileName: string; versionId: string }>;
  locales: string[];
  message: string;
}
EigenschaftTypBeschreibung
translationsCompletedFileTranslationData[]Array mit Daten zu Übersetzungsaufträgen
dataRecord<string, { fileName: string; versionId: string }>Zuordnung von Datei-IDs zu Dateimetadaten
localesstring[]Liste der Ziel-Locales für die Übersetzungsaufträge
messagestringStatusmeldung der API

Beispiel

index.ts
// (1) Eine GT-Instanz erstellen
const targetLocales = ['es', 'fr', 'de'];
const gt = new GT({
  projectId: 'your-project-id',
  apiKey: 'your-api-key',
});

// (2) Datei hochladen
const fileUpload = {
  content: fileContents,
  fileName: filePath,
  fileFormat: 'JSON',
  locale: 'en',
};
const files = [ { source: fileUpload } ];
const { uploadedFiles } = await gt.uploadSourceFiles(
  files,
  { sourceLocale: 'en' }
);

// (3) Übersetzungsauftrag für die Datei einreihen
const enqueueResult = await gt.enqueueFiles(
  uploadedFiles,
  {
  sourceLocale: 'en',
  targetLocales: targetLocales,
});

// (4) Warten, bis alle Übersetzungen fertig sind
let translationIds = [];
const statusQuery = Object.values(enqueueResult.data).flatMap(({fileName, versionId}) => {
  return targetLocales.map((locale) => ({locale, fileName, versionId}));
});
while (true) {
  const status = await gt.checkFileTranslations(statusQuery);
  if (status.translations.length === statusQuery.length) {
    translationIds = status.translations.map(translation => translation.id);
    break;
  }
  await new Promise(resolve => setTimeout(resolve, 1000));
}

// (5) Datei herunterladen
const result = await gt.downloadFileBatch(translationIds);

Hinweise

Nächste Schritte

Wie ist dieser Leitfaden?

enqueueFiles