Package dev.dokimos.core.agents

Record Class ToolCall

java.lang.Object
java.lang.Record
dev.dokimos.core.agents.ToolCall
Record Components:
name - the name of the tool that was called
arguments - the arguments passed to the tool
result - the tool execution result (may be null)
metadata - optional metadata (latency, tokens, etc.)
public record ToolCall(String name, Map<String,Object> arguments, String result, Map<String,Object> metadata) extends Record
Represents a single tool invocation made by an AI agent.

Contains the tool name, arguments passed, optional result, and metadata such as latency or token usage.

  • Constructor Details

    • ToolCall

      public ToolCall(String name, Map<String,Object> arguments, String result, Map<String,Object> metadata)
      Creates an instance of a ToolCall record class.
      Parameters:
      name - the value for the name record component
      arguments - the value for the arguments record component
      result - the value for the result record component
      metadata - the value for the metadata record component

  • Method Details

    • of

      public static ToolCall of(String name, Map<String,Object> arguments)
      Creates a tool call with just a name and arguments.
      Parameters:
      name - the tool name
      arguments - the arguments passed to the tool
      Returns:
      a new tool call

    • fromMap

      public static ToolCall fromMap(Map<String,Object> map)
      Creates a tool call from a map, typically when deserializing from a JSON dataset.

      Expected keys: "name", "arguments", "result", "metadata".

      Parameters:
      map - the map to create from
      Returns:
      a new tool call

    • resultAs

      public <T> T resultAs(Class<T> type)
      Deserializes this tool call's result string into an instance of type.

      This is the read-side counterpart to ToolCall.Builder.resultJson(Object): a structured tool result stored as compact JSON is round-tripped back into a typed object. A null or blank result yields null, and the JSON literal "null" also parses to null.

      The result must be a JSON string for this to work. Both ToolCall.Builder.resultJson(Object) and fromMap(Map) guarantee that: fromMap keeps a String result verbatim and serializes any structured value (a Map, list, or other object) to compact JSON, so a structured result from a deserialized dataset round-trips here as well.

      Type Parameters:
      T - the target type
      Parameters:
      type - the target class
      Returns:
      the deserialized result, or null if the result is null/blank/JSON null
      Throws:
      DokimosTypeConversionException - if the result cannot be parsed into type

    • resultAs

      public <T> T resultAs(OutputType<T> type)
      Deserializes this tool call's result string into a generic target captured by an OutputType token, for example new OutputType<List<Order>>() {}.

      Use this overload when the target type has type arguments that a plain Class<T> cannot express. The same null/blank/JSON-null handling described on resultAs(Class) applies.

      Type Parameters:
      T - the target type
      Parameters:
      type - the captured generic output type
      Returns:
      the deserialized result, or null if the result is null/blank/JSON null
      Throws:
      DokimosTypeConversionException - if the result cannot be parsed into type

    • argumentsAs

      public <T> T argumentsAs(Class<T> type)
      Converts this tool call's arguments map into an instance of type.

      The arguments are already an in-memory map, so this converts in place (no textual round-trip). arguments() is never null (it defaults to an empty map); converting an empty map to a record or bean yields an instance with default/empty fields.

      Type Parameters:
      T - the target type
      Parameters:
      type - the target class
      Returns:
      the converted arguments
      Throws:
      DokimosTypeConversionException - if the arguments cannot be converted to type

    • argumentsAs

      public <T> T argumentsAs(OutputType<T> type)
      Converts this tool call's arguments map into a generic target captured by an OutputType token, for example new OutputType<List<String>>() {}.

      Use this overload when the target type has type arguments that a plain Class<T> cannot express.

      Type Parameters:
      T - the target type
      Parameters:
      type - the captured generic output type
      Returns:
      the converted arguments
      Throws:
      DokimosTypeConversionException - if the arguments cannot be converted to type

    • metadataAs

      public <T> T metadataAs(String key, Class<T> type)
      Reads the metadata entry stored under key and converts it into an instance of type.

      The value is already in memory, so this converts in place (no textual round-trip). An absent key (or a null stored value) yields null.

      Type Parameters:
      T - the target type
      Parameters:
      key - the metadata key
      type - the target class
      Returns:
      the converted value, or null if the key is absent or its value is null
      Throws:
      DokimosTypeConversionException - if the value cannot be converted to type

    • metadataAs

      public <T> T metadataAs(String key, OutputType<T> type)
      Reads the metadata entry stored under key and converts it into a generic target captured by an OutputType token, for example new OutputType<List<String>>() {}.

      An absent key (or a null stored value) yields null.

      Type Parameters:
      T - the target type
      Parameters:
      key - the metadata key
      type - the captured generic output type
      Returns:
      the converted value, or null if the key is absent or its value is null
      Throws:
      DokimosTypeConversionException - if the value cannot be converted to type

    • builder

      public static ToolCall.Builder builder()
      Creates a new builder for constructing tool calls.
      Returns:
      a new builder

    • 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.

    • name

      public String name()
      Returns the value of the name record component.
      Returns:
      the value of the name record component

    • arguments

      public Map<String,Object> arguments()
      Returns the value of the arguments record component.
      Returns:
      the value of the arguments record component

    • result

      public String result()
      Returns the value of the result record component.
      Returns:
      the value of the result record component

    • metadata

      public Map<String,Object> metadata()
      Returns the value of the metadata record component.
      Returns:
      the value of the metadata record component