Package ai.vespa.llm.completion

Record Class Completion

java.lang.Object
java.lang.Record
ai.vespa.llm.completion.Completion
public record Completion(String text, Completion.FinishReason finishReason) extends Record
A completion from a language model.
Author:
bratseth

  • Constructor Details

    • Completion

      public Completion(String text, Completion.FinishReason finishReason)
      Creates an instance of a Completion record class.
      Parameters:
      text - the value for the text record component
      finishReason - the value for the finishReason record component

  • Method Details

    • text

      public String text()
      Returns the generated text completion.

    • finishReason

      public Completion.FinishReason finishReason()
      Returns the reason this completion ended.

    • from

      public static Completion from(String text)

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