Package com.axelor.ai.chat

Record Class UIPart.Tool

java.lang.Object
java.lang.Record
com.axelor.ai.chat.UIPart.Tool
All Implemented Interfaces:
UIPart
Enclosing interface:
UIPart
public static record UIPart.Tool(String toolCallId, String toolName, String state, Object input, Object output, String errorText, Map<String,Object> callProviderMetadata, UIPart.Tool.ToolApproval approval, Map<String,Object> toolMetadata, String title) extends Record implements UIPart

  • Constructor Details

    • Tool

      public Tool(String toolCallId, String toolName, String type, String state, Object input, Object output, String errorText, Map<String,Object> callProviderMetadata, UIPart.Tool.ToolApproval approval, Map<String,Object> toolMetadata, String title)
      The AI SDK encodes the tool name in the type field (e.g. "tool-askToInput") and does not send a separate toolName property. This creator extracts the tool name from type when toolName is absent.

    • Tool

      public Tool(String toolCallId, String toolName, String state, Object input, Object output, String errorText, Map<String,Object> callProviderMetadata, UIPart.Tool.ToolApproval approval, Map<String,Object> toolMetadata, String title)
      Creates an instance of a Tool record class.
      Parameters:
      toolCallId - the value for the toolCallId record component
      toolName - the value for the toolName record component
      state - the value for the state record component
      input - the value for the input record component
      output - the value for the output record component
      errorText - the value for the errorText record component
      callProviderMetadata - the value for the callProviderMetadata record component
      approval - the value for the approval record component
      toolMetadata - the value for the toolMetadata record component
      title - the value for the title record component

  • Method Details

    • isPendingState

      public static boolean isPendingState(String state)
      True when state hasn't reached a terminal outcome yet.

    • 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.

    • toolCallId

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

    • toolName

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

    • state

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

    • input

      public Object input()
      Returns the value of the input record component.
      Returns:
      the value of the input record component

    • output

      public Object output()
      Returns the value of the output record component.
      Returns:
      the value of the output record component

    • errorText

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

    • callProviderMetadata

      public Map<String,Object> callProviderMetadata()
      Returns the value of the callProviderMetadata record component.
      Returns:
      the value of the callProviderMetadata record component

    • approval

      public UIPart.Tool.ToolApproval approval()
      Returns the value of the approval record component.
      Returns:
      the value of the approval record component

    • toolMetadata

      public Map<String,Object> toolMetadata()
      Returns the value of the toolMetadata record component.
      Returns:
      the value of the toolMetadata record component

    • title

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