Package org.springframework.ai.tool.augment

Record Class AugmentedArgumentEvent<T>

java.lang.Object
java.lang.Record
org.springframework.ai.tool.augment.AugmentedArgumentEvent<T>
Type Parameters:
T - The type of the augmented arguments record.
Record Components:
toolDefinition - The tool definition associated with the event.
rawInput - The raw input data as a string.
arguments - The augmented arguments extracted from the input.
public record AugmentedArgumentEvent<T>(ToolDefinition toolDefinition, String rawInput, T arguments) extends Record
An event that encapsulates the augmented arguments extracted from a tool input, along with the associated tool definition and raw input data.
Author:
Christian Tzolov

  • Constructor Details

    • AugmentedArgumentEvent

      public AugmentedArgumentEvent(ToolDefinition toolDefinition, String rawInput, T arguments)
      Creates an instance of a AugmentedArgumentEvent record class.
      Parameters:
      toolDefinition - the value for the toolDefinition record component
      rawInput - the value for the rawInput 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.

    • toolDefinition

      public ToolDefinition toolDefinition()
      Returns the value of the toolDefinition record component.
      Returns:
      the value of the toolDefinition record component

    • rawInput

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

    • arguments

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