Record Class OpenAiApi.ChatCompletion.Choice

java.lang.Object

java.lang.Record

org.springframework.ai.openai.api.OpenAiApi.ChatCompletion.Choice

Record Components:

finishReason - The reason the model stopped generating tokens.

index - The index of the choice in the list of choices.

message - A chat completion message generated by the model.

logprobs - Log probability information for the choice.

Enclosing class:

OpenAiApi.ChatCompletion

public static record OpenAiApi.ChatCompletion.Choice(OpenAiApi.ChatCompletionFinishReason finishReason, Integer index, OpenAiApi.ChatCompletionMessage message, OpenAiApi.LogProbs logprobs)
extends Record

Chat completion choice.

Author:

Christian Tzolov, Michael Lavelle, Mariusz Bernacki, Thomas Vitale, David Frizelle, Alexandros Pappas, Filip Hrisafov

Constructor Summary

Constructors

Constructor	Description
Choice(OpenAiApi.ChatCompletionFinishReason finishReason, Integer index, OpenAiApi.ChatCompletionMessage message, OpenAiApi.LogProbs logprobs)	Creates an instance of a Choice record class.

Method Summary

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

Choice

public Choice(OpenAiApi.ChatCompletionFinishReason finishReason,
 Integer index,
 OpenAiApi.ChatCompletionMessage message,
 OpenAiApi.LogProbs logprobs)

Creates an instance of a Choice record class.

Parameters:

finishReason - the value for the finishReason record component

index - the value for the index record component

message - the value for the message record component

logprobs - the value for the logprobs 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. 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.

finishReason

public OpenAiApi.ChatCompletionFinishReason finishReason()

Returns the value of the finishReason record component.

Returns:

the value of the finishReason record component

index

public Integer index()

Returns the value of the index record component.

Returns:

the value of the index record component

message

public OpenAiApi.ChatCompletionMessage message()

Returns the value of the message record component.

Returns:

the value of the message record component

logprobs

public OpenAiApi.LogProbs logprobs()

Returns the value of the logprobs record component.

Returns:

the value of the logprobs record component