Automatize a localização de ficheiros com a API

Carregue um ficheiro de origem, inicie uma tarefa de documento e descarregue as traduções para um diretório de saída separado.

Utilize a API de documentos quando o seu sistema de retaguarda é responsável pela gestão dos ficheiros e precisa de coordenar a tradução com o seu próprio armazenamento. Este exemplo traduz messages/en.json para alemão e francês. A CLI permite efetuar as mesmas operações sobre ficheiros num projeto local.

Precisa do Node.js 22 ou posterior, de uma organização, de um motor configurado com um modelo e de uma chave de API com acesso à tradução. Nesta primeira execução, configure a tradução sem revisão humana; adicione a revisão quando o ciclo de vida dos ficheiros estiver a funcionar.

Prepare um ficheiro de origem #

Crie messages/en.json:

json
{
  "title": "Account settings",
  "save": "Save changes"
}

Defina as seguintes variáveis de ambiente com os seus próprios valores:

sh
export LINGO_API_KEY="YOUR_API_KEY"
export LINGO_ORGANIZATION_ID="YOUR_ORGANIZATION_ID"
export LINGO_ENGINE_ID="YOUR_ENGINE_ID"
export LINGO_REQUEST_ID="account-settings-v1-de-fr"

Mantenha o mesmo ID de pedido ao repetir tentativas com esta origem e configuração. Altere-o quando submeter uma nova revisão.

Carregue, inicie e recolha #

Guarde este programa como translate-file.mjs:

js
import { createHash } from "node:crypto";
import { mkdir, readFile, writeFile } from "node:fs/promises";
import { setTimeout as delay } from "node:timers/promises";

const origin = "https://api.lingo.dev";
const {
  LINGO_API_KEY: apiKey,
  LINGO_ORGANIZATION_ID: orgId,
  LINGO_ENGINE_ID: engineId,
  LINGO_REQUEST_ID: requestId,
} = process.env;
if (!apiKey || !orgId || !engineId || !requestId) throw new Error("Set the four LINGO environment variables");

async function request(path, options = {}) {
  const response = await fetch(new URL(path, origin), {
    ...options,
    headers: { "X-API-Key": apiKey, ...options.headers },
    signal: AbortSignal.timeout(30_000),
  });
  if (!response.ok) throw new Error(`HTTP ${response.status}: ${await response.text()}`);
  return response;
}

const bytes = await readFile("messages/en.json");
const address = createHash("sha256").update(bytes).digest("hex");
let job = await (
  await request(`/v2/organizations/${encodeURIComponent(orgId)}/localization/jobs`, {
    method: "POST",
    headers: { "Content-Type": "application/json", "Idempotency-Key": requestId },
    body: JSON.stringify({
      engineId,
      sourceLocale: "en",
      targetLocales: ["de", "fr"],
      documents: [{ key: "messages/en.json", format: { type: "json" }, source: address }],
    }),
  })
).json();

await writeFile("file-job.json", JSON.stringify({ id: job.id, requestId, source: address }, null, 2));
for (const upload of job.uploads) {
  await request(upload.uploadUrl, {
    method: "PUT",
    headers: { "Content-Type": "application/octet-stream" },
    body: bytes,
  });
}
job = await (
  await request(`/v2/localization/jobs/${encodeURIComponent(job.id)}/start`, {
    method: "POST",
  })
).json();

const deadline = Date.now() + 120_000;
while (["Pending", "Running"].includes(job.status._tag)) {
  if (Date.now() >= deadline) throw new Error(`Keep job ${job.id} and check again later`);
  await delay(2000);
  job = await (await request(`/v2/localization/jobs/${encodeURIComponent(job.id)}`)).json();
}

await mkdir("translated", { recursive: true });
for (const { locale, status } of job.documents[0].targets) {
  if (status._tag !== "Completed") {
    throw new Error(`Inspect job ${job.id}: ${locale} is ${status._tag}`);
  }
  const output = await request(status.downloadUrl);
  await writeFile(`translated/${locale}.json`, new Uint8Array(await output.arrayBuffer()));
  console.log(`Saved translated/${locale}.json`);
}

Execute node translate-file.mjs e verifique depois translated/de.json e translated/fr.json. Ambos devem manter as chaves do ficheiro de origem e apresentar o conteúdo no idioma correspondente. O programa mantém os ficheiros de saída separados dos ficheiros da aplicação, para que possa revê-los antes de substituir o conteúdo aceite.

Retome sem duplicar a tarefa #

file-job.json regista a identidade remota e o hash da origem. Se a resposta a um pedido de carregamento ou de início se perder, obtenha essa tarefa, carregue os artefactos que faltam e repita o pedido de início. Repetir a criação com a chave de idempotência original também devolve a mesma tarefa.

Atingir o tempo limite de consulta periódica não cancela o trabalho. Continue a consultar a tarefa registada; não crie outra só porque o programa local deixou de esperar.

Este exemplo interrompe a execução assim que encontra um destino incompleto ou um pedido falhado. Os ficheiros já guardados permanecem em translated/. Para continuar, obtenha a tarefa registada em file-job.json e descarregue os destinos concluídos utilizando os respetivos valores downloadUrl; consulte estado e resultados da tarefa. Uma falha ao descarregar não exige uma nova tarefa de tradução.

Adicione atualizações incrementais #

Para a próxima revisão, forneça previousSource e previousTranslations juntamente com o novo endereço de origem. Conserve os bytes de cada artefacto referenciado até o carregamento ser concluído com êxito. Nos ficheiros de destino anteriores que fornecer, inclua as alterações humanas aceites.

Traduzir documentos apresenta os campos e as regras de reutilização. Antes de publicar, compare a revisão de origem da tarefa com a sua origem atual e verifique se houve alterações no destino após a submissão. Criar um workflow de tradução explica esse passo de aceitação.