Vytvoření úlohy zřizování
Vygenerujte pokyny pro nový nebo existující engine a uložte si ID úlohy pro sledování průběhu a případné obnovení.
Zřizování probíhá na pozadí a spustí se, jakmile API přijme požadavek. Všechny cesty používají https://api.lingo.dev a ověřování API.
Vytvoření a naplnění engine #
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." }
]
}Nahraďte ukázkovou URL adresou dostupné stránky s vašimi pokyny nebo místo odkazu zadejte text.
| Pole | Specifikace |
|---|---|
engine | Povinný objekt pro vytvoření engine. name nesmí být prázdné; description je nepovinné. Objekt může obsahovat také konfigurace modelů, pokrytí a nastavení pipeline. |
kinds | Povinný objekt s výběrem alespoň jedné z možností glossary, ruleset nebo brandVoice. Každá vybraná hodnota je {} nebo { "name": "Nonempty name" }. |
sources | Povinné neprázdné pole s nejvýše deseti odkazy nebo textovými zdroji. |
Nastavení engine se řídí specifikací pro vytvoření engine. sourceCoverage a targetCoverage jsou pole jazyků, přičemž [] zahrnuje všechny jazyky. Pokud vynecháte modelConfigs, použije se výchozí nastavení modelů platformy; při použití [] nezůstanou žádné pevně nastavené konfigurace modelů. Než engine použijete k překladu, nakonfigurujte jeho modely.
Volající potřebuje oprávnění k vytvoření engine i požadovaných pokynů. Požadavek může být zamítnut kvůli počtu engine, funkcím dostupným v plánu, kreditu na účtu nebo limitům četnosti zřizování.
Naplnění existujícího engine #
POST /v2/engines/:engineId/provisioning/jobs
Content-Type: application/jsonChcete-li doplnit pouze typy, pro které engine zatím nemá připojenou sadu:
{
"kinds": { "_tag": "Empty" },
"sources": [{ "_tag": "Content", "text": "Keep Acme unchanged. Use concise, friendly language." }]
}Chcete-li požádat o konkrétní nové sady:
{
"kinds": {
"_tag": "Requested",
"glossary": { "name": "Support terminology" },
"ruleset": {}
},
"sources": [{ "_tag": "Link", "url": "https://example.com/support" }]
}Requested může přidat glosář nebo sadu pravidel ke stávajícím sadám. Zřizování nikdy nenahrazuje připojený hlas značky. Empty přeskakuje typy, které už mají připojenou sadu, včetně sad připojených během běhu úlohy. Zkontrolujte výsledky pro jednotlivé typy a nepředpokládejte, že každý požadavek vytvoří všechny tři typy.
Pro jeden engine může současně běžet pouze jedna úloha zřizování. ProvisioningJobRunning (409) obsahuje stávající jobId; než zadáte další práci, sledujte průběh této úlohy. NothingToProvision (409) znamená, že žádná z požadovaných operací nemůže engine v jeho aktuálním stavu naplnit.
Uložení odpovědi #
Obě cesty pro vytvoření vracejí HTTP 200 s úlohou zřizování. Než začnete pravidelně zjišťovat stav úlohy, uložte si id a engineId. Počáteční stav je obvykle status: { "_tag": "Running" }.
Operace vytvoření nedeklaruje hlavičku idempotence. Pokud se odpověď ztratí, zkontrolujte před opakováním požadavku na vytvoření nového engine běžící úlohy a seznam engine. Opakovaný požadavek totiž může vytvořit další engine. Část Obnovení vysvětluje tyto kontroly i opakované pokusy pro typy, u kterých došlo k selhání.