Ultineo Reasoning の API
カタログのアプリケーションを自社のソフトウェアから実行できます。API は HTTPS 上で JSON を扱い、各呼び出しをプロジェクトキーで認証し、すべての呼び出しに同じ形式で応答します。
アプリ、実行、キーを中心に設計
- アプリ
モデル、入力フィールド、指示からアプリを作成し、作成したアプリの一覧表示、参照、編集ができます。
- 実行とクォータ
1 回の呼び出しでアプリを入力とともに起動し、別の呼び出しで実行結果と回答を読み取ります。サマリーには、請求サイクル内の残りトークン数が表示されます。
- キー
スコープ、任意の有効期限、無効化できるステータスを備えたプロジェクトキー。
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
}認証とスコープ
- Bearer キー
すべての呼び出しで、プロジェクトキーを Authorization ヘッダーに入れて送信してください。通信は HTTPS のみです。
- 1 つのプロジェクトに限定
キーは 1 つのプロジェクトに紐づき、どのようなリクエストであっても、別のプロジェクトのデータを読み書きすることはできません。
- ハッシュとして保存
保存されるのはキーのハッシュのみのため、キー全体が表示されるのは 1 回だけです。紛失したキーは再発行され、復元されることはありません。
実行を開始して回答を読み取る
- 作成
アプリケーションを指定し、アプリケーションが返すフィールド名をキーにして、入力フィールドごとに値を 1 つ渡します。
- 追跡
実行は非同期です。ステータスが完了または失敗になるまで読み取りを繰り返してください。どちらも最終状態です。
- 読み取り
完了した実行には、回答、所要時間、入力と出力のトークン数が含まれます。
すべての応答に共通の形式
- 常に同じ 3 つのフィールド
すべての応答には、成功時も失敗時も、ステータスコード、短いタイトル、レスポンスが含まれます。
- 一貫したメッセージ
エラーメッセージは英語の固定文字列で、不足しているスコープや拒否された値を示します。
- 明確なプランの上限
プランの対象外の呼び出しや、利用枠を超える呼び出しは、専用のステータスコードで拒否されます。
キーの取得
API アクセスは Ultineo Reasoning の有料プランに含まれます。セルフサービスでの登録にはまだ対応していません。当社チームがプロジェクトを開設し、最初のキーをお渡しします。
お使いのソフトウェアを Ultineo Reasoning に接続
自動化したい内容をお聞かせください。プロジェクトと API キーを開設します。
API に関するご質問
有料プランです。無料プランではアプリケーションを利用できますが、API は含まれません。
いいえ。指示はアプリケーションの所有者のものです。API が返すのは入力フィールドで、呼び出し側が入力するのはこの部分です。
実行を作成すると、新しいステータスがすぐに返されます。回答を得るには、実行が完了するまで読み取りを繰り返してください。
はい。各キーにはスコープと任意の有効期限があり、キーが自分より広いスコープを持つ別のキーを作成することはできません。