Package akka.javasdk.agent

Record Class SessionMessage.ToolCallResponse

Object
Record
akka.javasdk.agent.SessionMessage.ToolCallResponse
Record Components:
sanitized - true when the message holds the tool result that the runtime sent to the model, with the configured sanitizers applied. The runtime sends such a message to the model as it is. For a message with false, the runtime masks the text with the current sanitizers before it sends it. Leave it false in a message that you build.
isError - true when the MCP server reported the result as an error, or when the runtime turned a failed tool call into an error result for the model. The runtime passes the flag to the model provider. Not all model providers send the flag to the model.
All Implemented Interfaces:
SessionMessage
Enclosing interface:
SessionMessage
public static record SessionMessage.ToolCallResponse(Instant timestamp, String componentId, String id, String name, String text, boolean sanitized, boolean isError) extends Record implements SessionMessage
The text result of a tool call, fed back to the model as input.

  • Constructor Details

    • ToolCallResponse

      public ToolCallResponse(Instant timestamp, String componentId, String id, String name, String text)

    • ToolCallResponse

      public ToolCallResponse(Instant timestamp, String componentId, String id, String name, String text, boolean sanitized)

    • ToolCallResponse

      public ToolCallResponse(Instant timestamp, String componentId, String id, String name, String text, boolean sanitized, boolean isError)
      Creates an instance of a ToolCallResponse record class.
      Parameters:
      timestamp - the value for the timestamp record component
      componentId - the value for the componentId record component
      id - the value for the id record component
      name - the value for the name record component
      text - the value for the text record component
      sanitized - the value for the sanitized record component
      isError - the value for the isError record component

  • Method Details

    • withText

      public SessionMessage.ToolCallResponse withText(String text)
      A copy of this response with another text. The copy keeps isError and has sanitized false, because it no longer holds the text that the runtime sent to the model.

    • size

      public int size()
      Description copied from interface: SessionMessage
      The approximate size of this message in bytes, used to enforce memory size limits.
      Specified by:
      size in interface SessionMessage

    • 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. Reference components are compared with Objects::equals(Object,Object); primitive components are compared with '=='.
      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.

    • timestamp

      public Instant timestamp()
      Returns the value of the timestamp record component.
      Returns:
      the value of the timestamp record component

    • componentId

      public String componentId()
      Returns the value of the componentId record component.
      Specified by:
      componentId in interface SessionMessage
      Returns:
      the value of the componentId record component

    • 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

    • text

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

    • sanitized

      public boolean sanitized()
      Returns the value of the sanitized record component.
      Returns:
      the value of the sanitized record component

    • isError

      public boolean isError()
      Returns the value of the isError record component.
      Returns:
      the value of the isError record component