enqueueFiles
API Reference für die Methode enqueueFiles zum Einreihen von Übersetzungsaufträgen für files
Überblick
Die Methode enqueueFiles reiht Übersetzungsaufträge für zuvor hochgeladene files in der General Translation API ein.
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 files erst nach dem Hochladen zur Übersetzung in die Warteschlange einreihen.
Referenzen
Parameter
| Name | Typ | Beschreibung |
|---|---|---|
files | FileUploadRef[] | Array von Dateireferenzen aus zuvor hochgeladenen files |
options | EnqueueOptions | Konfigurationsoptionen für den Übersetzungsauftrag |
EnqueueOptions
| Name | Typ | Beschreibung |
|---|---|---|
sourceLocale? | string | Quell‑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? | boolean | Ob Übersetzungen nach Abschluss automatisch veröffentlicht werden |
requireApproval? | boolean | Ob Übersetzungen vor der Veröffentlichung eine Freigabe erfordern |
modelProvider? | string | Spezifischer KI‑Modellanbieter für die Übersetzung |
force? | boolean | Erneute Übersetzung erzwingen, auch wenn bereits Übersetzungen existieren |
timeout? | number | Anfrage‑Zeitüberschreitung in Millisekunden |
Rückgabe
Promise<EnqueueFilesResult> – Enthält Job-Informationen und Details zur Verarbeitung.
type EnqueueFilesResult = {
translations: CompletedFileTranslationData[];
data: Record<string, { fileName: string; versionId: string }>;
locales: string[];
message: string; // Statusmeldung der API
}| Eigenschaft | Typ | Beschreibung |
|---|---|---|
translations | CompletedFileTranslationData[] | Array mit Daten der Übersetzungsaufträge |
data | Record<string, { fileName: string; versionId: string }> | Abbildung von Datei-IDs auf Dateimetadaten |
locales | string[] | Liste der Ziel-locales für die Übersetzungsaufträge |
message | string | Statusmeldung der API |
Beispiel
// (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 in die Warteschlange einreihen
const enqueueResult = await gt.enqueueFiles(
uploadedFiles,
{
sourceLocale: 'en',
targetLocales: targetLocales,
});
// (4) Warten, bis alle Übersetzungen abgeschlossen 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
- Der Inhalt der files muss zunächst mit
uploadSourceFileshochgeladen werden - Übersetzungsjobs laufen asynchron – verwende
checkFileTranslations, um den Fortschritt zu überwachen
Nächste Schritte
- Siehe
uploadSourceFiles, um files vor dem Einreihen hochzuladen - Siehe
checkFileTranslations, um den Übersetzungsfortschritt zu überwachen - Siehe
downloadTranslatedFile, um abgeschlossene Übersetzungen herunterzuladen
Wie ist diese Anleitung?