dev.langchain4j.data.message

Class ToolExecutionResultMessage

java.lang.Object

dev.langchain4j.data.message.ToolExecutionResultMessage

All Implemented Interfaces:

ChatMessage

public class ToolExecutionResultMessage
extends Object
implements ChatMessage

Represents the result of a tool execution in response to a ToolExecutionRequest. ToolExecutionRequests come from a previous AiMessage.toolExecutionRequests().

Constructor Summary

Constructors

Constructor and Description
ToolExecutionResultMessage(String id, String toolName, String text) Creates a ToolExecutionResultMessage.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object o)
static ToolExecutionResultMessage	from(String id, String toolName, String toolExecutionResult) Creates a ToolExecutionResultMessage from a ToolExecutionRequest and the result of the tool execution.
static ToolExecutionResultMessage	from(ToolExecutionRequest request, String toolExecutionResult) Creates a ToolExecutionResultMessage from a ToolExecutionRequest and the result of the tool execution.
int	hashCode()
String	id() Returns the id of the tool.
String	text() Returns the result of the tool execution.
static ToolExecutionResultMessage	toolExecutionResultMessage(String id, String toolName, String toolExecutionResult) Creates a ToolExecutionResultMessage from a ToolExecutionRequest and the result of the tool execution.
static ToolExecutionResultMessage	toolExecutionResultMessage(ToolExecutionRequest request, String toolExecutionResult) Creates a ToolExecutionResultMessage from a ToolExecutionRequest and the result of the tool execution.
String	toolName() Returns the name of the tool.
String	toString()
ChatMessageType	type() The type of the message.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

ToolExecutionResultMessage

public ToolExecutionResultMessage(String id,
                                  String toolName,
                                  String text)

Creates a ToolExecutionResultMessage.

Parameters:

id - the id of the tool.

toolName - the name of the tool.

text - the result of the tool execution.

Method Detail

id

public String id()

Returns the id of the tool.

Returns:

the id of the tool.

toolName

public String toolName()

Returns the name of the tool.

Returns:

the name of the tool.

text

public String text()

Returns the result of the tool execution.

Specified by:

text in interface ChatMessage

Returns:

the result of the tool execution.

type

public ChatMessageType type()

Description copied from interface: ChatMessage

The type of the message.

Specified by:

type in interface ChatMessage

Returns:

the type of the message

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object

from

public static ToolExecutionResultMessage from(ToolExecutionRequest request,
                                              String toolExecutionResult)

Creates a ToolExecutionResultMessage from a ToolExecutionRequest and the result of the tool execution.

Parameters:

request - the request.

toolExecutionResult - the result of the tool execution.

Returns:

the ToolExecutionResultMessage.

from

public static ToolExecutionResultMessage from(String id,
                                              String toolName,
                                              String toolExecutionResult)

Creates a ToolExecutionResultMessage from a ToolExecutionRequest and the result of the tool execution.

Parameters:

id - the id of the tool.

toolName - the name of the tool.

toolExecutionResult - the result of the tool execution.

Returns:

the ToolExecutionResultMessage.

toolExecutionResultMessage

public static ToolExecutionResultMessage toolExecutionResultMessage(ToolExecutionRequest request,
                                                                    String toolExecutionResult)

Creates a ToolExecutionResultMessage from a ToolExecutionRequest and the result of the tool execution.

Parameters:

request - the request.

toolExecutionResult - the result of the tool execution.

Returns:

the ToolExecutionResultMessage.

toolExecutionResultMessage

public static ToolExecutionResultMessage toolExecutionResultMessage(String id,
                                                                    String toolName,
                                                                    String toolExecutionResult)

Creates a ToolExecutionResultMessage from a ToolExecutionRequest and the result of the tool execution.

Parameters:

id - the id of the tool.

toolName - the name of the tool.

toolExecutionResult - the result of the tool execution.

Returns:

the ToolExecutionResultMessage.