Record Class TreeNavigator.Request

java.lang.Object
java.lang.Record
com.tnsai.intelligence.rag.TreeNavigator.Request
Record Components:
query - the retrieval query being answered
model - exact provider model identifier
current - node the traversal is standing on
candidates - children of current, in index order
remainingVisits - how many further nodes the traversal may open
cancellationToken - cooperative cancellation signal
Enclosing interface:
TreeNavigator

public static record TreeNavigator.Request(String query, String model, TreeNavigator.Node current, List<TreeNavigator.Node> candidates, int remainingVisits, com.tnsai.cancellation.CancellationToken cancellationToken) extends Record
Immutable input passed to a TreeNavigator provider.
  • Constructor Details

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

      public String query()
      Returns the value of the query record component.
      Returns:
      the value of the query record component
    • model

      public String model()
      Returns the value of the model record component.
      Returns:
      the value of the model record component
    • current

      public TreeNavigator.Node current()
      Returns the value of the current record component.
      Returns:
      the value of the current record component
    • candidates

      public List<TreeNavigator.Node> candidates()
      Returns the value of the candidates record component.
      Returns:
      the value of the candidates record component
    • remainingVisits

      public int remainingVisits()
      Returns the value of the remainingVisits record component.
      Returns:
      the value of the remainingVisits record component
    • cancellationToken

      public com.tnsai.cancellation.CancellationToken cancellationToken()
      Returns the value of the cancellationToken record component.
      Returns:
      the value of the cancellationToken record component