Record Class ToolService.CombinedToolResults

java.lang.Object

java.lang.Record

dev.langchain4j.service.tool.ToolService.CombinedToolResults

Record Components:

results - every tool's result in request order; a tool that threw is represented by an error result carrying its error text, so downstream bookkeeping and compensation see a complete, ordered map

firstError - the first tool failure in request order, or null if every tool succeeded

Enclosing class:

ToolService

public static record ToolService.CombinedToolResults(Map<ToolExecutionRequest, ToolExecutionResult> results, Throwable firstError)
extends Record

The results of a round of tool executions, keeping successful and failed tools together so the caller can compensate the tools that did succeed before failing the invocation with the tool error.

Since:

1.20.0

Constructor Summary

Constructors

Constructor	Description
CombinedToolResults(Map<ToolExecutionRequest, ToolExecutionResult> results, Throwable firstError)	Creates an instance of a CombinedToolResults record class.

Method Summary

Modifier and Type	Method	Description
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
Throwable	firstError()	Returns the value of the firstError record component.
final int	hashCode()	Returns a hash code value for this object.
Map<ToolExecutionRequest, ToolExecutionResult>	results()	Returns the value of the results record component.
final String	toString()	Returns a string representation of this record class.

Methods inherited from class Object

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

Constructor Details

CombinedToolResults

public CombinedToolResults(Map<ToolExecutionRequest, ToolExecutionResult> results,
 Throwable firstError)

Creates an instance of a CombinedToolResults record class.

Parameters:

results - the value for the results record component

firstError - the value for the firstError record component

Method Details

toString

public final String toString()

Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.

Specified by:

toString in class Record

Returns:

a string representation of this object

hashCode

public final int hashCode()

Returns a hash code value for this object. The value is derived from the hash code of each of the record components.

Specified by:

hashCode in class Record

Returns:

a hash code value for this object

equals

public final boolean equals(Object o)

Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. All components in this record class are compared with Objects::equals(Object,Object).

Specified by:

equals in class Record

Parameters:

o - the object with which to compare

Returns:

true if this object is the same as the o argument; false otherwise.

results

public Map<ToolExecutionRequest, ToolExecutionResult> results()

Returns the value of the results record component.

Returns:

the value of the results record component

firstError

public Throwable firstError()

Returns the value of the firstError record component.

Returns:

the value of the firstError record component