ワークフローの使い方
ワークフローを利用するには以下の基本的なステップに従ってください:
ステップ1:ワークフローの作成
ワークフロータブを開き、ワークフローを作成をクリックします。
エージェント/フローエージェントがこのワークフローを適切なタイミングでLLMに解釈させ、トリガーするためには十分かつ明確な説明を書くことが必要です。
説明を書き終えたらOKをクリックします。ワークフローの編集画面に自動的に移行します。
ステップ2:ワークフローの編集
ノードの追加
以下の2つの方法で、アクション実行用のノードを追加することができます:
方法1: 画面下部のノードを追加をクリックし、必要なコンポーネントを選択します。各コンポーネントはワークフロー内でノードとして機能します。
注意: 各コンポーネントはワークフロー内で連結することによりノードとして機能します。全てのコンポーネントには緑色の接続ポートが有ります:左が入力ポート、右が出力ポート(開始コンポーネントには出力ポートのみ、終了コンポーネントには入力ポートのみ)。これらのポートを使ってコンポーネント同士をリンクすることで、その実行順序とワークフロー内のデータ流れが定義されます。
方法2: 既存のコンポーネントの下流にノードを追加するには、出力ポート(右側)をクリックし、目的のコンポーネントを選択します。この手順を繰り返し、複数のノードを追加できます。この方法を使用すると、既存のコンポーネントと新たに追加したコンポーネント間の接続リンクが自動的に作成されます。
ノードのリンク
コンポーネントをリンクし、実行の順序とデータフローの依存関係を確立します。
方法1でノードを追加した場合、以下の手順でリンクを整理します:
- 上流ノードと下流ノードとなるコンポーネントを決定します。
- 上流コンポーネントの出力ポート(右側)をクリックして保持し、リンク線を下流コンポーネントの入力ポート(左側)にドラッグします。その後、マウスボタンを離してリンクを完了します。
リンクを削除したい場合は、リンク線をクリックし、キーボードのBackspaceキーを押します。
ノードの設定
ワークフロー内のノード(コンポーネント)の設定方法です:
- 設定したいコンポーネントをクリックし、設定パネルを開きます。
- パネル内の全ての必須フィールドに記述します。変更はリアルタイムで自動保存されます。
- パネル外の任意の場所をクリックしてパネルを閉じます。
- ワークフロー内の全てのノード(コンポーネント)の設定を完了するために、上記の手順を繰り返します。
ノードの削除
ノードを削除するためには:
- 削除したいノード(コンポーネント)をクリックし、キーボードのBackspaceキーを押します。または、
- 削除したいノード(コンポーネント)の右上角のメニューボタン⋮をクリックし、削除を選択します。
注意: ノードが削除されると、そのノードに関連する全てのリンクが削除されます。
編集モード
ワークフローのキャンバスでは、マウスモード(デスクトップ利用に最適)とタッチモード(タブレット/タッチスクリーン利用に最適)が利用可能です。これらのモードはキャンバス下部の対応するアイコンをクリックして切り替えが可能です。
ステップ3:ノードのデバッグ
ノードのデバッグとは、上流もしくは下流のノードに影響を与えずに、個別のノードの機能をテストするプロセスのことです。このステップを通じて、ノードが期待どおりの動作をし、出力することを確認できます。
ノードをデバッグするには:
- ノードの右上にあるノードデバッグボタン(▶)をクリックし、ノードデバッグパネルを開きます。(このパネル内のinputの値は、このノードの指定された入力パラメータと一致する必要があります。)
- 変数値をinputバーに入力し、実行をクリックします。
- パネル内の出力タブに切り替えて、デバッグ結果を確認します。
ステップ4:テスト実行
テスト実行は、ワークフロー全体の総合的なテストであり、その動作と出力が開発者の期待に沿っていることを確認します。テスト実行の成功はワークフローの公開の前提条件であり、成功しなければリリースできません。
ワークフローをテスト実行するには:
- ワークフローの設定ウィンドウの右上にあるテスト実行ボタンをクリックします。(このパネル内のinputの値は、開始ノードの指定された入力パラメータと一致する必要があります。)
- 変数値をinputバーに入力し、実行をクリックします。
- パネル内の出力タブに切り替えて、テスト結果を確認します。
ステップ5:ワークフローの保存
ワークフローやノードの設定変更は、編集時に自動的に保存されます。また、現在の設定を名前をつけてバージョンとして保存し、記録を残すことも可能です。
それを行うには:
- 設定ウィンドウの右上角にある保存ボタンをクリックします。
- ポップアップのバージョン保存ダイアログに必要な説明を書き、OKをクリックします。
ワークフローの手動バージョン保存を行うと、全ての履歴バージョンを表示し、必要に応じて以前の状態を復元できます。
保存したバージョンを復元するには:
- 設定ウィンドウの右上角にある公開ボタンをクリックし、公開管理ウィンドウを開きます。
- このウィンドウ内のバージョン履歴セクションで目的のバージョンを探し、復元を選択します。
ステップ6:ワークフローの公開
ワークフローがテスト実行をパスした後、対応するバージョンを公開できます。公開されたワークフローのみがユーザーによって確認・利用することができます。
テスト実行をパスしたワークフローを公開するには:
- 設定ウィンドウの右上にある公開をクリックします。
- ポップアップの公開管理ウィンドウで:
- バージョンを保存をクリックして現在の設定を名前付きバージョンとして保存し、それをバージョン履歴セクションで見つけて公開する。または、
- バージョン履歴で目的の保存バージョンを探し、公開を選択します。
ステップ7:ワークフローのAPIへの適用またはエージェントとの統合
ワークフローはAPIとして用いることも、エージェント/フローエージェントのツールとして用いることも可能です。
適用方法1:APIへの適用
設定ウィンドウで統合にアクセスし、トグルボタンをオンにしてAPIへの適用を有効にします。
管理をクリックしてAPIキー管理ウィンドウにアクセスします。ウィンドウでAPIキーを作成をクリックし、キーに名前を付けます。
次に、新しく作成したAPIキーの横にあるコピーアイコンをクリックし、リクエスト送信時にキーを貼り付けます。
ワークフローのAPI適用の詳細な説明については、API Reference - Workflow API - Integrate Workflowをご参照ください。
アプリケーション 2:エージェントへの適用
ワークフローを適用したい対象の エージェント / フローエージェント を選択します。
- Agent の場合: 設定 ウィンドウを開き、ワークフロー セクションで設定します。
- フローエージェント の場合: 設定 ウィンドウを開いて 編集 をクリックし、設定キャンバスに入ります。フローエージェント 内の任意の AIモデル コンポーネント(LLMs)を選択し、Agent と同じ手順でワークフローを設定します。
エージェント / フローエージェントにワークフローを追加する簡単な手順
- ワークフロー セクションを展開します。
- ワークフローの追加 をクリックします。
- 表示された ワークフローの追加 ポップアップで、追加したいワークフローを選択し 追加 をクリックします。
ワークフローの効果を最大限に発揮させるために、LLM の アイデンティティープロンプト に詳しいトリガー条件を記述し、いつ ワークフローを起動すべきかを明示することを推奨します。
トリガー条件が明確に定義されていると、ユーザー入力が条件を満たした際に、エージェントの LLM が自動的にワークフローを実行し、適切な応答を生成します。