EmbeddingsActionオブジェクト
コンポーネント情報 | |
---|---|
version | 8.0.0 |
since | 8.0.0 |
埋め込みアクションを実行するためのクラスです。
Java版のEmbeddingsActionクラスとは異なり、直接インスタンスを生成して利用可能です。
このAPIを利用するためには以下の前提条件を満たしている必要があります。
実装例は以下の通りです。
Java版のEmbeddingsActionクラスとは異なり、直接インスタンスを生成して利用可能です。
このAPIを利用するためには以下の前提条件を満たしている必要があります。
- モジュール構成にて「IM-Copilot」モジュールを選択し WARファイルが作成されていること
- IM-Copilot ドライバ設定ファイルにて、利用テナントについて、アクセス先のLLMのドライバ設定が行われていること
- IM-Copilot アクション設定ファイルにて、利用テナントについて、アクション種別"embeddings"の設定が行われていること
実装例は以下の通りです。
- オプション指定ありで埋め込みを行う場合(オプションは省略可能です)
var action = new EmbeddingsAction(); var result = action.execute('猫', { model: 'text-embedding-3-large' }); // // 成功した場合 // // 処理結果オブジェクトのdataプロパティには、計算された結果の埋め込みベクトルを表すNumber型の配列が設定されます。 // result = { // error: false, // data: [ // -0.00971921905875206, // -0.008021094836294651, // -0.007602432277053595, // 0.012293794192373753, // (略) // ] // }; // // 失敗した場合 // // 詳細なエラー内容は、出力される例外ログ内に記載されます。 // result = { // error: true, // data: null, // errorMessage: 'OpenAIにて埋め込み実行に失敗しました。' // };
コンストラクタの概要
EmbeddingsAction () コンストラクタ。設定ファイルの記述に従って埋め込みアクションを作成します。 |
メソッドの概要
返却値の型 | メソッド名 |
---|---|
ResultObject | execute (String text , EmbeddingsOption [option] ) 埋め込みを実行します。 |
String | getActionType () このアクションの種別を返します。 |
String | getDriverType () このアクションのドライバ種別を返します。 |
コンストラクタの詳細
EmbeddingsAction ()
コンストラクタ。設定ファイルの記述に従って埋め込みアクションを作成します。
|
メソッドの詳細
ResultObject execute (String text , EmbeddingsOption [option] )
埋め込みを実行します。
パラメータ
返却値
|
String getActionType ()
このアクションの種別を返します。
埋め込みアクションでは、固定で"embeddings"です。
返却値
|
String getDriverType ()
このアクションのドライバ種別を返します。
返却値
|