Démarrage rapide

Aperçu

Ce guide vous présentera les bases de l’utilisation de la bibliothèque generaltranslation. Nous aborderons la traduction de chaînes et la traduction de fichiers.

Traduisez votre première chaîne

1. Récupérez vos variables d’environnement

La toute première étape consiste à créer un GT_PROJECT_ID et un GT_API_KEY. C’est entièrement gratuit et vous donnera accès aux services de traduction.

Rendez-vous sur la page API Keys et cliquez sur Create API Key. Choisissez un nom pour votre clé d’API, puis cliquez sur Create.

Page de clé d’API

General Translation propose des limites gratuites très généreuses pour soutenir les projets personnels, les développeurs indépendants et la communauté.

2. Initialisez la classe GT

Initialisez la classe GT et transmettez en toute sécurité votre GT_PROJECT_ID et votre GT_API_KEY.

src/index.ts

import { GT } from 'generaltranslation';

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

3. Traduisez votre première chaîne

Appelez la méthode translate pour traduire votre chaîne. Passez la chaîne à traduire et la locale cible.

src/index.ts

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

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

Pour consulter un code de locale, voir la page locales prises en charge.

Traduisez votre premier fichier

Ce guide suppose que vous avez déjà suivi les étapes 1 et 2 du guide Traduire votre première chaîne et que vous disposez d’un GT_PROJECT_ID, d’un GT_API_KEY et d’une instance de la classe GT.

Supposons que vous vouliez traduire un fichier nommé en.json en espagnol.

en.json

{
  "hello": "Bonjour",
  "world": "Monde"
}

Pour Traduire un files, vous devez suivre ces quatre étapes :

Téléversez le files
Placez le files dans la file d’attente pour traduction
Vérifiez l’état du files (facultatif)
Téléchargez le files traduit.

En général, les utilisateurs souhaitent Traduire de nombreux files à la fois. En découpant cela en quatre étapes claires, ils disposent de beaucoup plus de flexibilité dans la manière d’utiliser l’API.

1. Téléversez le fichier

Le téléversement de fichiers renvoie une liste de références de fichiers avec la méthode uploadSourceFiles. Cela vous permet ensuite de mettre le fichier en file d’attente pour Traduire, d’en vérifier l’état et de télécharger le fichier traduit.

src/index.ts

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

// (i) Lire le contenu d'un fichier
const filePath = path.join(process.cwd(), 'en.json');
const fileContents = fs.readFileSync(filePath, 'utf8');

// (ii) Formater le contenu du fichier
const fileUpload: FileUpload = {
  content: fileContents,
  fileName: filePath,
  fileFormat: 'JSON',
  locale: 'en',
};
const files = [ { source: fileUpload } ];

// (iii) Télécharger le fichier
const { uploadedFiles } = await gt.uploadSourceFiles(
  files,
  {
    sourceLocale: 'en'
  }
);

Cela renvoie une liste de références de fichiers :

Output

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

2. Mettre le fichier en file d’attente pour traduction

L’étape suivante consiste à sélectionner les locales cibles pour la traduction avec la méthode enqueueFiles. Dans cet exemple, nous allons traduire en espagnol.

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'],
});

Cela renvoie une liste de références de fichiers :

Output

{
  translations: [],
  data: {
    '41726368696562616c64204d6342616c64792074686973206973206a6f6b652e': {
      fileName: '/Users/demo/en.json',
      versionId: '427269616e204c6f75206d6f7265206c696b65204c696f6e2042726f20686121'
    }
  },
  locales: [ 'es' ],
  message: 'Création de 1 traduction.'
}

3. Vérifier l’état du fichier

Très bien, maintenant que le fichier a été téléversé, comment savoir quand il est prêt à être téléchargé ? Nous pouvons utiliser la méthode checkFileTranslations pour vérifier l’état du fichier.

src/index.ts

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

Si le fichier est encore en cours de traduction, aucune traduction correspondante n’apparaîtra dans la sortie.

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. Télécharger le fichier traduit

Enfin, nous pouvons télécharger le fichier traduit avec la méthode downloadTranslatedFile.

src/index.ts

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

Cela renverra le contenu du fichier de traduction :

Output

{
  "hello": "Bonjour",
  "world": "Monde"
}

Aperçu

Ce guide vous présentera les bases de l’utilisation de la bibliothèque generaltranslation. Nous aborderons la traduction de chaînes et la traduction de fichiers.

Traduisez votre première chaîne

1. Récupérez vos variables d’environnement

La toute première étape consiste à créer un GT_PROJECT_ID et un GT_API_KEY. C’est entièrement gratuit et vous donnera accès aux services de traduction.

Rendez-vous sur la page API Keys et cliquez sur Create API Key. Choisissez un nom pour votre clé d’API, puis cliquez sur Create.

Page de clé d’API

General Translation propose des limites gratuites très généreuses pour soutenir les projets personnels, les développeurs indépendants et la communauté.

2. Initialisez la classe GT

Initialisez la classe GT et transmettez en toute sécurité votre GT_PROJECT_ID et votre GT_API_KEY.

src/index.ts

import { GT } from 'generaltranslation';

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

3. Traduisez votre première chaîne

Appelez la méthode translate pour traduire votre chaîne. Passez la chaîne à traduire et la locale cible.

src/index.ts

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

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

Pour consulter un code de locale, voir la page locales prises en charge.

Traduisez votre premier fichier

Supposons que vous vouliez traduire un fichier nommé en.json en espagnol.

en.json

{
  "hello": "Bonjour",
  "world": "Monde"
}

Pour Traduire un files, vous devez suivre ces quatre étapes :

Téléversez le files
Placez le files dans la file d’attente pour traduction
Vérifiez l’état du files (facultatif)
Téléchargez le files traduit.

Pourquoi pas un seul appel ?

1. Téléversez le fichier

src/index.ts

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

// (i) Lire le contenu d'un fichier
const filePath = path.join(process.cwd(), 'en.json');
const fileContents = fs.readFileSync(filePath, 'utf8');

// (ii) Formater le contenu du fichier
const fileUpload: FileUpload = {
  content: fileContents,
  fileName: filePath,
  fileFormat: 'JSON',
  locale: 'en',
};
const files = [ { source: fileUpload } ];

// (iii) Télécharger le fichier
const { uploadedFiles } = await gt.uploadSourceFiles(
  files,
  {
    sourceLocale: 'en'
  }
);

Cela renvoie une liste de références de fichiers :

Output

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

2. Mettre le fichier en file d’attente pour traduction

L’étape suivante consiste à sélectionner les locales cibles pour la traduction avec la méthode enqueueFiles. Dans cet exemple, nous allons traduire en espagnol.

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'],
});

Cela renvoie une liste de références de fichiers :

Output

{
  translations: [],
  data: {
    '41726368696562616c64204d6342616c64792074686973206973206a6f6b652e': {
      fileName: '/Users/demo/en.json',
      versionId: '427269616e204c6f75206d6f7265206c696b65204c696f6e2042726f20686121'
    }
  },
  locales: [ 'es' ],
  message: 'Création de 1 traduction.'
}

3. Vérifier l’état du fichier

src/index.ts

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

Si le fichier est encore en cours de traduction, aucune traduction correspondante n’apparaîtra dans la sortie.

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. Télécharger le fichier traduit

Enfin, nous pouvons télécharger le fichier traduit avec la méthode downloadTranslatedFile.

src/index.ts

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

Cela renverra le contenu du fichier de traduction :

Output

{
  "hello": "Bonjour",
  "world": "Monde"
}

Aperçu

Ce guide vous présentera les bases de l’utilisation de la bibliothèque generaltranslation. Nous aborderons la traduction de chaînes et la traduction de fichiers.

Traduisez votre première chaîne

1. Récupérez vos variables d’environnement

La toute première étape consiste à créer un GT_PROJECT_ID et un GT_API_KEY. C’est entièrement gratuit et vous donnera accès aux services de traduction.

Rendez-vous sur la page API Keys et cliquez sur Create API Key. Choisissez un nom pour votre clé d’API, puis cliquez sur Create.

Page de clé d’API

General Translation propose des limites gratuites très généreuses pour soutenir les projets personnels, les développeurs indépendants et la communauté.

2. Initialisez la classe GT

Initialisez la classe GT et transmettez en toute sécurité votre GT_PROJECT_ID et votre GT_API_KEY.

src/index.ts

import { GT } from 'generaltranslation';

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

3. Traduisez votre première chaîne

Appelez la méthode translate pour traduire votre chaîne. Passez la chaîne à traduire et la locale cible.

src/index.ts

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

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

Pour consulter un code de locale, voir la page locales prises en charge.

Traduisez votre premier fichier

Supposons que vous vouliez traduire un fichier nommé en.json en espagnol.

en.json

{
  "hello": "Bonjour",
  "world": "Monde"
}

Pour Traduire un files, vous devez suivre ces quatre étapes :

Téléversez le files
Placez le files dans la file d’attente pour traduction
Vérifiez l’état du files (facultatif)
Téléchargez le files traduit.

Pourquoi pas un seul appel ?

1. Téléversez le fichier

src/index.ts

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

// (i) Lire le contenu d'un fichier
const filePath = path.join(process.cwd(), 'en.json');
const fileContents = fs.readFileSync(filePath, 'utf8');

// (ii) Formater le contenu du fichier
const fileUpload: FileUpload = {
  content: fileContents,
  fileName: filePath,
  fileFormat: 'JSON',
  locale: 'en',
};
const files = [ { source: fileUpload } ];

// (iii) Télécharger le fichier
const { uploadedFiles } = await gt.uploadSourceFiles(
  files,
  {
    sourceLocale: 'en'
  }
);

Cela renvoie une liste de références de fichiers :

Output

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

2. Mettre le fichier en file d’attente pour traduction

L’étape suivante consiste à sélectionner les locales cibles pour la traduction avec la méthode enqueueFiles. Dans cet exemple, nous allons traduire en espagnol.

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'],
});

Cela renvoie une liste de références de fichiers :

Output

{
  translations: [],
  data: {
    '41726368696562616c64204d6342616c64792074686973206973206a6f6b652e': {
      fileName: '/Users/demo/en.json',
      versionId: '427269616e204c6f75206d6f7265206c696b65204c696f6e2042726f20686121'
    }
  },
  locales: [ 'es' ],
  message: 'Création de 1 traduction.'
}

3. Vérifier l’état du fichier

src/index.ts

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

Si le fichier est encore en cours de traduction, aucune traduction correspondante n’apparaîtra dans la sortie.

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. Télécharger le fichier traduit

Enfin, nous pouvons télécharger le fichier traduit avec la méthode downloadTranslatedFile.

src/index.ts

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

Cela renverra le contenu du fichier de traduction :

Output

{
  "hello": "Bonjour",
  "world": "Monde"
}

Démarrage rapide

Sur cette page

Démarrage rapide

Sur cette page

Démarrage rapide

Sur cette page

GitHubMettre une étoile sur GitHub

GitHubMettre une étoile sur GitHub

Mettre une étoile sur GitHub

Mettre une étoile sur GitHub