Vue d’ensemble

La méthode setupProject lance la configuration d’un projet de traduction à partir de fichiers déjà téléversés. Elle crée une tâche asynchrone qui analyse les fichiers et les prépare pour les flux de traduction.

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

const setupResult = await gt.setupProject(fileRefs, 30000);
console.log(`Tâche de configuration créée : ${setupResult.setupJobId}`);

Références

Paramètres

Structure de FileUploadRef

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

Renvoie

Promise<SetupProjectResult> - Contient l’identifiant de la tâche de configuration et son état initial.

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

Exemples

Utilisation de base

Initialisez la configuration du projet avec des fichiers importés :

import { GT } from 'generaltranslation';

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

// Références de fichiers d'un téléchargement précédent
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(`Configuration initiée avec l'ID de tâche : ${setupResult.setupJobId}`);

Remarques

• Les fichiers doivent être téléversés à l’aide de uploadSourceFiles avant d’appeler setupProject
• La configuration du projet analyse le contenu et la structure des fichiers afin d’optimiser les workflows de traduction
• La tâche de configuration s’exécute de façon asynchrone — surveillez l’avancement avec checkSetupStatus
• La configuration est généralement requise avant de mettre en file d’attente des jobs de traduction pour les nouveaux projets

Prochaines étapes

• Consultez uploadSourceFiles pour téléverser les fichiers avant la configuration
• Consultez checkSetupStatus pour suivre l’avancement de la configuration
• Consultez shouldSetupProject pour vérifier si une configuration est nécessaire
• Consultez enqueueFiles pour lancer les traductions après la configuration