|
Documentação
Agende uma demoPlataforma
PlataformaMCPCLIAPI
Workflows
GuiasChangelog

Boas-vindas

  • Visão geral
  • Autenticação
  • Erros e códigos de status
  • Assinaturas de webhook

Localização

  • Visão geral
  • Criar jobs
  • Bloquear chaves não traduzíveis
  • Acompanhar um grupo de jobs
  • Buscar um job
  • Listar jobs
  • Entrega de webhook
  • Progresso em tempo real (WebSocket)

Pipeline

  • Visão geral
  • Edição por IA antes da localização
  • Revisão humana
  • avaliação por IA (pós-edição)
  • Reescreva para soar natural
  • Verificação por retradução
  • Configure o pipeline
  • Acompanhe execuções do pipeline

Provisionamento

  • Visão geral
  • Criar um job de provisionamento
  • Tipos de fonte
  • O que a IA extrai
  • Entrega de webhook
  • Progresso em tempo real (WebSocket)

Síncrono

  • Localize
  • Recognize

Gerenciamento do engine

  • Sugestões do engine

API de Sugestões do engine

O feedback sobre suas traduções raramente chega como um clique no dashboard. Ele aparece em uma linha da sua ferramenta de suporte, em uma observação de um revisor, em um item da sua própria fila de QA — "pare de traduzir o nome do produto", "use o registro formal em alemão". A API de Sugestões do engine transforma esse texto livre em mudanças no engine via código: envie o feedback como texto, a plataforma interpreta o contexto e devolve edições concretas e estruturadas para o glossário, as instruções ou a voz da marca do seu engine, prontas para você aplicar.

Esta é a contraparte programática do recurso no dashboard. Lá, as sugestões são geradas automaticamente quando seus avaliadores de IA atribuem uma pontuação baixa a uma tradução; aqui, você fornece o sinal em texto. Em ambos os casos, a saída é a mesma — sugestões pendentes para você revisar e aplicar.

O fluxo se divide em duas partes. A geração é assíncrona — você envia o feedback e a plataforma o processa em segundo plano, deixando sugestões pendentes no engine. A revisão é síncrona — você lista as sugestões pendentes, lê o que cada uma propõe e aplica ou descarta cada uma. Esta página cobre as duas etapas. Para a experiência no dashboard — geração automática a partir de baixas pontuações de revisão, a aba de Sugestões e notificações — veja Sugestões do engine.

Um endpoint de configuração, não de tradução

Esses endpoints leem e alteram a configuração de um engine — seu glossário, instruções e voz da marca. Eles se aplicam a um único engine por meio do seu :id e usam a mesma X-API-Key com escopo de organização do restante da API. Eles nunca traduzem conteúdo nem alteram traduções anteriores; uma sugestão aplicada só passa a valer na próxima tradução feita pelo engine.

Autenticação

Envie sua chave de API no cabeçalho X-API-Key. As chaves têm escopo de organização e dão acesso a todos os engines da organização. Consulte Authentication para mais detalhes e Errors and status codes para o modelo de erro compartilhado por todos os endpoints desta página.

Gerar a partir de feedback#

text
POST /engines/:id/suggestions/from-text

Envie uma descrição em texto simples do que o engine está errando. A plataforma analisa esse texto junto com a configuração atual do engine e propõe edições atômicas — sem repetir algo que o engine já tenha. A geração acontece de forma assíncrona, então a chamada retorna assim que o trabalho é aceito, e não quando as sugestões ficam prontas.

ParâmetroTipoDescrição
id (path)stringO engine para o qual gerar sugestões.
textstringFeedback em texto livre sobre a saída do engine. De 1 a 10.000 caracteres; deve conter pelo menos um caractere que não seja espaço em branco.
javascript
const response = await fetch(
  `https://api.lingo.dev/engines/${engineId}/suggestions/from-text`,
  {
    method: "POST",
    headers: {
      "X-API-Key": process.env.LINGO_API_KEY,
      "Content-Type": "application/json",
    },
    body: JSON.stringify({
      text: "Our German (de-DE) translations keep using the informal 'du'. For our B2B audience they must always use the formal 'Sie'.",
    }),
  },
);

const { enqueued } = await response.json();
console.log(enqueued); // true – generation accepted, running in the background
json
{ "enqueued": true }

enqueued: true significa que a plataforma aceitou o trabalho, não que já existam sugestões. A geração é uma etapa em segundo plano: ela lê seu texto, analisa a configuração, remove duplicatas em relação ao que já existe e persiste o que propuser. Uma execução pode, legitimamente, não propor nada (porque o feedback era vago ou o engine já cobre aquilo). Para ver os resultados, liste as sugestões do engine alguns instantes depois.

Feedback vazio é rejeitado

text precisa conter uma mensagem real. Uma string vazia, ou apenas espaços em branco, é rejeitada com 400 — ela não é silenciosamente convertida em outro tipo de solicitação. Envie algo que o modelo realmente possa analisar.

Gerar a partir de pontuações de revisão

O mesmo gatilho de baixa pontuação que alimenta o dashboard também está disponível via código: POST /engines/:id/suggestions/generate (corpo vazio) pede à plataforma que proponha edições com base nas avaliações por IA recentes do engine com baixa pontuação, em vez de usar texto como entrada. A resposta { "enqueued": true } é a mesma, e o resultado também: sugestões pendentes. Use from-text quando tiver um feedback escrito específico; use generate para gerar sugestões a partir do que seus revisores já sinalizaram.

Listar sugestões pendentes#

text
GET /engines/:id/suggestions

Retorna as sugestões do engine — resultado de qualquer execução de geração, seja disparada por texto, pelo botão manual ou automaticamente a partir de baixas pontuações de revisão. Cada item é uma edição proposta com a respectiva justificativa.

json
[
  {
    "id": "egs_A1b2C3d4E5f6G7h8",
    "ownerOrganizationId": "org_X1y2Z3a4B5c6D7e8",
    "ownerEngineId": "eng_X1y2Z3a4B5c6D7e8",
    "actionType": "add_instruction",
    "targetKind": "instruction",
    "targetId": null,
    "targetLocale": "de-DE",
    "payload": { "instruction": "Use the formal 'Sie' form in all German translations; never use the informal 'du'." },
    "reasoning": "Feedback states the B2B audience requires formal address, but the engine has no instruction enforcing it.",
    "sourceReviewLogIds": [],
    "status": "pending",
    "appliedTargetId": null,
    "createdAt": "2026-06-18T10:30:00.000Z"
  }
]
CampoDescrição
idIdentificador da sugestão com prefixo egs_. Use-o em apply ou dismiss.
actionTypeUm de add_glossary_item, update_glossary_item, add_instruction, update_instruction, add_brand_voice, update_brand_voice.
targetKindA parte do engine afetada pela edição: glossary_item, instruction ou brand_voice.
targetIdPara uma ação update_*, o id da entrada que será alterada (gli_ / ins_ / bvc_). null para uma ação add_*.
targetLocaleO idioma ao qual a sugestão se aplica.
payloadA edição pronta para aplicar. Os campos variam conforme targetKind — é exatamente o que a operação de criação/atualização exige, por isso aplicar não requer nenhuma informação adicional da sua parte.
reasoningUma explicação breve do motivo dessa edição ter sido proposta.
sourceReviewLogIdsOs logs de revisão cujas falhas motivaram a sugestão (ids de esrl_); fica vazio quando a sugestão veio de texto de feedback.
statuspending, applied ou dismissed.
appliedTargetIdA entrada criada ou atualizada quando a sugestão é aplicada; null enquanto estiver pendente.

O payload é o detalhe que torna a aplicação barata: a mudança proposta já sai totalmente estruturada na geração, então aplicar é uma simples gravação, não mais uma rodada de IA. A decisão é sua; a plataforma não reavalia nada.

Aplicar uma sugestão#

text
POST /engine-suggestions/:id/apply

Grava a mudança proposta no engine e marca a sugestão como applied. Trata-se de uma gravação determinística do payload que você já viu na lista — não há uma segunda chamada de IA, então o que você revisou é exatamente o que será gravado. Uma sugestão add_* cria um novo item de glossário, instrução ou voz da marca; uma sugestão update_* altera a entrada existente indicada por targetId.

javascript
const response = await fetch(
  `https://api.lingo.dev/engine-suggestions/${suggestionId}/apply`,
  {
    method: "POST",
    headers: { "X-API-Key": process.env.LINGO_API_KEY },
  },
);

const applied = await response.json();
console.log(applied.status);          // "applied"
console.log(applied.appliedTargetId); // "ins_…" – the instruction it just created

A resposta traz a sugestão no estado applied, com appliedTargetId agora apontando para a entrada real do engine que foi criada ou atualizada. A partir daí, essa entrada passa a ser um item comum de glossário, instrução ou voz da marca — você pode abrir, editar ou excluir como qualquer outro.

Aplicar altera a configuração, não traduções anteriores

Aplicar edita a configuração do engine. Conteúdos já traduzidos mantêm o resultado atual; a mudança aparece na próxima vez que o engine traduzir. Aplicar não relocaliza nada por conta própria.

Descartar uma sugestão#

text
POST /engine-suggestions/:id/dismiss

Descarta uma sugestão que você não quer, marcando-a como dismissed e deixando o engine inalterado. Use isso quando uma proposta não fizer sentido para o seu produto — o engine não muda, e a sugestão deixa de aparecer como pendente.

javascript
await fetch(
  `https://api.lingo.dev/engine-suggestions/${suggestionId}/dismiss`,
  {
    method: "POST",
    headers: { "X-API-Key": process.env.LINGO_API_KEY },
  },
);
// The suggestion is now "dismissed"; nothing was written to the engine.

O ciclo completo#

Os quatro endpoints formam um ciclo que você pode controlar inteiramente por código: envie o feedback, veja o que foi proposto e confirme as edições com as quais concordar.

1

Gerar

POST …/suggestions/from-text com seu feedback por escrito (ou …/suggestions/generate para usar baixas pontuações de revisão como fonte). Você recebe { "enqueued": true } imediatamente.

2

Listar

GET /engines/:id/suggestions pouco depois para ver as sugestões pendentes, cada uma com seu payload e reasoning.

3

Aplicar ou descartar

POST /engine-suggestions/:id/apply para confirmar a edição ou …/dismiss para descartá-la. A aplicação passa a valer na próxima tradução do engine.

Próximos passos#

Sugestões do engine (recurso)
A visualização no dashboard, a geração automática a partir de baixas pontuações de revisão e as notificações.
AI Reviewers
Atribua pontuações às traduções com base na sua configuração — é esse sinal que o gatilho automático de sugestões usa.
Glossários
As regras de tradução obrigatória e de não tradução que uma sugestão de glossário grava.
Instruções
As regras por idioma que uma sugestão de instrução cria ou atualiza.

Esta página foi útil?

Max PrilutskiyMax Prilutskiy·Atualizado há 11 dias·7 min de leitura