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 modelu, jej pól wejściowych i instrukcji, a następnie wyświetlaj, odczytuj i edytuj swoje aplikacje.
- Uruchomienia i limit
Jedno wywołanie uruchamia aplikację z jej danymi wejściowymi, a drugie odczytuje uruchomienie wraz z odpowiedzią. Podsumowanie pokazuje tokeny pozostałe w bieżącym okresie rozliczeniowym.
- Klucze
Klucze projektu z zakresami uprawnień, opcjonalną datą wygaśnięcia i statusem, który możesz wyłączyć.
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
}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.
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ść.
- Jasne limity planu
Wywołanie, którego plan nie obejmuje lub które przekroczyłoby jego pulę, jest odrzucane z własnym kodem statusu.
Jak uzyskać klucz
Dostęp do API jest częścią płatnych planów Ultineo Reasoning. Samodzielna rejestracja nie jest jeszcze dostępna: nasz zespół otwiera Twój projekt i przekazuje Ci jego pierwszy klucz.
Połącz swoje oprogramowanie z Ultineo Reasoning
Powiedz nam, co chcesz zautomatyzować, a otworzymy Twój projekt i jego klucz API.
Pytania o API
Płatne plany. Plan bezpłatny daje dostęp do aplikacji bez API.
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.