Record Class EvaluationResult

java.lang.Object
java.lang.Record
io.micronaut.langchain4j.evaluation.EvaluationResult
Record Components:
passing - Whether the evaluation passed
feedback - Short feedback from the evaluator
@Introspected public record EvaluationResult(boolean passing, @NonNull String feedback) extends Record
Represents the result of an evaluation.
Since:
2.1.1

  • Constructor Summary

    Constructors
    Constructor
    Description
    EvaluationResult(boolean passing, @NonNull String feedback)
    Creates an instance of a EvaluationResult record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    final boolean
    equals(Object o)
    Indicates whether some other object is "equal to" this one.
    static @NonNull EvaluationResult
    fail(@NonNull String feedback)
    Creates a failing result with the given feedback.
    @NonNull String
    feedback()
    Returns the value of the feedback record component.
    final int
    hashCode()
    Returns a hash code value for this object.
    static @NonNull EvaluationResult
    pass(@NonNull String feedback)
    Creates a passing result with the given feedback.
    boolean
    passing()
    Returns the value of the passing record component.
    final String
    toString()
    Returns a string representation of this record class.

    Methods inherited from class Object

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

  • Constructor Details

    • EvaluationResult

      public EvaluationResult(boolean passing, @NonNull String feedback)
      Creates an instance of a EvaluationResult record class.
      Parameters:
      passing - the value for the passing record component
      feedback - the value for the feedback record component

  • Method Details

    • pass

      public static @NonNull EvaluationResult pass(@NonNull String feedback)
      Creates a passing result with the given feedback.
      Parameters:
      feedback - The feedback
      Returns:
      The result
      Since:
      2.1.1

    • fail

      public static @NonNull EvaluationResult fail(@NonNull String feedback)
      Creates a failing result with the given feedback.
      Parameters:
      feedback - The feedback
      Returns:
      The result
      Since:
      2.1.1

    • 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 the compare method from their corresponding wrapper classes.
      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.

    • passing

      public boolean passing()
      Returns the value of the passing record component.
      Returns:
      the value of the passing record component

    • feedback

      public @NonNull String feedback()
      Returns the value of the feedback record component.
      Returns:
      the value of the feedback record component