Tarefas de tradução

Crie e inicie tarefas com um ou mais documentos e idiomas de destino.

Uma tarefa traduz documentos através de um único motor de localização. Cada documento tem uma chave estável e um destino por idioma solicitado. Utilize JSON incorporado para conteúdo em memória ou endereços de artefactos para ficheiros.

Todas as rotas abaixo utilizam https://api.lingo.dev e autenticação da API.

Criar uma tarefa #

http
POST /v2/organizations/:orgId/localization/jobs
Content-Type: application/json
X-API-Key: YOUR_API_KEY
Idempotency-Key: order-confirmation-v3-de-fr
json
{
  "engineId": "YOUR_ENGINE_ID",
  "sourceLocale": "en",
  "targetLocales": ["de", "fr"],
  "documents": [
    {
      "key": "order-confirmation.json",
      "format": { "type": "json" },
      "source": { "content": { "subject": "Your order is confirmed" } }
    }
  ]
}

Campos do pedido #

CampoObrigatórioDescrição
engineIdSimMotor da organização que está disponível para tradução a quem faz o pedido.
sourceLocaleSimIdioma de origem.
targetLocalesSimLista não vazia de idiomas de destino, sem duplicados. Um documento não pode ter como destino o seu próprio idioma de origem.
documentsSimLista não vazia de documentos com valores key únicos.
originIdNãoIdentificador não vazio, com um máximo de 512 caracteres, do local onde os documentos estão alojados; por exemplo, github:acme/web. Permite associar as alterações posteriores provenientes dessa origem à medição da tradução.

Cada documento tem:

CampoObrigatórioDescrição
keySimCaminho lógico ou nome de ficheiro não vazio e único nesta tarefa. Mantenha-o inalterado entre revisões.
formatSimObjeto de formato com um type e um options específico do formato.
sourceSimEndereço de artefacto SHA-256 ou { "content": { ... } } para JSON incorporado.
previousSourceNãoEndereço do artefacto de origem anterior. Omita este campo ou utilize null para uma primeira tradução.
previousTranslationsNãoLista de { "locale": "de", "artifact": "SHA256" }. O valor predefinido é []; cada idioma tem de ser único e constar dos destinos deste documento.
targetLocalesNãoLista de idiomas específica deste documento, não vazia e sem duplicados, que substitui a da tarefa. Se for omitida ou tiver o valor null, são utilizados os idiomas de destino da tarefa.

Ao utilizar keyScope ou termScope, forneça uma tradução anterior para cada destino. Consulte formatos e atualizações de documentos.

Idempotência #

Envie um Idempotency-Key não vazio com um máximo de 255 caracteres. As chaves são específicas de cada motor; o prefixo content-sync: está reservado. Guarde a chave com o pedido original e repita esse pedido sem alterações se a resposta não permitir confirmar a criação.

Reutilizar uma chave devolve a tarefa originalmente criada com essa chave. Não atualiza os documentos nem os idiomas dessa tarefa. Utilize uma nova chave se o trabalho tiver alterações. Uma opção de execução incompatível pode gerar LocalizationJobIdempotencyKeyReused (422).

Resposta à criação #

Se a criação for bem-sucedida, a API devolve HTTP 200 e a resposta da tarefa, normalmente com status: { "_tag": "Pending" }. Guarde id de forma persistente antes de continuar. A lista uploads apresenta os artefactos de entrada em falta como { "address": "...", "uploadUrl": "..." }.

A criação guarda o conteúdo de origem incorporado. Não inicia a tradução, mesmo quando uploads está vazio.

Carregar e iniciar #

Carregue cada artefacto em falta para o respetivo uploadUrl através de um PUT autenticado que contenha os bytes originais. Em seguida, faça a chamada:

http
POST /v2/localization/jobs/:id/start
X-API-Key: YOUR_API_KEY

O pedido de início não tem corpo. A resposta HTTP 200 contém o registo atual da tarefa. É seguro repetir o pedido de início para a mesma tarefa, o que permite recuperar de um envio cujo resultado seja incerto; não é criada outra tarefa nem volta a ser executada uma tarefa já concluída.

Ao iniciar, são verificados os artefactos carregados, a configuração do motor e os limites da conta. ArtifactsNotUploaded (409) apresenta os dados de entrada em falta. Se o limite diário de tokens for atingido (429) ou os créditos forem insuficientes, a tarefa fica pendente; resolva a situação antes de a iniciar novamente. Consulte erros.

Configurar as etapas do fluxo de processamento #

Configure o fluxo de processamento do motor antes de iniciar a tarefa. A configuração é registada no momento do início. As etapas resultantes para os destinos da tarefa mostram o trabalho efetivamente selecionado, tendo em conta o que está disponível no plano.

Recolher resultados e recuperar de falhas #

Obtenha a tarefa para verificar cada destino e transferir os ficheiros concluídos. Utilize o progresso das etapas para distinguir o trabalho do modelo, os períodos de espera por revisão, o trabalho ignorado e as falhas.

Uma tarefa que falhou pode ainda ter destinos concluídos. Guarde esses resultados e, depois de corrigir a causa, submeta apenas o trabalho que precisa de ser gerado novamente, com uma nova chave de idempotência. Guarde as revisões de origem juntamente com os IDs das tarefas para evitar que uma entrega posterior substitua traduções mais recentes.

Liste as tarefas para encontrar submissões por motor, estado, gatilho ou chave de serviço.