API Ultineo Reasoning
Uruchamiaj aplikacje z katalogu z własnego oprogramowania. API komunikuje się w JSON przez HTTPS, uwierzytelnia każde wywołanie kluczem projektu i odpowiada na każde wywołanie w tym samym formacie.
Zbudowane wokół aplikacji, uruchomień i kluczy
- Aplikacje
Utwórz aplikację na podstawie jej pól wejściowych i instrukcji, a następnie wyświetlaj, odczytuj i edytuj swoje aplikacje.
- Runs and usage
Jedno wywołanie uruchamia aplikację z jej danymi wejściowymi, a drugie odczytuje uruchomienie wraz z odpowiedzią. Podsumowanie pokazuje tokeny zużyte w bieżącym tygodniu rozliczeniowym oraz ich kwotę.
- Klucze
Klucze projektu z zakresami uprawnień, opcjonalną datą wygaśnięcia i statusem, który możesz wyłączyć.
Integruj go wszędzie
- In your software
Add a reasoning step to an existing screen: a summary, a suggested reply, a classification.
- W Two automatyzacjach
A script or an automation tool launches a run at each event: a form received, a file dropped.
- Od jednej odpowiedzi do drugiej
Wynik jednego wykonania może stać się polem kolejnego: Twój kod łączy kroki tak, jak uznasz za stosowne.
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.
Co wysyłasz
{
"app_id": "mapp_0ceacb46e5b3a99e91b6",
"data": {
"message": "My parcel has not arrived and the tracking has not moved for a week."
}
} To, co przeczytasz ponownie
{
"id": "runi_1b7f4e0c96a2d8531fca",
"object": "reasoning",
"status": "finished",
"response": { "miid_9a4c07e5b312df8641ca": "urgent" },
"tokens": { "input": 412, "output": 3, "total": 415 },
"duration": 1.84
} Uwierzytelnianie i zakresy uprawnień
- Klucz typu bearer
Wysyłaj klucz projektu w nagłówku Authorization każdego wywołania, wyłącznie przez HTTPS.
- Ograniczony do jednego projektu
Klucz jest powiązany z jednym projektem i nigdy nie może odczytać ani zapisać danych innego projektu, bez względu na żądanie.
- Przechowywany jako hash
Przechowywany jest tylko skrót (hash) klucza, dlatego klucz jest wyświetlany w całości tylko raz. Utracony klucz jest zastępowany, nigdy odzyskiwany.
Uruchom aplikację i odczytaj odpowiedź
- Utwórz
Wskaż aplikację i podaj jedną wartość dla każdego pola wejściowego, przypisaną do nazwy pola zwracanej przez aplikację.
- Śledź
Uruchomienia są asynchroniczne: odczytuj uruchomienie ponownie, aż jego status będzie zakończone lub nieudane. Oba statusy są ostateczne.
- Odczytaj
Zakończone uruchomienie zawiera odpowiedź, czas trwania oraz liczbę tokenów wejściowych i wyjściowych.
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.
Jeden format dla każdej odpowiedzi
- Zawsze te same trzy pola
Każda odpowiedź zawiera kod statusu, krótki tytuł i treść odpowiedzi, zarówno przy powodzeniu, jak i przy błędzie.
- Stałe komunikaty
Komunikaty o błędach to stałe teksty w języku angielskim, które wskazują brakujący zakres uprawnień lub odrzuconą wartość.
- Refusals are explicit
A call that cannot be accepted, for example while an invoice is overdue, is refused with its own status code.
Jak uzyskać klucz
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.
Połącz swoje oprogramowanie z Ultineo Reasoning
Powiedz nam, co chcesz zautomatyzować, a otworzymy Twój projekt i jego klucz API.
Pytania o API
Yes. Every project can call the API; a call is billed like any other run, on the tokens it uses.
Nie. Instrukcje należą do właściciela aplikacji. API zwraca pola wejściowe, ponieważ to je wypełnia wywołujący.
Utworzenie uruchomienia od razu zwraca nowy status. Odczytuj uruchomienie ponownie, aż się zakończy, aby otrzymać odpowiedź.
Tak. Każdy klucz ma zakresy uprawnień i opcjonalną datę wygaśnięcia, a klucz nigdy nie może utworzyć innego klucza o szerszym zakresie niż własny.