5.2.1.20.4. エージェントセッション分岐¶
指定したエージェントセッションの内容を引き継いだ、新しいエージェントセッションを作成するタスクです。
分岐元のエージェントセッションはそのまま残ります。
引き継ぐ最後のメッセージを指定することで、会話の途中の状態を切り出せます。
5.2.1.20.4.1. 入力値¶
im_agentForkSession <object> *
├─ checkpointMessageId <string>
└─ sessionId <string> *
| 項目名 | 必須/任意 | 型 | 配列/リスト | 説明 |
|---|---|---|---|---|
| im_agentForkSession | 必須 | object | なし | - |
| checkpointMessageId | 任意 | string | なし | 引き継ぐ最後のメッセージの識別子を指定してください。
指定しない場合は、分岐元のすべてのメッセージを引き継ぎます。
|
| sessionId | 必須 | string | なし | 分岐元のエージェントセッションのセッションIDを指定してください。 |
5.2.1.20.4.2. 出力値¶
im_agentForkSession <object>
├─ context <object>
│ ├─ messages <object[]>
│ │ ├─ content <string>
│ │ ├─ contents <object[]>
│ │ │ ├─ imageUrl <string>
│ │ │ └─ text <string>
│ │ ├─ messageId <string>
│ │ ├─ role <string>
│ │ ├─ toolCallId <string>
│ │ ├─ toolCalls <object[]>
│ │ │ ├─ arguments <string>
│ │ │ ├─ id <string>
│ │ │ └─ name <string>
│ │ └─ toolName <string>
│ └─ usage <object>
│ ├─ inputTokens <biginteger>
│ └─ outputTokens <biginteger>
├─ owner <string>
└─ sessionId <string>
| 項目名 | 型 | 配列/リスト | 説明 |
|---|---|---|---|
| im_agentForkSession | object | なし | - |
| context | object | なし | セッションコンテキストです。分岐元のメッセージ履歴を引き継ぎます。 |
| messages | object | リスト | メッセージ履歴です。古いメッセージから順に並んだ配列が返却されます。 |
| messageId | string | なし | メッセージの識別子です。分岐すると識別子を振り直すため、分岐元の識別子とは一致しません。 |
| role | string | なし | 発話者の役割です。 user 、 assistant 、 tool のいずれかが設定されます。 |
| content | string | なし | メッセージ本文です。 |
| contents | object | リスト | テキスト・画像のリストです。 |
| text | string | なし | テキストです。 |
| imageUrl | string | なし | 画像のURLです。データURLの場合もあります。 |
| toolCallId | string | なし | role が tool の場合に、対応するツール呼び出しの識別子が設定されます。 |
| toolName | string | なし | role が tool の場合に、実行されたツール名が設定されます。 |
| toolCalls | object | リスト | role が assistant の場合に、ツール呼び出し情報が設定されます。 |
| id | string | なし | ツール呼び出しの識別子です。 |
| name | string | なし | ツール名です。 |
| arguments | string | なし | ツールへ渡された引数のJSON文字列です。 |
| usage | object | なし | 直近の応答のトークン使用量です。引き継いだ範囲にトークン使用量が保存されていない場合は設定されません。 |
| inputTokens | biginteger | なし | 入力トークン数です。 |
| outputTokens | biginteger | なし | 出力トークン数です。 |
| owner | string | なし | 作成したエージェントセッションの所有者のユーザコードです。ロジックフローの実行ユーザが設定されます。 |
| sessionId | string | なし | 作成したエージェントセッションのセッションIDです。分岐元とは異なる値が採番されます。 |
5.2.1.20.4.3. 会話の途中から分岐する¶
checkpointMessageId に、引き継ぎたい最後のメッセージの messageId を指定します。
識別子は エージェントセッション取得タスクの出力から取得できます。
特定のやり取りを雛形として活用する場合は、次のようにフローを組み立てます。
エージェントセッション取得
└─ context.messages から、雛形としたい最後のメッセージの messageId を選ぶ
エージェントセッション分岐
└─ sessionId + checkpointMessageId を指定
エージェント実行
└─ 作成されたセッションを引き継いで実行
コラム
メッセージの識別子はセッション内で有効な値です。分岐すると識別子は振り直されるため、分岐先で取得した識別子を分岐元に対して指定することはできません。
作成したエージェントセッションの所有者には、ロジックフローの実行ユーザを設定します。
コラム
コンテキストの圧縮が行われたエージェントセッションでは、エージェントセッション取得タスクが返すのは直近の圧縮以降のメッセージです。
圧縮より前のメッセージの識別子を指定した場合、分岐先には圧縮が含まれないため、圧縮前の履歴がそのまま引き継がれます。
注意
このタスクは分岐元の所有者を問いません。セッションIDを指定できれば、ロジックフローの実行ユーザ以外が所有するエージェントセッションからも分岐できます。
分岐元を実行ユーザのエージェントセッションに限る場合は、エージェントセッション取得タスクで所有者を確認したうえで、フロー内で判定してください。
注意
分岐できるのは保存済みのエージェントセッションのみです。
指定したセッションIDのエージェントセッションが存在しない場合は、タスクの実行に失敗します。
checkpointMessageId に指定したメッセージが分岐元に存在しない場合も、タスクの実行に失敗します。