Class ToolExecution

java.lang.Object

dev.langchain4j.service.tool.ToolExecution

public class ToolExecution
extends Object

Represents the execution of a tool, including the request and the result.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	ToolExecution.Builder

Method Summary

Modifier and Type	Method	Description
static ToolExecution.Builder	builder()
Duration	duration()	Returns the duration of the tool execution, or null if timing was not recorded.
boolean	equals(Object object)
LocalDateTime	finishTime()	Returns the time when the tool execution finished, or null if not recorded.
boolean	hasFailed()	Indicates whether the tool execution result represents an error.
int	hashCode()
InvocationContext	invocationContext()	Returns the invocation context of the tool execution.
ToolExecutionRequest	request()	Returns the request of the tool execution.
String	result()	Returns the tool execution result as text.
List<Content>	resultContents()	Returns the contents of the tool execution result.
Object	resultObject()	Returns the tool execution result as object.
LocalDateTime	startTime()	Returns the time when the tool execution started, or null if not recorded.
String	toString()

Methods inherited from class Object

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

Method Details

request

public ToolExecutionRequest request()

Returns the request of the tool execution.

Returns:

the request of the tool execution.

result

public String result()

Returns the tool execution result as text.

Returns:

the result of the tool execution.

See Also:

• resultContents()
• resultObject()

resultContents

@Experimental
public List<Content> resultContents()

Returns the contents of the tool execution result. For text-only results, returns a singleton list containing a TextContent.

Since:

1.13.0

See Also:

• result()
• resultObject()

resultObject

public Object resultObject()

Returns the tool execution result as object. This object is the actual value returned by the tool.

Returns:

the result of the tool execution.

See Also:

• result()

hasFailed

public boolean hasFailed()

Indicates whether the tool execution result represents an error.

startTime

public LocalDateTime startTime()

Returns the time when the tool execution started, or null if not recorded.

finishTime

public LocalDateTime finishTime()

Returns the time when the tool execution finished, or null if not recorded.

duration

public Duration duration()

Returns the duration of the tool execution, or null if timing was not recorded.

invocationContext

public InvocationContext invocationContext()

Returns the invocation context of the tool execution.

equals

public boolean equals(Object object)

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 ToolExecution.Builder builder()