Package akka.javasdk.ledger

Record Class ToolCall

Object
Record
akka.javasdk.ledger.ToolCall
Record Components:
id - the id of the tool call, correlating the request with its response
name - the name of the tool that was called
arguments - the arguments passed to the tool, as a JSON string
response - the result recorded for the call, as a string. Empty when the tool returned an empty result, and also when the ledger has no result for the call.
public record ToolCall(String id, String name, String arguments, String response) extends Record
A tool call the model requested within a model response, together with its recorded response.

  • Constructor Details

    • ToolCall

      public ToolCall(String id, String name, String arguments, String response)
      Creates an instance of a ToolCall record class.
      Parameters:
      id - the value for the id record component
      name - the value for the name record component
      arguments - the value for the arguments record component
      response - the value for the response 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.

    • id

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

    • name

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

    • arguments

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

    • response

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