カスタムモデル定義
- 最終更新日2024/12/09
カスタムモデル定義
カスタムモデル定義により、さまざまな環境にある多様なプラットフォームでホストされている外部 生成 AI モデルと統合し、活用することができます。これには オンプレミス インフラストラクチャ、プライベートクラウド、およびパブリッククラウドプラットフォームが含まれます。
カスタム モデル API を使用すると、任意の REST API 互換モデルに接続でき、より幅広い AI ソリューションを利用することができます。
カスタム モデルの必要性
生成 AI 技術の急速な進歩により、それぞれの強みと専門性を持つ幅広い基盤モデルが利用可能になりました。 Automation Anywhere内にAI エージェント Studioが事前統合されたモデルの選択肢を提供する一方で、他のモデルを活用する必要がある理由としては次のようなものがあります。
- 専門モデル
-
あなたは、特定のデータセットでトレーニングされたモデルを開発または取得したか、ビジネスニーズに関連するユニークなタスクに合わせてファインチューニングしました。
- データの安全性および所在
-
データ セキュリティ ポリシーや規制要件が厳しい組織は、オンプレミスのインフラストラクチャやプライベート クラウドなど、自社の安全な環境内でホストされているモデルを使用する必要があるかもしれません。
- 既存の投資を活用
-
プラットフォーム上で AI モデルの開発と展開にすでに投資している組織は、これらのモデルを直接Automation Anywhereワークフローに統合する能力から恩恵を受けることができます。
カスタムモデルAPI
これらに対応するために、Automation Anywhereはカスタム モデル APIを開発しました。これにより、カスタム生成 AIモデルを定義して接続することができます。 これらの API は、ベンダー、名前、認証メカニズム、入力パラメータ、および出力マッピングに関する情報をControl Roomインスタンスのデータベースにシードすることによって機能します。
-
POST https:/{{ControlRoomURL}}/gai/prompttools/v1/custommodel- この API は新しいカスタム モデル定義を作成します。
- モデルに関する情報をカプセル化する JSON ペイロード スキーマが必要です （モデルについて）。 スキーマは、ベンダーのような属性を定義します （名前、特定のモデルの名前、認証プロトコル、API）。 エンドポイントの詳細（パスパラメータ、クエリパラメータ、および 必要なヘッダー）、リクエストとレスポンスの構造 ボディ。
- API は、ユーザーがリクエスト内で変数を定義できるようにし、
実行時に動的に埋め込むことができるレスポンス ボディ。
これらの変数は異なる目的に使用するために特定のアノテーションを使って
指定できます。
-
PROMPT_QUERY: このアノテーションは 対応する変数を以下と置き換えることを示します： ユーザーが AI スキル ページに提供したプロンプト。 これは合格するために不可欠です。 ユーザー入力プロンプトをモデルに送信します。 -
リクエスト パラメータ: これは アノテーションは、変数が公開されるべきであることを示しています。 モデル接続 ページの構成可能なパラメーター。 -
モデル パラメータ: 類似しているリクエスト パラメーター、このアノテーション AI スキル ページの設定用変数を指定します。 -
RESPONSE_PARAMETER: これは アノテーションは、AI モデルからの応答に 変数が返されることを示します。
-
- API は、モデルが正常に作成されるとともに
200 OKの レスポンスを返します。
-
GET https:/{{ControlRoomURL}}/gai/prompttools/v1/custommodel/vendors/{vendorName}/models/{modelName}- この API は既存のカスタム モデルの定義を取得します。
- ベンダー名 (
vendorName) と モデル名 (modelName) をパス パラメータとして使用します。 - API は、
200 OKレスポンスを返し、要求されたモデルを表すオブジェクトが 含まれています。
-
DELETE https:/{{ControlRoomURL}}/gai/prompttools/v1/custommodel/vendors/{vendorName}/models/{modelName}- この API は既存のカスタム モデルを削除します。
- GET APIと似ており、(
vendorName)を使用し、 (modelName) をパスパラメータとして ターゲット モデル識別します。注: モデルは 現在アクティブなモデル接続に関連付けられていない場合のみ削除されます。 つまり、モデル定義を削除する前に、 すべてのAI スキルおよびタスク Botを モデル接続削除する 必要があります。 - 正常に削除されるとAPI は
204 No Contentレスポンス を返します。
-
POST https:/{{ControlRoomURL}}/gai/prompttools/v1/custommodel/list- この API は、すべてのカスタム モデルのリストを取得します。 （Control Room 内のベンダーに対して定義されているもの）。
- これは、
FilterRequestオブジェクトを含むオプションのリクエスト本文を受け入れ、 ユーザーが特定の基準に基づいて結果をフィルタリングできるようにします。 - API は、要求されたモデルを含むオブジェクトを含む
200 OKの レスポンスを返します。
詳細については、AI エージェント スタジオ APIをご覧ください。 ここからダウンロードできるPostmanコレクションは、AI エージェント Studio - カスタムモデルに接続するための例のAPI呼び出しを 含むカスタムモデル定義です。