Class ToolExecutionResult.Builder

java.lang.Object

dev.langchain4j.service.tool.ToolExecutionResult.Builder

Enclosing class:

ToolExecutionResult

public static class ToolExecutionResult.Builder
extends Object

Since:

1.6.0

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
ToolExecutionResult.Builder	attributes(Map<String,Object> attributes)	Sets attributes associated with the tool execution.
ToolExecutionResult	build()	Builds a ToolExecutionResult.
ToolExecutionResult.Builder	isError(boolean isError)	Sets whether the tool execution resulted in an error.
ToolExecutionResult.Builder	result(Object result)	Sets the raw object returned by the tool method.
ToolExecutionResult.Builder	resultContents(List<Content> resultContents)	Sets the contents of the tool execution result.
ToolExecutionResult.Builder	resultText(String resultText)	Sets the result as a text string.
ToolExecutionResult.Builder	resultTextSupplier(Supplier<String> resultTextSupplier)	Sets a supplier for lazy calculation of the result text.

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

Builder

public Builder()

Method Details

isError

public ToolExecutionResult.Builder isError(boolean isError)

Sets whether the tool execution resulted in an error.

Parameters:

isError - true if the tool execution failed.

Returns:

this builder.

result

public ToolExecutionResult.Builder result(Object result)

Sets the raw object returned by the tool method. This value is not sent to the LLM.

Parameters:

result - the raw result object.

Returns:

this builder.

resultText

public ToolExecutionResult.Builder resultText(String resultText)

Sets the result as a text string. The text will be wrapped into a single TextContent. Mutually exclusive with resultTextSupplier(Supplier) and resultContents(List).

Parameters:

resultText - the text result.

Returns:

this builder.

resultTextSupplier

public ToolExecutionResult.Builder resultTextSupplier(Supplier<String> resultTextSupplier)

Sets a supplier for lazy calculation of the result text. The supplier will be called on first access to ToolExecutionResult.resultContents() and the result will be wrapped into a single TextContent and cached. Mutually exclusive with resultText(String) and resultContents(List).

Parameters:

resultTextSupplier - the supplier to calculate result text on demand.

Returns:

this builder.

Since:

1.9.0

resultContents

@Experimental
public ToolExecutionResult.Builder resultContents(List<Content> resultContents)

Sets the contents of the tool execution result. Can contain any combination of Content elements (e.g. TextContent, ImageContent). Mutually exclusive with resultText(String) and resultTextSupplier(Supplier).

Parameters:

resultContents - the contents.

Returns:

this builder.

Since:

1.13.0

attributes

public ToolExecutionResult.Builder attributes(Map<String,Object> attributes)

Sets attributes associated with the tool execution. Attributes are propagated into ToolExecutionResultMessage.attributes() and can be persisted in a ChatMemory. They are not sent to the LLM.

Parameters:

attributes - the attributes.

Returns:

this builder.

Since:

1.12.0

build

public ToolExecutionResult build()

Builds a ToolExecutionResult.

Returns:

the built instance.

Throws:

IllegalArgumentException - if none of resultText, resultTextSupplier, or resultContents was set, or if more than one was set.