Record Class QuestionRewriter

java.lang.Object
java.lang.Record
dev.langchain4j.adaptiverag.QuestionRewriter
All Implemented Interfaces:
Function<String,String>

public record QuestionRewriter(String openApiKey) extends Record implements Function<String,String>
This class implements a Function to rewrite questions for better vectorstore retrieval. It uses an AI language model to rephrase input questions based on semantic intent and meaning.
  • Constructor Summary

    Constructors
    Constructor
    Description
    Creates an instance of a QuestionRewriter record class.
  • Method Summary

    Modifier and Type
    Method
    Description
    apply(String question)
    Applies a natural language processing pipeline to improve a given question.
    final boolean
    Indicates whether some other object is "equal to" this one.
    final int
    Returns a hash code value for this object.
    Returns the value of the openApiKey record component.
    final String
    Returns a string representation of this record class.

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

    Methods inherited from interface java.util.function.Function

    andThen, compose
  • Constructor Details

    • QuestionRewriter

      public QuestionRewriter(String openApiKey)
      Creates an instance of a QuestionRewriter record class.
      Parameters:
      openApiKey - the value for the openApiKey record component
  • Method Details

    • apply

      public String apply(String question)
      Applies a natural language processing pipeline to improve a given question. This method uses a ChatLanguageModel with specified configuration and an LLMService to generate and invoke a new, improved question based on the provided input.
      Specified by:
      apply in interface Function<String,String>
      Parameters:
      question - The original question to be improved.
      Returns:
      A string representing the improved question.
    • 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.
    • openApiKey

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