jp.co.intra_mart.foundation.copilot.action.chat

インタフェース ChatAction

すべてのスーパーインタフェース:

Action<List<ChatMessage>,ChatOption,List<ChatMessage>>

public interface ChatAction
extends Action<List<ChatMessage>,ChatOption,List<ChatMessage>>

チャットを行うアクションの共通インタフェースです。

導入されたバージョン:

8.0.0

バージョン:

8.0.3

メソッドのサマリー

修飾子とタイプ	メソッドと説明
List<ChatMessage>	execute(List<ChatMessage> messages) オプションを指定せずにチャットを実行します。
List<ChatMessage>	execute(List<ChatMessage> messages, ChatOption option) オプションを指定してチャットを実行します。
void	execute(List<ChatMessage> messages, ChatOption option, ChatActionChunkHandler handler) チャットを実行し、応答をストリーミングで取得します。
List<ChatMessage>	execute(List<ChatMessage> messages, ChatOption option, ToolConfig toolConfig) オプションとツール設定を指定してチャットを実行します。
void	execute(List<ChatMessage> messages, ChatOption option, ToolConfig toolConfig, ChatActionChunkHandler handler) オプションとツール設定を指定してチャットを実行し、応答をストリーミングで取得します。
default ActionType	getActionType() このアクションの種別を返します。

インタフェースから継承されたメソッド jp.co.intra_mart.foundation.copilot.action.Action

getDriverType, setDriverInfo

メソッドの詳細

execute

List<ChatMessage> execute(List<ChatMessage> messages)
                   throws CopilotServiceActionException

オプションを指定せずにチャットを実行します。

定義:

execute インタフェース内 Action<List<ChatMessage>,ChatOption,List<ChatMessage>>

パラメータ:

messages - チャットメッセージの配列

戻り値:

返答が追加されたチャットメッセージの配列

例外:

CopilotServiceActionException - 処理に失敗した時

execute

List<ChatMessage> execute(List<ChatMessage> messages,
                          ChatOption option)
                   throws CopilotServiceActionException

オプションを指定してチャットを実行します。

定義:

execute インタフェース内 Action<List<ChatMessage>,ChatOption,List<ChatMessage>>

パラメータ:

messages - チャットメッセージの配列

option - オプション

戻り値:

返答が追加されたチャットメッセージの配列

例外:

CopilotServiceActionException - 処理に失敗した時

execute

void execute(List<ChatMessage> messages,
             ChatOption option,
             ChatActionChunkHandler handler)
      throws CopilotServiceActionException

チャットを実行し、応答をストリーミングで取得します。

パラメータ:

messages - チャットメッセージの配列

option - オプション

handler - 応答のチャンクデータを受け付けるハンドラ

例外:

CopilotServiceActionException - 処理に失敗した時

execute

List<ChatMessage> execute(List<ChatMessage> messages,
                          ChatOption option,
                          ToolConfig toolConfig)
                   throws CopilotServiceActionException

オプションとツール設定を指定してチャットを実行します。

パラメータ:

messages - チャットメッセージの配列

option - オプション

toolConfig - ツール設定

戻り値:

返答が追加されたチャットメッセージの配列

例外:

CopilotServiceActionException - 処理に失敗した時

execute

void execute(List<ChatMessage> messages,
             ChatOption option,
             ToolConfig toolConfig,
             ChatActionChunkHandler handler)
      throws CopilotServiceActionException

オプションとツール設定を指定してチャットを実行し、応答をストリーミングで取得します。

パラメータ:

messages - チャットメッセージの配列

option - オプション

toolConfig - ツール設定

handler - 応答のチャンクデータを受け付けるハンドラ

例外:

CopilotServiceActionException - 処理に失敗した時

getActionType

default ActionType getActionType()

インタフェースからコピーされた説明: Action

このアクションの種別を返します。

定義:

getActionType インタフェース内 Action<List<ChatMessage>,ChatOption,List<ChatMessage>>

戻り値:

アクション種別