Descripción general

El método setupProject inicia el proceso de configuración de un proyecto de traducción utilizando archivos previamente cargados. Esto crea una tarea de configuración asíncrona que analiza los archivos y los prepara para los flujos de trabajo de traducción.

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

const setupResult = await gt.setupProject(fileRefs, 30000);
console.log(`Trabajo de configuración creado: ${setupResult.setupJobId}`);

Referencia

Parámetros

Estructura de FileUploadRef

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

Valores devueltos

Promise<SetupProjectResult> - Contiene el identificador de la tarea de configuración y el estado inicial.

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

Ejemplos

Uso básico

Inicializa la configuración del proyecto con los archivos subidos:

import { GT } from 'generaltranslation';

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

// Referencias de archivos de una carga previa
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(`Configuración iniciada con ID de tarea: ${setupResult.setupJobId}`);

Notas

• Los archivos deben subirse con uploadSourceFiles antes de llamar a setupProject
• La configuración del proyecto analiza el contenido y la estructura de los archivos para optimizar los flujos de trabajo de traducción
• La tarea de configuración se ejecuta de forma asíncrona: controle el progreso con checkSetupStatus
• Por lo general, la configuración es necesaria antes de poner en cola trabajos de traducción para proyectos nuevos

Próximos pasos

• Consulta uploadSourceFiles para subir archivos antes de la configuración
• Consulta checkSetupStatus para monitorear el progreso de la configuración
• Consulta shouldSetupProject para comprobar si es necesaria la configuración
• Consulta enqueueFiles para iniciar las traducciones después de la configuración