Criar uma tarefa de provisionamento

Gere orientações para um engine novo ou existente e salve o ID da tarefa para acompanhar o progresso e retomar o processo em caso de falha.

O provisionamento é executado em segundo plano e começa assim que a API aceita a solicitação. Todas as rotas usam https://api.lingo.dev e autenticação de API.

Criar e preencher um engine #

http
POST /v2/organizations/:orgId/provisioning/jobs
Content-Type: application/json
X-API-Key: YOUR_API_KEY
json
{
  "engine": { "name": "Acme support", "description": "Customer support content" },
  "kinds": {
    "glossary": { "name": "Product terminology" },
    "ruleset": { "name": "Support writing rules" },
    "brandVoice": { "name": "Support voice" }
  },
  "sources": [
    { "_tag": "Link", "url": "https://example.com/style-guide" },
    { "_tag": "Content", "text": "Use clear, direct sentences. Keep the product name Acme unchanged." }
  ]
}

Substitua a URL de exemplo pela URL de uma página acessível que contenha suas orientações ou forneça o texto diretamente.

CampoContrato
engineObjeto obrigatório para criar o engine. name não pode estar vazio; description é opcional. O objeto também pode incluir configurações de modelos, cobertura e configurações de pipeline.
kindsObjeto obrigatório que seleciona pelo menos uma das opções glossary, ruleset ou brandVoice. Cada valor selecionado é {} ou { "name": "Nonempty name" }.
sourcesArray obrigatório e não vazio, com no máximo dez links ou fontes de texto.

As configurações do engine seguem o contrato de criação de engines. sourceCoverage e targetCoverage são arrays de idiomas, e [] abrange todos os idiomas. Omitir modelConfigs aplica as configurações padrão de modelos da plataforma; [] deixa o engine sem configurações de modelos fixadas. Configure os modelos do engine antes de usá-lo para traduzir.

Quem faz a chamada precisa de permissão para criar engines e as orientações solicitadas. A solicitação pode ser rejeitada em função da quantidade de engines, dos recursos do plano, do crédito da conta e dos limites de taxa de provisionamento.

Preencher um engine existente #

http
POST /v2/engines/:engineId/provisioning/jobs
Content-Type: application/json

Para preencher apenas os tipos que ainda não têm um conjunto associado ao engine:

json
{
  "kinds": { "_tag": "Empty" },
  "sources": [{ "_tag": "Content", "text": "Keep Acme unchanged. Use concise, friendly language." }]
}

Para solicitar novos conjuntos específicos:

json
{
  "kinds": {
    "_tag": "Requested",
    "glossary": { "name": "Support terminology" },
    "ruleset": {}
  },
  "sources": [{ "_tag": "Link", "url": "https://example.com/support" }]
}

Requested pode adicionar um glossário ou conjunto de regras além dos já existentes. O provisionamento nunca substitui uma voz da marca associada. Empty ignora os tipos já associados, inclusive conjuntos associados durante a execução da tarefa. Confira os resultados de cada tipo em vez de presumir que toda solicitação cria os três tipos.

Só uma tarefa de provisionamento pode ser executada por vez em um engine. ProvisioningJobRunning (409) inclui o jobId existente; acompanhe-o antes de enviar novas tarefas. NothingToProvision (409) significa que nenhuma das operações solicitadas pode preencher o engine no estado atual.

Salvar a resposta #

As duas rotas de criação retornam HTTP 200 com uma tarefa de provisionamento. Salve id e engineId antes de iniciar as consultas periódicas. O estado inicial normalmente é status: { "_tag": "Running" }.

A criação não declara um cabeçalho de idempotência. Se uma resposta se perder, verifique as tarefas em execução e a lista de engines antes de repetir uma solicitação de criação de engine, pois isso pode criar outro engine. Recuperação explica essas verificações e como tentar novamente os tipos que falharam.