Package ai.optfor.springopenaiapi.model

Record Class ChatChoice

java.lang.Object
java.lang.Record
ai.optfor.springopenaiapi.model.ChatChoice
public record ChatChoice(int index, ChatMessage message, String finishReason) extends Record

  • Constructor Summary

    Constructors
    Constructor
    Description
    ChatChoice(int index, ChatMessage message, String finishReason)
    Creates an instance of a ChatChoice record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    final boolean
    equals(Object o)
    Indicates whether some other object is "equal to" this one.
    String
    finishReason()
    Returns the value of the finishReason record component.
    final int
    hashCode()
    Returns a hash code value for this object.
    int
    index()
    Returns the value of the index record component.
    ChatMessage
    message()
    Returns the value of the message 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

  • Constructor Details

    • ChatChoice

      public ChatChoice(int index, ChatMessage message, String finishReason)
      Creates an instance of a ChatChoice record class.
      Parameters:
      index - the value for the index record component
      message - the value for the message record component
      finishReason - the value for the finishReason 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.

    • index

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

    • message

      public ChatMessage message()
      Returns the value of the message record component.
      Returns:
      the value of the message record component

    • finishReason

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