The result of a tool call: text, images and documents, as ContentParts.
ToolMessage(text, toolCallId) is the one-part result. A provider that cannot send one of the parts in a tool result fails the request with an org.llm4s.error.UnsupportedContentPartError.
Not a case class, for the reason UserMessage gives: case ToolMessage(content, id) => does not compile. Match case t: ToolMessage and read t.content or t.parts. Equality is by parts and id.
Value parameters
parts
the result, in order; usually one text part, e.g. a JSON response.
toolCallId
Unique identifier for the tool call (as provided by the ToolCall).
It is reflexive: for any instance x of type Any, x.equals(x) should return true.
It is symmetric: for any instances x and y of type Any, x.equals(y) should return true if and only if y.equals(x) returns true.
It is transitive: for any instances x, y, and z of type Any if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
If you override this method, you should verify that your implementation remains an equivalence relation. Additionally, when overriding this method it is usually necessary to override hashCode to ensure that objects which are "equal" (o1.equals(o2) returns true) hash to the same scala.Int. (o1.hashCode.equals(o2.hashCode)).
Value parameters
that
the object to compare against this object for equality.
Attributes
Returns
true if the receiver object is equivalent to the argument; false otherwise.
Resolves the tool name for this response by scanning contextMessages for the ToolCall whose id matches toolCallId.
Resolves the tool name for this response by scanning contextMessages for the ToolCall whose id matches toolCallId.
Returns "unknown-tool" when no matching tool call is found, which can happen if contextMessages does not include the assistant message that issued the request (e.g. after context pruning).
Value parameters
contextMessages
The conversation history to search; all AssistantMessage entries are scanned.
The default hashing algorithm is platform dependent.
Note that it is allowed for two objects to have identical hash codes (o1.hashCode.equals(o2.hashCode)) yet not be equal (o1.equals(o2) returns false). A degenerate implementation could always return 0. However, it is required that if two objects are equal (o1.equals(o2) returns true) that they have identical hash codes (o1.hashCode.equals(o2.hashCode)). Therefore, when overriding this method, be sure to verify that the behavior is consistent with the equals method.