Einen Bereitstellungsauftrag erstellen
Leitlinien für eine neue oder bestehende Engine generieren und die Auftrags-ID speichern, um den Fortschritt zu verfolgen und den Auftrag bei Bedarf wiederherzustellen.
Die Bereitstellung läuft im Hintergrund und startet, sobald die API die Anfrage annimmt. Alle Routen verwenden https://api.lingo.dev und API-Authentifizierung.
Eine Engine erstellen und befüllen #
POST /v2/organizations/:orgId/provisioning/jobs
Content-Type: application/json
X-API-Key: YOUR_API_KEY{
"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." }
]
}Ersetze die Beispiel-URL durch eine erreichbare Seite mit deinen Leitlinien oder gib stattdessen Text an.
| Feld | Vorgaben |
|---|---|
engine | Erforderliches Objekt zur Engine-Erstellung. name darf nicht leer sein; description ist optional. Das Objekt kann außerdem Modellkonfigurationen, Abdeckung und Pipeline-Einstellungen enthalten. |
kinds | Erforderliches Objekt zur Auswahl mindestens eines der Felder glossary, ruleset oder brandVoice. Jeder ausgewählte Wert ist {} oder { "name": "Nonempty name" }. |
sources | Erforderliches, nicht leeres Array mit höchstens zehn Links oder Textquellen. |
Für die Engine-Einstellungen gelten die Vorgaben zur Engine-Erstellung. sourceCoverage und targetCoverage sind Arrays von Sprachen; [] deckt alle Sprachen ab. Wenn du modelConfigs weglässt, werden die Standard-Modellkonfigurationen der Plattform übernommen; mit [] werden keine Modellkonfigurationen festgelegt. Konfiguriere die Modelle der Engine, bevor du sie für Übersetzungen verwendest.
Der Aufrufer benötigt sowohl die Berechtigung zur Engine-Erstellung als auch zur Erstellung der angeforderten Leitlinien. Die Anfrage kann aufgrund der Engine-Anzahl, der Tarif-Funktionen, des Kontoguthabens oder der Ratenlimits für die Bereitstellung abgelehnt werden.
Eine bestehende Engine befüllen #
POST /v2/engines/:engineId/provisioning/jobs
Content-Type: application/jsonUm nur die Typen zu ergänzen, für die der Engine noch kein Satz hinzugefügt wurde:
{
"kinds": { "_tag": "Empty" },
"sources": [{ "_tag": "Content", "text": "Keep Acme unchanged. Use concise, friendly language." }]
}Um gezielt neue Sätze anzufordern:
{
"kinds": {
"_tag": "Requested",
"glossary": { "name": "Support terminology" },
"ruleset": {}
},
"sources": [{ "_tag": "Link", "url": "https://example.com/support" }]
}Requested kann zusätzlich zu bestehenden Glossaren oder Regelsätzen ein weiteres Glossar oder einen weiteren Regelsatz hinzufügen. Die Bereitstellung ersetzt niemals eine hinzugefügte Markenstimme. Empty überspringt Typen, für die bereits ein Satz hinzugefügt wurde – auch dann, wenn dieser erst während der Auftragsausführung hinzugefügt wird. Sieh dir die Ergebnisse für jeden Typ an, statt davon auszugehen, dass jede Anfrage alle drei Typen erstellt.
Pro Engine kann immer nur ein Bereitstellungsauftrag laufen. ProvisioningJobRunning (409) enthält die vorhandene jobId; verfolge den zugehörigen Auftrag, bevor du weitere Aufgaben anforderst. NothingToProvision (409) bedeutet, dass keine der angeforderten Aufgaben die Engine in ihrem aktuellen Zustand befüllen kann.
Die Antwort speichern #
Beide Erstellungsrouten geben HTTP 200 mit einem Bereitstellungsauftrag zurück. Speichere id und engineId, bevor du mit den regelmäßigen Statusabfragen beginnst. Der Anfangszustand ist normalerweise status: { "_tag": "Running" }.
Für die Erstellung ist kein Idempotenz-Header definiert. Falls eine Antwort verloren geht, sieh dir die laufenden Aufträge und die Engine-Liste an, bevor du eine Anfrage zur Erstellung einer neuen Engine wiederholst: Dabei kann eine weitere Engine entstehen. Unter Wiederherstellung erfährst du mehr über diese Schritte und darüber, wie du fehlgeschlagene Typen erneut anforderst.