12.3.8. IM-Copilot¶
Contents
12.3.8.1. IM-Copilot¶
12.3.8.1.1. アシスタント実行¶
生成AIアシスタントの実行を行うエレメントです。
12.3.8.1.1.1. エレメント固有プロパティ¶
12.3.8.1.1.1.1. assistantId¶
実行するアシスタントのIDを指定します。
| 入力種別 | 初期値 | 必須/任意 | 入力/出力 | 固定値/変数値 | 入力候補 |
|---|---|---|---|---|---|
| 文字列入力 | 必須 | 入力のみ | 固定値 | なし |
12.3.8.1.1.1.2. useThreadId¶
threadIdを使用するかどうかを指定します。
| 入力種別 | 初期値 | 必須/任意 | 入力/出力 | 固定値/変数値 | 入力候補 |
|---|---|---|---|---|---|
| 文字列入力 | 使用しない | 必須 | 入力のみ | 固定値 | 使用しない
ランダム値を使用する
threadIdプロパティを使用する
|
12.3.8.1.1.1.3. threadId¶
メッセージ履歴を一意にするIDを指定します。
useThreadIdを「threadIdプロパティを使用する」とした場合のみ有効です。
| 入力種別 | 初期値 | 必須/任意 | 入力/出力 | 固定値/変数値 | 入力候補 |
|---|---|---|---|---|---|
| 文字列入力 | 任意 | 入出力 | 固定値
変数値
|
なし |
12.3.8.1.1.1.4. beforeSendParam¶
アシスタント実行パラメータを取得する変数を指定します。
パラメータはJSON文字列で扱われるため、指定する変数は文字列型で定義してください。
| 入力種別 | 初期値 | 必須/任意 | 入力/出力 | 固定値/変数値 | 入力候補 |
|---|---|---|---|---|---|
| 文字列入力 | 任意 | 入出力 | 変数値 | なし |
12.3.8.1.1.1.5. beforeSend¶
アシスタント実行前に呼び出すアクションを指定します。
アシスタントの実行前に任意の処理を行いたい場合や、アシスタント実行パラメータに任意を値を追加したい場合に利用します。
| 入力種別 | 初期値 | 必須/任意 | 入力/出力 | 固定値/変数値 | 入力候補 |
|---|---|---|---|---|---|
| アクション選択 | <なし> | 任意 | 入力のみ | 固定値 | なし |
12.3.8.1.1.1.6. beforeSendResult¶
アシスタント実行パラメータに任意の値を追加した場合に変更後のパラメータを設定する変数を指定します。
パラメータはJSON文字列で扱われるため、指定する変数は文字列型で定義してください。
| 入力種別 | 初期値 | 必須/任意 | 入力/出力 | 固定値/変数値 | 入力候補 |
|---|---|---|---|---|---|
| 文字列入力 | 任意 | 入出力 | 変数値 | なし |
12.3.8.1.1.1.7. callbackParam¶
アシスタントの実行結果を取得する変数を指定します。
パラメータはJSON文字列で扱われるため、指定する変数は文字列型で定義してください。
| 入力種別 | 初期値 | 必須/任意 | 入力/出力 | 固定値/変数値 | 入力候補 |
|---|---|---|---|---|---|
| 文字列入力 | 任意 | 入出力 | 変数値 | なし |
12.3.8.1.1.1.8. callback¶
アシスタント実行結果を受け取るアクションを指定します。
アシスタントの実行結果を受け取った際に任意の処理を行いたい場合に利用します。
| 入力種別 | 初期値 | 必須/任意 | 入力/出力 | 固定値/変数値 | 入力候補 |
|---|---|---|---|---|---|
| アクション選択 | <なし> | 任意 | 入力のみ | 固定値 | なし |
12.3.8.1.1.1.9. callbackResult¶
アシスタント実行エレメントに出力する実行結果メッセージを設定する変数を指定します。
実行結果メッセージは以下のような構造のJSON文字列を指定してください。
{
“type”: “output_message”,
“message”: {
“format”: “markdown” or “text”,
“contents”: “出力するメッセージ”,
}
}
| 入力種別 | 初期値 | 必須/任意 | 入力/出力 | 固定値/変数値 | 入力候補 |
|---|---|---|---|---|---|
| 文字列入力 | 任意 | 入出力 | 変数値 | なし |