Package com.tnsai.intelligence.rag

Record Class QueryExpander.Request

java.lang.Object
java.lang.Record
com.tnsai.intelligence.rag.QueryExpander.Request
Record Components:
query - original retrieval query
mode - expansion technique to apply
model - exact provider model identifier
maxExpansions - maximum number of generated variations accepted
cancellationToken - cooperative cancellation signal
Enclosing interface:
QueryExpander
public static record QueryExpander.Request(String query, com.tnsai.annotations.Search.QueryExpansion mode, String model, int maxExpansions, com.tnsai.cancellation.CancellationToken cancellationToken) extends Record
Immutable input passed to a QueryExpander provider.

  • Constructor Summary

    Constructors
    Constructor
    Description
    Request(String query, com.tnsai.annotations.Search.QueryExpansion mode, String model, int maxExpansions, com.tnsai.cancellation.CancellationToken cancellationToken)
    Creates a validated immutable request.

  • Method Summary

    Modifier and Type
    Method
    Description
    com.tnsai.cancellation.CancellationToken
    cancellationToken()
    Returns the value of the cancellationToken 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.
    int
    maxExpansions()
    Returns the value of the maxExpansions record component.
    com.tnsai.annotations.Search.QueryExpansion
    mode()
    Returns the value of the mode record component.
    String
    model()
    Returns the value of the model record component.
    String
    query()
    Returns the value of the query record component.
    final String
    toString()
    Returns a string representation of this record class.

    Methods inherited from class java.lang.Object

    getClass, notify, notifyAll, wait, wait, wait

  • Constructor Details

    • Request

      public Request(String query, com.tnsai.annotations.Search.QueryExpansion mode, String model, int maxExpansions, com.tnsai.cancellation.CancellationToken cancellationToken)
      Creates a validated immutable request.

  • 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

    • mode

      public com.tnsai.annotations.Search.QueryExpansion mode()
      Returns the value of the mode record component.
      Returns:
      the value of the mode record component

    • model

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

    • maxExpansions

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