Créer une tâche de provisionnement

Générez des consignes pour un moteur nouveau ou existant et conservez l’identifiant de la tâche pour suivre sa progression et la reprendre.

Le provisionnement s’exécute en arrière-plan et démarre dès que l’API accepte la requête. Toutes les routes utilisent https://api.lingo.dev et l’authentification API.

Créer et alimenter un moteur #

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." }
  ]
}

Remplacez l’URL d’exemple par celle d’une page accessible contenant vos consignes, ou fournissez du texte à la place.

ChampContrat
engineObjet de création de moteur obligatoire. name ne doit pas être vide ; description est facultatif. Cet objet peut aussi contenir des configurations de modèles, des paramètres de couverture et de pipeline.
kindsObjet obligatoire qui sélectionne au moins un élément parmi glossary, ruleset ou brandVoice. Chaque valeur sélectionnée est {} ou { "name": "Nonempty name" }.
sourcesTableau obligatoire et non vide, contenant au maximum dix liens ou sources textuelles.

Les paramètres du moteur respectent le contrat de création de moteur. sourceCoverage et targetCoverage sont des tableaux de langues ; [] couvre toutes les langues. Si vous omettez modelConfigs, les valeurs par défaut de la plateforme servent à initialiser les modèles ; [] ne laisse aucune configuration de modèle épinglée. Configurez les modèles du moteur avant de l’utiliser pour traduire.

L’appelant doit avoir l’autorisation de créer un moteur et les consignes demandées. Le nombre de moteurs, les fonctionnalités du forfait, le crédit du compte et les limites de débit du provisionnement peuvent entraîner le rejet de la requête.

Alimenter un moteur existant #

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

Pour alimenter uniquement les types pour lesquels le moteur n’a aucun ensemble associé :

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

Pour demander de nouveaux ensembles précis :

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

Requested peut ajouter un glossaire ou un ensemble de règles en complément des ensembles existants. Le provisionnement ne remplace jamais une voix de marque associée. Empty ignore les types dont un ensemble est déjà associé, y compris ceux associés pendant l’exécution de la tâche. Effectuez une relecture des résultats par type plutôt que de supposer que chaque requête crée les trois types.

Une seule tâche de provisionnement peut s’exécuter à la fois sur un moteur. ProvisioningJobRunning (409) inclut le jobId existant ; suivez la tâche correspondante avant de soumettre d’autres opérations. NothingToProvision (409) signifie qu’aucune des opérations demandées ne peut alimenter le moteur dans son état actuel.

Enregistrer la réponse #

Les deux routes de création renvoient un statut HTTP 200 avec une tâche de provisionnement. Enregistrez id et engineId avant de commencer à interroger périodiquement l’API. L’état initial est généralement status: { "_tag": "Running" }.

La création ne déclare aucun en-tête d’idempotence. Si une réponse est perdue, consultez les tâches en cours et la liste des moteurs avant de répéter une requête de création de moteur : cette nouvelle requête peut créer un autre moteur. La section Reprise explique ces vérifications et les nouvelles tentatives pour les types ayant échoué.