Package io.github.stefanbratanov.jvm.openai

Record Class ChatCompletion

java.lang.Object
java.lang.Record
io.github.stefanbratanov.jvm.openai.ChatCompletion
public record ChatCompletion(String id, long created, String model, String serviceTier, String systemFingerprint, List<ChatCompletion.Choice> choices, Usage usage) extends Record
Represents a chat completion response returned by model, based on the provided input.

  • Constructor Details

    • ChatCompletion

      public ChatCompletion(String id, long created, String model, String serviceTier, String systemFingerprint, List<ChatCompletion.Choice> choices, Usage usage)
      Creates an instance of a ChatCompletion record class.
      Parameters:
      id - the value for the id record component
      created - the value for the created record component
      model - the value for the model record component
      serviceTier - the value for the serviceTier record component
      systemFingerprint - the value for the systemFingerprint record component
      choices - the value for the choices record component
      usage - the value for the usage record component

  • Method Details

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

    • id

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

    • created

      public long created()
      Returns the value of the created record component.
      Returns:
      the value of the created record component

    • model

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

    • serviceTier

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

    • systemFingerprint

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

    • choices

      public List<ChatCompletion.Choice> choices()
      Returns the value of the choices record component.
      Returns:
      the value of the choices record component

    • usage

      public Usage usage()
      Returns the value of the usage record component.
      Returns:
      the value of the usage record component