GitHub

Übersicht

Dieser Leitfaden führt Sie durch die Grundlagen der Verwendung der Bibliothek generaltranslation. Wir behandeln die Übersetzung von Zeichenketten und Dateien.

Übersetzen Sie Ihren ersten String

1. Richten Sie Ihre Umgebungsvariablen ein

Der erste Schritt ist, GT_PROJECT_ID und GT_API_KEY zu erstellen. Das ist völlig kostenlos und verschafft Ihnen Zugriff auf die Übersetzungsdienste.

Navigieren Sie zur Seite API Keys und klicken Sie auf Create API Key. Wählen Sie einen Namen für Ihren API-Schlüssel und klicken Sie auf Create.

API-Schlüssel-Seite

General Translation bietet sehr großzügige kostenlose Ratenlimits, um persönliche Projekte, Solo-Entwickler und die Community zu unterstützen.

2. Initialisieren Sie die GT-Klasse

Initialisieren Sie die GT-Klasse und übergeben Sie sicher Ihre GT_PROJECT_ID und GT_API_KEY.

src/index.ts

import { GT } from 'generaltranslation';

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

3. Übersetzen Sie Ihren ersten String

Rufen Sie die Methode translate auf, um Ihren String zu übersetzen. Übergeben Sie den zu übersetzenden String und das Ziel-locale.

src/index.ts

const { translation } = await gt.translate('Hello, world!', 'es'); // Spanisch

console.log(translation); // "¡Hola, mundo!"

Wenn Sie einen locale code nachschlagen möchten, sehen Sie sich die Seite Supported locales an.

In diesem Leitfaden wird vorausgesetzt, dass du bereits die Schritte 1 und 2 des Leitfadens Übersetze deinen ersten String abgeschlossen hast und über eine GT_PROJECT_ID, einen GT_API_KEY sowie eine GT-Klasseninstanz verfügst.

Angenommen, du möchtest eine Datei namens en.json ins Spanische übersetzen.

en.json

{
  "hello": "Hallo",
  "world": "Welt"
}

Um eine Datei zu übersetzen, gehen Sie wie folgt in vier Schritten vor:

Laden Sie die Datei hoch
Stellen Sie die Datei zur Übersetzung in die Warteschlange
Prüfen Sie den Status der Datei (optional)
Laden Sie die übersetzte Datei herunter.

Warum nicht einfach ein einziger Aufruf?

In der Regel möchten Nutzer viele Dateien auf einmal übersetzen. Durch die Aufteilung in vier klare Schritte erhalten Nutzer deutlich mehr Flexibilität bei der Nutzung der API.

1. Datei hochladen

Beim Hochladen von Dateien erhalten Sie mit der Methode uploadSourceFiles eine Liste von Dateireferenzen. Damit können Sie die Datei später zur Übersetzung in die Warteschlange stellen, den Status der Datei prüfen und die übersetzte Datei herunterladen.

src/index.ts

import fs from 'fs';
import path from 'path';
import { FileUpload } from 'generaltranslation';

// (i) Dateiinhalt lesen
const filePath = path.join(process.cwd(), 'en.json');
const fileContents = fs.readFileSync(filePath, 'utf8');

// (ii) Dateiinhalt formatieren
const fileUpload: FileUpload = {
  content: fileContents,
  fileName: filePath,
  fileFormat: 'JSON',
  locale: 'en',
};
const files = [ { source: fileUpload } ];

// (iii) Datei hochladen
const { uploadedFiles } = await gt.uploadSourceFiles(
  files,
  {
    sourceLocale: 'en'
  }
);

Dies gibt eine Liste von Dateireferenzen zurück:

Output

[
  {
    fileId: '41726368696562616c64204d6342616c64792074686973206973206a6f6b652e',
    versionId: '427269616e204c6f75206d6f7265206c696b65204c696f6e2042726f20686121',
    fileName: '/Users/demo/en.json',
    fileFormat: 'JSON'
  }
]

2. Datei zur Übersetzung in die Warteschlange aufnehmen

Der nächste Schritt besteht darin, die Ziel-locales für die Übersetzung mit der Methode enqueueFiles auszuwählen. In diesem Fall übersetzen wir ins Spanische.

src/index.ts

const fileUploadRef = {
  fileId: uploadedFiles[0].fileId,
  versionId: uploadedFiles[0].versionId,
  fileName: uploadedFiles[0].fileName,
  fileFormat: uploadedFiles[0].fileFormat,
};
const enqueueResult = await gt.enqueueFiles(
  [fileUploadRef],
  {
  sourceLocale: 'en',
  targetLocales: ['es'],
});

Dadurch wird eine Liste von Dateiverweisen zurückgegeben:

Output

{
  translations: [],
  data: {
    '41726368696562616c64204d6342616c64792074686973206973206a6f6b652e': {
      fileName: '/Users/demo/en.json',
      versionId: '427269616e204c6f75206d6f7265206c696b65204c696f6e2042726f20686121'
    }
  },
  locales: [ 'es' ],
  message: 'Erstelle 1 Übersetzung(en).'
}

3. Dateistatus prüfen

Okay, jetzt, da die Datei hochgeladen ist – woher wissen wir, dass sie zum Download bereit ist? Wir können die Methode checkFileTranslations verwenden, um den Status der Datei zu überprüfen.

src/index.ts

const status = await gt.checkFileTranslations([{
  versionId: uploadedFiles[0].versionId,
  fileName: uploadedFiles[0].fileName,
  locale: 'es'
}]);

Wenn die Datei noch übersetzt wird, gibt es in der Ausgabe keine entsprechenden Übersetzungen.

Output

{
  translations: [
    {
      locale: 'es',
      metadata: {},
      fileId: '41726368696562616c64204d6342616c64792074686973206973206a6f6b652e',
      fileName: '/Users/demo/en.json',
      versionId: '427269616e204c6f75206d6f7265206c696b65204c696f6e2042726f20686121',
      id: 'skl44z0ieuvdcomw38zb5chv',
      isReady: true,
      downloadUrl: '/v2/project/translations/files/skl44z0ieuvdcomw38zb5chv/download'
    }
  ]
}

4. Übersetzte Datei herunterladen

Zum Schluss können wir die übersetzte Datei mit der Methode downloadTranslatedFile herunterladen.

src/index.ts

const { translation } = await gt.downloadTranslatedFile({
  fileId: uploadedFiles[0].fileId,
  locale: 'es',
  versionId: uploadedFiles[0].versionId,
});

Dadurch wird der übersetzte Dateiinhalt zurückgegeben:

Output

{
  "hello": "Hallo",
  "world": "Welt"
}

Übersicht

Dieser Leitfaden führt Sie durch die Grundlagen der Verwendung der Bibliothek generaltranslation. Wir behandeln die Übersetzung von Zeichenketten und Dateien.

Übersetzen Sie Ihren ersten String

1. Richten Sie Ihre Umgebungsvariablen ein

Der erste Schritt ist, GT_PROJECT_ID und GT_API_KEY zu erstellen. Das ist völlig kostenlos und verschafft Ihnen Zugriff auf die Übersetzungsdienste.

Navigieren Sie zur Seite API Keys und klicken Sie auf Create API Key. Wählen Sie einen Namen für Ihren API-Schlüssel und klicken Sie auf Create.

API-Schlüssel-Seite

General Translation bietet sehr großzügige kostenlose Ratenlimits, um persönliche Projekte, Solo-Entwickler und die Community zu unterstützen.

2. Initialisieren Sie die GT-Klasse

Initialisieren Sie die GT-Klasse und übergeben Sie sicher Ihre GT_PROJECT_ID und GT_API_KEY.

src/index.ts

import { GT } from 'generaltranslation';

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

3. Übersetzen Sie Ihren ersten String

Rufen Sie die Methode translate auf, um Ihren String zu übersetzen. Übergeben Sie den zu übersetzenden String und das Ziel-locale.

src/index.ts

const { translation } = await gt.translate('Hello, world!', 'es'); // Spanisch

console.log(translation); // "¡Hola, mundo!"

Wenn Sie einen locale code nachschlagen möchten, sehen Sie sich die Seite Supported locales an.

Übersetze deine erste Datei

Angenommen, du möchtest eine Datei namens en.json ins Spanische übersetzen.

en.json

{
  "hello": "Hallo",
  "world": "Welt"
}

Um eine Datei zu übersetzen, gehen Sie wie folgt in vier Schritten vor:

Laden Sie die Datei hoch
Stellen Sie die Datei zur Übersetzung in die Warteschlange
Prüfen Sie den Status der Datei (optional)
Laden Sie die übersetzte Datei herunter.

Warum nicht einfach ein einziger Aufruf?

In der Regel möchten Nutzer viele Dateien auf einmal übersetzen. Durch die Aufteilung in vier klare Schritte erhalten Nutzer deutlich mehr Flexibilität bei der Nutzung der API.

1. Datei hochladen

src/index.ts

import fs from 'fs';
import path from 'path';
import { FileUpload } from 'generaltranslation';

// (i) Dateiinhalt lesen
const filePath = path.join(process.cwd(), 'en.json');
const fileContents = fs.readFileSync(filePath, 'utf8');

// (ii) Dateiinhalt formatieren
const fileUpload: FileUpload = {
  content: fileContents,
  fileName: filePath,
  fileFormat: 'JSON',
  locale: 'en',
};
const files = [ { source: fileUpload } ];

// (iii) Datei hochladen
const { uploadedFiles } = await gt.uploadSourceFiles(
  files,
  {
    sourceLocale: 'en'
  }
);

Dies gibt eine Liste von Dateireferenzen zurück:

Output

[
  {
    fileId: '41726368696562616c64204d6342616c64792074686973206973206a6f6b652e',
    versionId: '427269616e204c6f75206d6f7265206c696b65204c696f6e2042726f20686121',
    fileName: '/Users/demo/en.json',
    fileFormat: 'JSON'
  }
]

2. Datei zur Übersetzung in die Warteschlange aufnehmen

Der nächste Schritt besteht darin, die Ziel-locales für die Übersetzung mit der Methode enqueueFiles auszuwählen. In diesem Fall übersetzen wir ins Spanische.

src/index.ts

const fileUploadRef = {
  fileId: uploadedFiles[0].fileId,
  versionId: uploadedFiles[0].versionId,
  fileName: uploadedFiles[0].fileName,
  fileFormat: uploadedFiles[0].fileFormat,
};
const enqueueResult = await gt.enqueueFiles(
  [fileUploadRef],
  {
  sourceLocale: 'en',
  targetLocales: ['es'],
});

Dadurch wird eine Liste von Dateiverweisen zurückgegeben:

Output

{
  translations: [],
  data: {
    '41726368696562616c64204d6342616c64792074686973206973206a6f6b652e': {
      fileName: '/Users/demo/en.json',
      versionId: '427269616e204c6f75206d6f7265206c696b65204c696f6e2042726f20686121'
    }
  },
  locales: [ 'es' ],
  message: 'Erstelle 1 Übersetzung(en).'
}

3. Dateistatus prüfen

Okay, jetzt, da die Datei hochgeladen ist – woher wissen wir, dass sie zum Download bereit ist? Wir können die Methode checkFileTranslations verwenden, um den Status der Datei zu überprüfen.

src/index.ts

const status = await gt.checkFileTranslations([{
  versionId: uploadedFiles[0].versionId,
  fileName: uploadedFiles[0].fileName,
  locale: 'es'
}]);

Wenn die Datei noch übersetzt wird, gibt es in der Ausgabe keine entsprechenden Übersetzungen.

Output

{
  translations: [
    {
      locale: 'es',
      metadata: {},
      fileId: '41726368696562616c64204d6342616c64792074686973206973206a6f6b652e',
      fileName: '/Users/demo/en.json',
      versionId: '427269616e204c6f75206d6f7265206c696b65204c696f6e2042726f20686121',
      id: 'skl44z0ieuvdcomw38zb5chv',
      isReady: true,
      downloadUrl: '/v2/project/translations/files/skl44z0ieuvdcomw38zb5chv/download'
    }
  ]
}

4. Übersetzte Datei herunterladen

Zum Schluss können wir die übersetzte Datei mit der Methode downloadTranslatedFile herunterladen.

src/index.ts

const { translation } = await gt.downloadTranslatedFile({
  fileId: uploadedFiles[0].fileId,
  locale: 'es',
  versionId: uploadedFiles[0].versionId,
});

Dadurch wird der übersetzte Dateiinhalt zurückgegeben:

Output

{
  "hello": "Hallo",
  "world": "Welt"
}

Übersicht

Dieser Leitfaden führt Sie durch die Grundlagen der Verwendung der Bibliothek generaltranslation. Wir behandeln die Übersetzung von Zeichenketten und Dateien.

Übersetzen Sie Ihren ersten String

1. Richten Sie Ihre Umgebungsvariablen ein

Der erste Schritt ist, GT_PROJECT_ID und GT_API_KEY zu erstellen. Das ist völlig kostenlos und verschafft Ihnen Zugriff auf die Übersetzungsdienste.

Navigieren Sie zur Seite API Keys und klicken Sie auf Create API Key. Wählen Sie einen Namen für Ihren API-Schlüssel und klicken Sie auf Create.

API-Schlüssel-Seite

General Translation bietet sehr großzügige kostenlose Ratenlimits, um persönliche Projekte, Solo-Entwickler und die Community zu unterstützen.

2. Initialisieren Sie die GT-Klasse

Initialisieren Sie die GT-Klasse und übergeben Sie sicher Ihre GT_PROJECT_ID und GT_API_KEY.

src/index.ts

import { GT } from 'generaltranslation';

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

3. Übersetzen Sie Ihren ersten String

Rufen Sie die Methode translate auf, um Ihren String zu übersetzen. Übergeben Sie den zu übersetzenden String und das Ziel-locale.

src/index.ts

const { translation } = await gt.translate('Hello, world!', 'es'); // Spanisch

console.log(translation); // "¡Hola, mundo!"

Wenn Sie einen locale code nachschlagen möchten, sehen Sie sich die Seite Supported locales an.

Übersetze deine erste Datei

Angenommen, du möchtest eine Datei namens en.json ins Spanische übersetzen.

en.json

{
  "hello": "Hallo",
  "world": "Welt"
}

Um eine Datei zu übersetzen, gehen Sie wie folgt in vier Schritten vor:

Laden Sie die Datei hoch
Stellen Sie die Datei zur Übersetzung in die Warteschlange
Prüfen Sie den Status der Datei (optional)
Laden Sie die übersetzte Datei herunter.

Warum nicht einfach ein einziger Aufruf?

In der Regel möchten Nutzer viele Dateien auf einmal übersetzen. Durch die Aufteilung in vier klare Schritte erhalten Nutzer deutlich mehr Flexibilität bei der Nutzung der API.

1. Datei hochladen

src/index.ts

import fs from 'fs';
import path from 'path';
import { FileUpload } from 'generaltranslation';

// (i) Dateiinhalt lesen
const filePath = path.join(process.cwd(), 'en.json');
const fileContents = fs.readFileSync(filePath, 'utf8');

// (ii) Dateiinhalt formatieren
const fileUpload: FileUpload = {
  content: fileContents,
  fileName: filePath,
  fileFormat: 'JSON',
  locale: 'en',
};
const files = [ { source: fileUpload } ];

// (iii) Datei hochladen
const { uploadedFiles } = await gt.uploadSourceFiles(
  files,
  {
    sourceLocale: 'en'
  }
);

Dies gibt eine Liste von Dateireferenzen zurück:

Output

[
  {
    fileId: '41726368696562616c64204d6342616c64792074686973206973206a6f6b652e',
    versionId: '427269616e204c6f75206d6f7265206c696b65204c696f6e2042726f20686121',
    fileName: '/Users/demo/en.json',
    fileFormat: 'JSON'
  }
]

2. Datei zur Übersetzung in die Warteschlange aufnehmen

Der nächste Schritt besteht darin, die Ziel-locales für die Übersetzung mit der Methode enqueueFiles auszuwählen. In diesem Fall übersetzen wir ins Spanische.

src/index.ts

const fileUploadRef = {
  fileId: uploadedFiles[0].fileId,
  versionId: uploadedFiles[0].versionId,
  fileName: uploadedFiles[0].fileName,
  fileFormat: uploadedFiles[0].fileFormat,
};
const enqueueResult = await gt.enqueueFiles(
  [fileUploadRef],
  {
  sourceLocale: 'en',
  targetLocales: ['es'],
});

Dadurch wird eine Liste von Dateiverweisen zurückgegeben:

Output

{
  translations: [],
  data: {
    '41726368696562616c64204d6342616c64792074686973206973206a6f6b652e': {
      fileName: '/Users/demo/en.json',
      versionId: '427269616e204c6f75206d6f7265206c696b65204c696f6e2042726f20686121'
    }
  },
  locales: [ 'es' ],
  message: 'Erstelle 1 Übersetzung(en).'
}

3. Dateistatus prüfen

Okay, jetzt, da die Datei hochgeladen ist – woher wissen wir, dass sie zum Download bereit ist? Wir können die Methode checkFileTranslations verwenden, um den Status der Datei zu überprüfen.

src/index.ts

const status = await gt.checkFileTranslations([{
  versionId: uploadedFiles[0].versionId,
  fileName: uploadedFiles[0].fileName,
  locale: 'es'
}]);

Wenn die Datei noch übersetzt wird, gibt es in der Ausgabe keine entsprechenden Übersetzungen.

Output

{
  translations: [
    {
      locale: 'es',
      metadata: {},
      fileId: '41726368696562616c64204d6342616c64792074686973206973206a6f6b652e',
      fileName: '/Users/demo/en.json',
      versionId: '427269616e204c6f75206d6f7265206c696b65204c696f6e2042726f20686121',
      id: 'skl44z0ieuvdcomw38zb5chv',
      isReady: true,
      downloadUrl: '/v2/project/translations/files/skl44z0ieuvdcomw38zb5chv/download'
    }
  ]
}

4. Übersetzte Datei herunterladen

Zum Schluss können wir die übersetzte Datei mit der Methode downloadTranslatedFile herunterladen.

src/index.ts

const { translation } = await gt.downloadTranslatedFile({
  fileId: uploadedFiles[0].fileId,
  locale: 'es',
  versionId: uploadedFiles[0].versionId,
});

Dadurch wird der übersetzte Dateiinhalt zurückgegeben:

Output

{
  "hello": "Hallo",
  "world": "Welt"
}

Schnellstart

Auf dieser Seite

Schnellstart

Auf dieser Seite

Schnellstart

Auf dieser Seite

GitHubStern auf GitHub vergeben

GitHubStern auf GitHub vergeben

Stern auf GitHub vergeben

Stern auf GitHub vergeben