Class ToolExecutionResultMessage.Builder

java.lang.Object

dev.langchain4j.data.message.ToolExecutionResultMessage.Builder

Enclosing class:

ToolExecutionResultMessage

public static class ToolExecutionResultMessage.Builder
extends Object

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
ToolExecutionResultMessage.Builder	attributes(Map<String,Object> attributes)
ToolExecutionResultMessage	build()	Builds the ToolExecutionResultMessage.
ToolExecutionResultMessage.Builder	contents(Content... contents)	Sets the contents of the tool execution result.
ToolExecutionResultMessage.Builder	contents(List<Content> contents)	Sets the contents of the tool execution result.
ToolExecutionResultMessage.Builder	id(String id)	Sets the id of the tool.
ToolExecutionResultMessage.Builder	isError(Boolean isError)	Sets whether the tool execution resulted in an error.
ToolExecutionResultMessage.Builder	text(String text)	Sets the result text of the tool execution.
ToolExecutionResultMessage.Builder	toolName(String toolName)	Sets the name of the tool.

Methods inherited from class Object

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

Constructor Details

Builder

public Builder()

Method Details

id

public ToolExecutionResultMessage.Builder id(String id)

Sets the id of the tool.

Parameters:

id - the id of the tool.

Returns:

the builder.

toolName

public ToolExecutionResultMessage.Builder toolName(String toolName)

Sets the name of the tool.

Parameters:

toolName - the name of the tool.

Returns:

the builder.

text

public ToolExecutionResultMessage.Builder text(String text)

Sets the result text of the tool execution. The text will be wrapped into a single TextContent. Mutually exclusive with contents(List).

Parameters:

text - the result of the tool execution.

Returns:

the builder.

contents

@Experimental
public ToolExecutionResultMessage.Builder contents(List<Content> contents)

Sets the contents of the tool execution result. Mutually exclusive with text(String).

Parameters:

contents - the contents.

Returns:

the builder.

Since:

1.13.0

contents

@Experimental
public ToolExecutionResultMessage.Builder contents(Content... contents)

Sets the contents of the tool execution result. Mutually exclusive with text(String).

Parameters:

contents - the contents.

Returns:

the builder.

Since:

1.13.0

isError

public ToolExecutionResultMessage.Builder isError(Boolean isError)

Sets whether the tool execution resulted in an error.

Parameters:

isError - whether the tool execution resulted in an error.

Returns:

the builder.

attributes

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

build

public ToolExecutionResultMessage build()

Builds the ToolExecutionResultMessage.

Returns:

the ToolExecutionResultMessage.