Package org.springframework.ai.tool.metadata

Record Class DefaultToolMetadata

java.lang.Object
java.lang.Record
org.springframework.ai.tool.metadata.DefaultToolMetadata
Record Components:
returnDirect - whether the tool result should be returned directly or passed back to the model
requiresConfirmation - whether a call of the tool needs a person's confirmation before it runs (since 2.1.0)
All Implemented Interfaces:
ToolMetadata
public record DefaultToolMetadata(boolean returnDirect, boolean requiresConfirmation) extends Record implements ToolMetadata
Default implementation of ToolMetadata.
Since:
1.0.0
Author:
Thomas Vitale

  • Constructor Details

    • DefaultToolMetadata

      public DefaultToolMetadata(boolean returnDirect)
      Create metadata for a tool that needs no confirmation.
      Parameters:
      returnDirect - whether the tool result should be returned directly or passed back to the model

    • DefaultToolMetadata

      public DefaultToolMetadata(boolean returnDirect, boolean requiresConfirmation)
      Creates an instance of a DefaultToolMetadata record class.
      Parameters:
      returnDirect - the value for the returnDirect record component
      requiresConfirmation - the value for the requiresConfirmation record component

  • Method Details

    • builder

      public static DefaultToolMetadata.Builder builder()
      Description copied from interface: ToolMetadata
      Create a default ToolMetadata 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 '=='.
      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.

    • returnDirect

      public boolean returnDirect()
      Returns the value of the returnDirect record component.
      Specified by:
      returnDirect in interface ToolMetadata
      Returns:
      the value of the returnDirect record component

    • requiresConfirmation

      public boolean requiresConfirmation()
      Returns the value of the requiresConfirmation record component.
      Specified by:
      requiresConfirmation in interface ToolMetadata
      Returns:
      the value of the requiresConfirmation record component