API Ultineo Reasoning
Spúšťajte aplikácie z katalógu zo svojho vlastného softvéru. API komunikuje v JSON cez HTTPS, každé volanie overuje kľúčom projektu a na každé volanie odpovedá v rovnakom formáte.
Postavené na aplikáciách, behoch a kľúčoch
- Aplikácie
Vytvorte aplikáciu z jej vstupných polí a pokynov a potom svoje aplikácie vypisujte, čítajte a upravujte.
- Runs and usage
Jedno volanie spustí aplikáciu s jej vstupmi, ďalšie načíta beh späť aj s odpoveďou. Súhrn ukazuje tokeny spotrebované v aktuálnom fakturačnom týždni a ich sumu.
- Kľúče
Kľúče projektu s oprávneniami, voliteľnou platnosťou a stavom, ktorý môžete vypnúť.
Integrujte ju kamkoľvek
- In your software
Add a reasoning step to an existing screen: a summary, a suggested reply, a classification.
- Vo vašich automatizáciách
A script or an automation tool launches a run at each event: a form received, a file dropped.
- Od jednej odpovede k ďalšej
Výsledok jedného behu sa môže stať poľom ďalšieho: váš kód reťazí kroky, ako si to zvolí.
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.
Čo zasielate
{
"app_id": "mapp_0ceacb46e5b3a99e91b6",
"data": {
"message": "My parcel has not arrived and the tracking has not moved for a week."
}
} Čo ste sa naposlom prečítali
{
"id": "runi_1b7f4e0c96a2d8531fca",
"object": "reasoning",
"status": "finished",
"response": { "miid_9a4c07e5b312df8641ca": "urgent" },
"tokens": { "input": 412, "output": 3, "total": 415 },
"duration": 1.84
} Overovanie a oprávnenia
- Kľúč typu bearer
Pri každom volaní posielajte kľúč projektu v hlavičke Authorization, a to výhradne cez HTTPS.
- Obmedzený na jeden projekt
Kľúč je viazaný na jeden projekt a nikdy nemôže čítať ani zapisovať údaje iného projektu, nech je požiadavka akákoľvek.
- Uložený ako hash
Uchováva sa iba hash kľúča, takže sa kľúč celý zobrazí len raz. Stratený kľúč sa nahradí, nikdy sa neobnovuje.
Spustite beh a prečítajte si jeho odpoveď
- Vytvoriť
Uveďte aplikáciu a zadajte jednu hodnotu pre každé vstupné pole, označenú názvom poľa, ktorý vracia aplikácia.
- Sledovať
Behy sú asynchrónne: načítavajte beh znova, kým jeho stav nie je dokončený alebo neúspešný. Oba stavy sú konečné.
- Načítať
Dokončený beh obsahuje svoju odpoveď, trvanie a počty tokenov na vstupe a výstupe.
The runs your software started, one by one
Every call made through the API appears in the reasonings list, marked API, with its duration and its tokens. Each application shows the identifier your software calls.
Jednotný formát pre každú odpoveď
- Vždy rovnaké tri polia
Každá odpoveď obsahuje stavový kód, krátky názov a samotný obsah, pri úspechu aj pri chybe.
- Stále hlásenia
Chybové hlásenia sú stále anglické reťazce, ktoré uvádzajú chýbajúce oprávnenie alebo odmietnutú hodnotu.
- Refusals are explicit
A call that cannot be accepted, for example while an invoice is overdue, is refused with its own status code.
Ako získať kľúč
API access is included with Ultineo Reasoning. There is no self-service sign-up: our team opens your project and hands you its first key.
Prepojte svoj softvér s Ultineo Reasoning
Povedzte nám, čo chcete automatizovať, a my založíme váš projekt a jeho kľúč API.
Otázky k API
Yes. Every project can call the API; a call is billed like any other run, on the tokens it uses.
Nie. Inštrukcie patria vlastníkovi aplikácie. API vracia vstupné polia, pretože práve tie vypĺňa volajúci.
Vytvorenie behu sa vráti okamžite s novým stavom. Odpoveď získate tak, že beh načítavate znova, kým nie je dokončený.
Áno. Každý kľúč má svoje oprávnenia a voliteľnú platnosť a kľúč nikdy nemôže vytvoriť iný kľúč so širšími oprávneniami, než má sám.