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().

The result is stored as a list of Contents. Typically, the result is a single TextContent, but some LLM providers also support ImageContent in tool results.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ToolExecutionResultMessage.Builder

Constructor Summary

Constructors

Constructor	Description
ToolExecutionResultMessage(ToolExecutionResultMessage.Builder builder)	Creates a ToolExecutionResultMessage from a builder.
ToolExecutionResultMessage(String id, String toolName, String text)	Creates a ToolExecutionResultMessage.

Method Summary

Modifier and Type	Method	Description
Map<String,Object>	attributes()	Returns attributes of a message.
static ToolExecutionResultMessage.Builder	builder()	Creates a builder for ToolExecutionResultMessage.
List<Content>	contents()	Returns the Contents of the tool execution result.
boolean	equals(Object o)
static ToolExecutionResultMessage	from(ToolExecutionRequest request, String toolExecutionResult)	Creates a ToolExecutionResultMessage from a ToolExecutionRequest and the result of the tool execution.
static ToolExecutionResultMessage	from(String id, String toolName, String toolExecutionResult)	Creates a ToolExecutionResultMessage from a ToolExecutionRequest and the result of the tool execution.
int	hashCode()
boolean	hasSingleText()	Whether this message contains a single TextContent.
String	id()	Returns the id of the tool.
Boolean	isError()	Returns whether the tool execution resulted in an error.
String	text()	Returns the result of the tool execution as text.
static ToolExecutionResultMessage	toolExecutionResultMessage(ToolExecutionRequest request, String toolExecutionResult)	Creates a ToolExecutionResultMessage from a ToolExecutionRequest and 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.
String	toolName()	Returns the name of the tool.
String	toString()
ChatMessageType	type()	The type of the message.

Methods inherited from class Object

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

Constructor Details

ToolExecutionResultMessage

public ToolExecutionResultMessage(ToolExecutionResultMessage.Builder builder)

Creates a ToolExecutionResultMessage from a builder.

Since:

1.11.0

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 Details

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 as text.

Returns:

the text result of the tool execution.

Throws:

IllegalStateException - if contents contains non-text or multiple content elements. Use contents() instead.

contents

@Experimental
public List<Content> contents()

Returns the Contents of the tool execution result.

Returns:

the contents.

Since:

1.13.0

hasSingleText

@Experimental
public boolean hasSingleText()

Whether this message contains a single TextContent.

Returns:

true if this message contains exactly one element which is a TextContent.

Since:

1.13.0

See Also:

• text()

isError

public Boolean isError()

Returns whether the tool execution resulted in an error.

Returns:

true if the tool execution resulted in an error, false if it did not, null if unknown.

attributes

public Map<String,Object> attributes()

Returns attributes of a message. These attributes are not sent to the LLM, but can be persisted in a ChatMemory.

Since:

1.12.0

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

builder

public static ToolExecutionResultMessage.Builder builder()

Creates a builder for ToolExecutionResultMessage.

Returns:

the builder.

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.