Criar uma tarefa de aprovisionamento

Gere orientações para um motor novo ou existente e guarde o ID da tarefa para acompanhar o progresso e permitir a recuperação.

O aprovisionamento decorre em segundo plano e começa quando a API aceita o pedido. Todas as rotas utilizam https://api.lingo.dev e autenticação da API.

Criar e preencher um motor #

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 o URL de exemplo pelo de uma página acessível que contenha as suas orientações ou forneça texto em alternativa.

CampoContrato
engineObjeto obrigatório para a criação do motor. name não pode estar vazio; description é opcional. Também pode incluir configurações de modelos, cobertura e definições do fluxo de processamento.
kindsObjeto obrigatório que seleciona pelo menos uma das opções glossary, ruleset ou brandVoice. Cada valor selecionado é {} ou { "name": "Nonempty name" }.
sourcesLista obrigatória, não vazia, com um máximo de dez ligações ou fontes de texto.

As definições do motor seguem o contrato de criação do motor. sourceCoverage e targetCoverage são listas de idiomas, e [] abrange todos os idiomas. Se omitir modelConfigs, são aplicadas as configurações de modelos predefinidas da plataforma; [] deixa o motor sem configurações de modelos fixadas. Configure os modelos do motor antes de o utilizar para traduzir.

Quem faz o pedido precisa de permissão para criar motores e para criar as orientações solicitadas. O pedido pode ser rejeitado devido ao número de motores, às funcionalidades do plano, ao crédito da conta ou aos limites de frequência de aprovisionamento.

Preencher um motor existente #

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

Para preencher apenas os tipos para os quais o motor ainda não tem um conjunto associado:

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 um conjunto de regras a par dos existentes. O aprovisionamento nunca substitui uma voz da marca associada. Empty ignora os tipos já associados, incluindo conjuntos associados durante a execução da tarefa. Analise os resultados por tipo, em vez de assumir que cada pedido cria os três tipos.

Só pode estar em execução uma tarefa de aprovisionamento por motor de cada vez. ProvisioningJobRunning (409) inclui o jobId existente; acompanhe essa tarefa antes de submeter mais trabalho. NothingToProvision (409) significa que nenhuma das operações solicitadas pode preencher o motor no seu estado atual.

Guardar a resposta #

Ambas as rotas de criação devolvem HTTP 200 com uma tarefa de aprovisionamento. Guarde 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 motores antes de repetir um pedido de criação de motor, pois a repetição pode criar outro motor. A secção Recuperação explica essas verificações e como voltar a tentar os tipos que falharam.