Překladové úlohy

Vytvářejte a spouštějte úlohy s jedním či více dokumenty a cílovými jazyky.

Úloha překládá dokumenty pomocí jednoho lokalizačního engine. Každý dokument má stálý klíč a jeden cíl pro každý požadovaný jazyk. Pro obsah v paměti použijte vložený JSON, pro soubory adresy artefaktů.

Všechny níže uvedené koncové body používají https://api.lingo.dev a ověřování API.

Vytvoření úlohy #

http
POST /v2/organizations/:orgId/localization/jobs
Content-Type: application/json
X-API-Key: YOUR_API_KEY
Idempotency-Key: order-confirmation-v3-de-fr
json
{
  "engineId": "YOUR_ENGINE_ID",
  "sourceLocale": "en",
  "targetLocales": ["de", "fr"],
  "documents": [
    {
      "key": "order-confirmation.json",
      "format": { "type": "json" },
      "source": { "content": { "subject": "Your order is confirmed" } }
    }
  ]
}

Pole požadavku #

PolePovinnéVýznam
engineIdAnoEngine v organizaci, který může volající používat k překladu.
sourceLocaleAnoZdrojový jazyk.
targetLocalesAnoNeprázdné pole cílových jazyků bez duplicit. Cílový jazyk dokumentu se nesmí shodovat s jeho zdrojovým jazykem.
documentsAnoNeprázdné pole dokumentů s jedinečnými hodnotami key.
originIdNeNeprázdný identifikátor umístění dokumentů o délce nejvýše 512 znaků, například github:acme/web. Propojuje pozdější úpravy z tohoto umístění s měřením překladů.

Každý dokument obsahuje:

PolePovinnéVýznam
keyAnoNeprázdná logická cesta k souboru nebo jeho název. Hodnota musí být v rámci této úlohy jedinečná a mezi revizemi se nesmí měnit.
formatAnoObjekt popisující formát, který obsahuje type a options specifické pro daný formát.
sourceAnoAdresa artefaktu SHA-256 nebo { "content": { ... } } pro vložený JSON.
previousSourceNeAdresa předchozího zdrojového artefaktu. Při prvním překladu pole vynechte nebo použijte null.
previousTranslationsNePole položek { "locale": "de", "artifact": "SHA256" }. Výchozí hodnota je []; každý jazyk se smí objevit jen jednou a musí patřit mezi cílové jazyky tohoto dokumentu.
targetLocalesNeNeprázdný seznam jazyků bez duplicit, který pro tento dokument nahrazuje cílové jazyky úlohy. Pokud pole vynecháte nebo použijete null, použijí se cílové jazyky úlohy.

Při použití keyScope nebo termScope poskytněte předchozí překlad pro každý cíl. Viz formáty a aktualizace dokumentů.

Idempotence #

Odešlete neprázdnou hodnotu Idempotency-Key o délce nejvýše 255 znaků. Klíče platí v rámci daného engine; předpona content-sync: je vyhrazená. Klíč uchovejte spolu s původním požadavkem. Pokud si nejste jisti výsledkem vytvoření úlohy, zopakujte původní požadavek beze změn.

Opětovné použití klíče vrátí úlohu, která s ním byla původně vytvořena. Dokumenty ani jazyky této úlohy se neaktualizují. Pro změněné zadání použijte nový klíč. Kolidující nastavení spuštění může vést k chybě LocalizationJobIdempotencyKeyReused (422).

Odpověď na vytvoření úlohy #

Úspěšné vytvoření vrátí stav HTTP 200 a odpověď s údaji o úloze, obvykle s status: { "_tag": "Pending" }. Než budete pokračovat, trvale uložte id. Pole uploads uvádí chybějící vstupní artefakty ve tvaru { "address": "...", "uploadUrl": "..." }.

Při vytvoření se uloží vložené zdroje. Překlad se nespustí, ani když je uploads prázdné.

Nahrání a spuštění #

Nahrajte každý chybějící artefakt na jeho adresu uploadUrl pomocí ověřeného požadavku PUT s původními bajty. Poté zavolejte:

http
POST /v2/localization/jobs/:id/start
X-API-Key: YOUR_API_KEY

Požadavek na spuštění nemá tělo. Odpověď se stavem HTTP 200 obsahuje aktuální záznam úlohy. Požadavek na spuštění téže úlohy lze bezpečně opakovat, například pokud si nejste jisti, zda byla předána ke zpracování. Nevytvoří se tím další úloha ani se znovu nespustí již dokončená úloha.

Při spuštění se kontrolují nahrané artefakty, konfigurace engine a limity účtu. ArtifactsNotUploaded (409) uvádí chybějící vstupy. Při dosažení denního limitu tokenů (429) nebo nedostatku kreditů zůstane úloha čekat. Před dalším spuštěním tuto překážku odstraňte. Viz chyby.

Konfigurace fází pipeline #

Před spuštěním nakonfigurujte pipeline pro engine. Její konfigurace se zaznamená v okamžiku spuštění. Výsledné fáze jednotlivých cílů úlohy ukazují, jaké zpracování bylo skutečně vybráno s ohledem na dostupnost v daném plánu.

Získání výsledků a obnova po chybě #

Načtěte úlohu, zkontrolujte jednotlivé cíle a stáhněte dokončené soubory. Pomocí průběhu fází rozlišíte zpracování modelem, čekání na kontrolu, přeskočené zpracování a selhání.

I neúspěšná úloha může obsahovat dokončené cíle. Tyto výstupy uchovejte a po odstranění příčiny odešlete s novým klíčem idempotence jen to, co je třeba znovu vygenerovat. Revize zdrojů uchovávejte spolu s ID úloh, aby pozdější doručení nepřepsalo novější překlady.

Vypište úlohy a vyhledejte odeslané úlohy podle engine, stavu, spouštěče nebo klíče služby.