Package dev.langchain4j.adaptiverag

Record Class AnswerGrader

java.lang.Object
java.lang.Record
dev.langchain4j.adaptiverag.AnswerGrader
All Implemented Interfaces:
Function<AnswerGrader.Arguments,AnswerGrader.Score>
public record AnswerGrader(String openApiKey) extends Record implements Function<AnswerGrader.Arguments,AnswerGrader.Score>
Class to grade answers based on whether they address a given question. Implements the Function interface to take in Arguments and output a Score.

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static final record 
    AnswerGrader.Arguments
    Represents the arguments for a structured prompt, encapsulating both a user's question and an LLM-generated response.
    static class 
    AnswerGrader.Score
    Binary score to assess answer addresses question.

  • Constructor Summary

    Constructors
    Constructor
    Description
    AnswerGrader(String openApiKey)
    Creates an instance of a AnswerGrader record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    AnswerGrader.Score
    apply(AnswerGrader.Arguments args)
    Applies the given arguments to generate a score using a language model.
    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.
    String
    openApiKey()
    Returns the value of the openApiKey record component.
    final String
    toString()
    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

    • AnswerGrader

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

  • Method Details

    • apply

      public AnswerGrader.Score apply(AnswerGrader.Arguments args)
      Applies the given arguments to generate a score using a language model.
      Specified by:
      apply in interface Function<AnswerGrader.Arguments,AnswerGrader.Score>
      Parameters:
      args - The input arguments for the prompt.
      Returns:
      The generated score based on the prompt and model configuration.

    • 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