GT ClassMethodsTranslation

setupProject

Riferimento API per il metodo setupProject per inizializzare la configurazione del progetto di traduzione

Panoramica

Il metodo setupProject avvia la configurazione di un progetto di traduzione utilizzando i file caricati in precedenza. Viene creato un processo di configurazione asincrono che analizza i file e li prepara ai flussi di lavoro di traduzione.

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

const setupResult = await gt.setupProject(fileRefs, 30000);
console.log(`Job di setup creato: ${setupResult.setupJobId}`);

Devi aver caricato in precedenza i file usando uploadSourceFiles prima di chiamare setupProject.

Riferimenti

Parametri

NomeTipoDescrizione
filesFileUploadRef[]Array di riferimenti a file provenienti da file sorgente caricati in precedenza
timeoutMs?numberTimeout facoltativo in millisecondi per la richiesta all’API

Struttura di FileUploadRef

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

Restituisce

Promise<SetupProjectResult> - Contiene l’ID dell’attività di configurazione e lo stato iniziale.

type SetupProjectResult = {
  setupJobId: string;
  status: 'queued';
}
ProprietàTipoDescrizione
setupJobIdstringIdentificatore univoco del job di setup
status'queued'Stato iniziale del job di setup

Esempi

Utilizzo di base

Inizializza la configurazione del progetto con i file caricati:

index.ts
import { GT } from 'generaltranslation';

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

// Riferimenti ai file dal caricamento precedente
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(`Setup avviato con ID job: ${setupResult.setupJobId}`);

Note

  • I file devono essere caricati utilizzando uploadSourceFiles prima di chiamare setupProject
  • La configurazione del progetto analizza contenuto e struttura dei file per ottimizzare i workflow di traduzione
  • Il processo di setup viene eseguito in modo asincrono: monitora l’avanzamento con checkSetupStatus
  • Il setup è generalmente necessario prima di mettere in coda job di traduzione per nuovi progetti

Prossimi passaggi

Come valuti questa guida?

setupProject