Record Class AssistantMessage.ToolCall

java.lang.Object
java.lang.Record
org.springframework.ai.chat.messages.AssistantMessage.ToolCall
Enclosing class:
AssistantMessage
public static record AssistantMessage.ToolCall(String id, String type, String name, String arguments) extends Record
Since:
1.0.0
Author:
Mark Pollack, Christian Tzolov, Thomas Vitale

  • Constructor Summary

    Constructors
    Constructor
    Description
    ToolCall(String id, String type, String name, String arguments)
    Creates an instance of a ToolCall record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    arguments()
    Returns the value of the arguments record component.
    final boolean
    equals(Object o)
    Indicates whether some other object is "equal to" this one.
    final int
    hashCode()
    Returns a hash code value for this object.
    String
    id()
    Returns the value of the id record component.
    String
    name()
    Returns the value of the name record component.
    final String
    toString()
    Returns a string representation of this record class.
    String
    type()
    Returns the value of the type record component.

    Methods inherited from class Object

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

  • Constructor Details

    • ToolCall

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

    • type

      public String type()
      Returns the value of the type record component.
      Returns:
      the value of the type 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