API pro návrhy engine

Generujte návrhy ze zpětné vazby, prohlížejte navržené změny a výslovně je aplikujte nebo zamítejte.

Návrhy pro engine nabízejí změny termínů v glosáři, pravidel a variant hlasu značky. Před aplikováním zkontrolujte navrhovaný obsah i jeho cíl. Generováním se návrhy přidají do Fronty; aplikováním návrhu se změní pokyny pro engine.

Návrhy pro engine jsou dostupné s plánem Enterprise. Volající navíc potřebuje přístup k engine a příslušná oprávnění k práci s návrhy. Postup na řídicím panelu najdete v části Návrhy ve Frontě.

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

Vyžádat generování #

Vygenerujte návrhy ze zpětné vazby shromážděné pro engine:

http
POST /v2/engines/:engineId/engine-suggestions/generate
X-API-Key: YOUR_API_KEY

Tento požadavek nemá tělo. Zpětnou vazbu můžete poskytnout i přímo:

http
POST /v2/engines/:engineId/engine-suggestions/from-text
Content-Type: application/json
X-API-Key: YOUR_API_KEY
json
{
  "text": "In German account settings, use Abonnement for subscription. Avoid Mitgliedschaft for this product feature."
}

text musí obsahovat alespoň jeden jiný než bílý znak a nesmí přesáhnout 10 000 znaků. Tento režim generuje návrhy přímo z poskytnuté zpětné vazby, proto uveďte zamýšlenou opravu i jazyk, kterého se týká.

Oba koncové body vracejí HTTP 200 s následujícím obsahem:

json
{ "enqueued": true }

Tato odpověď potvrzuje zařazení do fronty, nikoli dokončení generování. Po zpracování načtěte seznam čekajících návrhů pro engine. Pokud není co smysluplně změnit, generování nemusí vytvořit žádné návrhy; prázdný seznam vrácený bezprostředně po požadavku neznamená, že požadavek selhal.

Vypsat návrhy #

http
GET /v2/organizations/:orgId/engine-suggestions?engineIds=YOUR_ENGINE_ID&statuses=Pending&limit=25
Parametr dotazuVýznam
engineIdsOmezení na vybrané engine.
targetLocalesRozsahy platnosti podle jazyka, včetně * pro pokyny platné napříč jazyky.
statusesPending, Applied nebo Dismissed; výchozí hodnota je Pending.
idsNačtení návrhů s vybranými ID.
limitCelé číslo od 1 do 100; výchozí hodnota je 25.
cursorNeprůhledný kurzor stránkování.

Chcete-li zadat více hodnot, opakujte parametry typu pole. Odpověď obsahuje data a meta.nextCursor; pokračujte se stejnými filtry, dokud nextCursor nebude mít hodnotu null.

Každý návrh obsahuje:

PoleVýznam
id, organizationId, engineIdIdentifikace a vlastnictví návrhu.
targetLocaleRozsah platnosti navrhované změny podle jazyka.
changeZměna s určeným typem, popsaná níže.
reasoningOdůvodnění návrhu.
sourcesOdkazy na podklady, například hodnocení hodnoticího systému, ruční úpravu nebo pracovní položku.
statusObjekt, jehož type má hodnotu Pending, Applied nebo Dismissed.
destinationSada pokynů, do které se změna zapíše, nebo null, pokud není dostupná.
createdAt, updatedAtČasová razítka ve formátu ISO.

Cíl obsahuje kind (Glossary, Ruleset nebo BrandVoice), id s povolenou hodnotou null, name a willCreate. Podle willCreate zjistíte, zda se aplikováním vytvoří sada pokynů. Stav aplikovaného návrhu obsahuje at, by s povolenou hodnotou null a target s povolenou hodnotou null; návrhy zamítnuté systémem mohou obsahovat reason.

Prohlédnout změnu #

change.typeObsah
AddGlossaryTermsourceLocale, sourceText, targetLocale, targetText, description s povolenou hodnotou null a nonTranslatable.
UpdateGlossaryTermtermId, glossaryId s povolenou hodnotou null a zadaná pole s náhradními hodnotami.
AddRulename, text a targetLocale.
UpdateRuleruleId a zadané name, text nebo targetLocale.
AddBrandVoiceVariationtargetLocale a text.
UpdateBrandVoiceVariationvariationId a zadané targetLocale nebo text.

Návrhy aktualizací obsahují pouze pole, která se mění. Před aplikováním změny se širokým dopadem zkontrolujte cílový záznam i to, kde všude se jeho sada pokynů sdílí.

Aplikovat nebo zamítnout #

http
POST /v2/engine-suggestions/:id/apply
http
POST /v2/engine-suggestions/:id/dismiss

Ani jeden požadavek nemá tělo a oba vracejí aktualizovaný návrh. Rozhodnout lze pouze o čekajících návrzích. Aplikováním se zapíší navrhované pokyny; při zamítnutí zůstanou pokyny beze změny.

Pokud se cíl změnil nebo už neexistuje, může aplikování vrátit EngineSuggestionConflicts nebo EngineSuggestionTargetGone. Než zvolíte opravu, znovu načtěte návrh i jeho cíl. Opakované rozhodnutí o návrhu, o kterém už bylo rozhodnuto, vrátí EngineSuggestionNotPending; po nejednoznačné odpovědi zkontrolujte jeho stav, místo abyste zápis naslepo opakovali.

Rozhodnout o více návrzích #

Odešlete { "ids": ["FIRST_ID", "SECOND_ID"] } metodou POST na:

  • /v2/engine-suggestions/apply-many: 1–25 jedinečných ID.
  • /v2/engine-suggestions/dismiss-many: 1–1 000 jedinečných ID.

Aplikování vrací applied a failed; zamítnutí vrací dismissed a failed. Každá neúspěšná položka obsahuje id a pojmenovanou hodnotu error. I úspěšná odpověď HTTP může obsahovat selhání jednotlivých položek. Úspěšně zpracované položky zůstávají zachovány i při selhání jiné položky, proto každý výsledek zpracujte samostatně.

Použít upravené pokyny #

Po aplikování zkontrolujte glosář, pravidla nebo hlas značky pro engine a vyzkoušejte reprezentativní obsah. Přijaté pokyny aplikujte před spuštěním nové úlohy. Chcete-li aktualizovat stávající překlady, cíleně vyberte obsah a požádejte o obnovení; samotné aplikování pokynů není požadavkem na opětovný překlad.