Package com.tnsai.refinement

Record Class RefinementResult

java.lang.Object
java.lang.Record
com.tnsai.refinement.RefinementResult
public record RefinementResult(String finalOutput, int iterationCount, List<com.tnsai.refinement.IterationResult> history, RefinementStatus status, Duration totalDuration, Map<String,Object> metrics) extends Record
Result of a refinement loop execution.

  • Constructor Details

    • RefinementResult

      public RefinementResult(String finalOutput, int iterationCount, List<com.tnsai.refinement.IterationResult> history, RefinementStatus status, Duration totalDuration, Map<String,Object> metrics)
      Creates an instance of a RefinementResult record class.
      Parameters:
      finalOutput - the value for the finalOutput record component
      iterationCount - the value for the iterationCount record component
      history - the value for the history record component
      status - the value for the status record component
      totalDuration - the value for the totalDuration record component
      metrics - the value for the metrics record component

  • Method Details

    • isSuccess

      public boolean isSuccess()

    • getLastIteration

      public com.tnsai.refinement.IterationResult getLastIteration()

    • getFinalScore

      public double getFinalScore()

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

    • finalOutput

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

    • iterationCount

      public int iterationCount()
      Returns the value of the iterationCount record component.
      Returns:
      the value of the iterationCount record component

    • history

      public List<com.tnsai.refinement.IterationResult> history()
      Returns the value of the history record component.
      Returns:
      the value of the history record component

    • status

      public RefinementStatus status()
      Returns the value of the status record component.
      Returns:
      the value of the status record component

    • totalDuration

      public Duration totalDuration()
      Returns the value of the totalDuration record component.
      Returns:
      the value of the totalDuration record component

    • metrics

      public Map<String,Object> metrics()
      Returns the value of the metrics record component.
      Returns:
      the value of the metrics record component