API Ultineo Reasoning
Spouštějte aplikace z katalogu ze svého vlastního softwaru. API komunikuje v JSON přes HTTPS, každé volání ověřuje klíčem projektu a na každé volání odpovídá ve stejném formátu.
Postaveno na aplikacích, bězích a klíčích
- Aplikace
Vytvořte aplikaci z modelu, jejích vstupních polí a pokynů a pak své aplikace vypisujte, čtěte a upravujte.
- Běhy a kvóta
Jedno volání spustí aplikaci s jejími vstupy, další načte běh zpět i s odpovědí. Souhrn ukazuje tokeny, které vám zbývají v aktuálním fakturačním období.
- Klíče
Klíče projektu s oprávněními, volitelnou platností a stavem, který můžete vypnout.
Integrate it anywhere
- In your software
Add a reasoning step to an existing screen: a summary, a suggested reply, a classification.
- In your automations
A script or an automation tool launches a run at each event: a form received, a file dropped.
- From one answer to the next
The answer of one run can become a field of the next: your code chains the steps as it sees fit.
The same run, through the API
Your software sends the application’s identifier and its fields, then reads the run back until it is finished.
What you send
{
"app_id": "mapp_0ceacb46e5b3a99e91b6",
"data": {
"message": "My parcel has not arrived and the tracking has not moved for a week."
}
}What you read back
{
"id": "runi_1b7f4e0c96a2d8531fca",
"object": "reasoning",
"status": "finished",
"response": { "miid_9a4c07e5b312df8641ca": "urgent" },
"tokens": { "input": 412, "output": 3, "total": 415 },
"duration": 1.84
}Ověřování a oprávnění
- Klíč typu bearer
Při každém volání posílejte klíč projektu v hlavičce Authorization, a to výhradně přes HTTPS.
- Omezený na jeden projekt
Klíč je vázán na jeden projekt a nikdy nemůže číst ani zapisovat data jiného projektu, ať je požadavek jakýkoli.
- Uložený jako hash
Uchovává se pouze hash klíče, takže se klíč celý zobrazí jen jednou. Ztracený klíč se nahradí, nikdy se neobnovuje.
Spusťte běh a přečtěte si jeho odpověď
- Vytvořit
Uveďte aplikaci a zadejte jednu hodnotu pro každé vstupní pole, označenou názvem pole, který vrací aplikace.
- Sledovat
Běhy jsou asynchronní: načítejte běh znovu, dokud jeho stav není dokončený nebo neúspěšný. Oba stavy jsou konečné.
- Načíst
Dokončený běh obsahuje svou odpověď, dobu trvání a počty tokenů na vstupu a výstupu.
Jednotný formát pro každou odpověď
- Vždy stejná tři pole
Každá odpověď obsahuje stavový kód, krátký název a samotný obsah, při úspěchu i při chybě.
- Stálé zprávy
Chybové zprávy jsou stálé anglické řetězce, které uvádějí chybějící oprávnění nebo odmítnutou hodnotu.
- Limity tarifu jsou jasné
Volání, které tarif nepokrývá nebo které by překročilo jeho kvótu, je odmítnuto s vlastním stavovým kódem.
Jak získat klíč
Přístup k API je součástí placených tarifů Ultineo Reasoning. Samoobslužná registrace zatím není k dispozici: náš tým založí váš projekt a předá vám jeho první klíč.
Propojte svůj software s Ultineo Reasoning
Řekněte nám, co chcete automatizovat, a my založíme váš projekt a jeho klíč API.
Otázky k API
Placené tarify. Bezplatný tarif dává přístup k aplikacím bez API.
Ne. Instrukce patří vlastníkovi aplikace. API vrací vstupní pole, protože právě ta vyplňuje volající.
Vytvoření běhu se vrátí okamžitě s novým stavem. Odpověď získáte tak, že běh načítáte znovu, dokud není dokončený.
Ano. Každý klíč má svá oprávnění a volitelnou platnost a klíč nikdy nemůže vytvořit jiný klíč s širšími oprávněními, než má sám.