Record Class OpenAiApi.ChatCompletionChunk.ChunkChoice

java.lang.Object

java.lang.Record

org.springframework.ai.openai.api.OpenAiApi.ChatCompletionChunk.ChunkChoice

Record Components:

finishReason - The reason the model stopped generating tokens.

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

delta - A chat completion delta generated by streamed model responses.

logprobs - Log probability information for the choice.

Enclosing class:

OpenAiApi.ChatCompletionChunk

public static record OpenAiApi.ChatCompletionChunk.ChunkChoice(OpenAiApi.ChatCompletionFinishReason finishReason, Integer index, OpenAiApi.ChatCompletionMessage delta, 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
ChunkChoice(OpenAiApi.ChatCompletionFinishReason finishReason, Integer index, OpenAiApi.ChatCompletionMessage delta, OpenAiApi.LogProbs logprobs)	Creates an instance of a ChunkChoice record class.

Method Summary

Modifier and Type	Method	Description
OpenAiApi.ChatCompletionMessage	delta()	Returns the value of the delta record component.
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.
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

ChunkChoice

public ChunkChoice(OpenAiApi.ChatCompletionFinishReason finishReason,
 Integer index,
 OpenAiApi.ChatCompletionMessage delta,
 OpenAiApi.LogProbs logprobs)

Creates an instance of a ChunkChoice record class.

Parameters:

finishReason - the value for the finishReason record component

index - the value for the index record component

delta - the value for the delta 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

delta

public OpenAiApi.ChatCompletionMessage delta()

Returns the value of the delta record component.

Returns:

the value of the delta record component

logprobs

public OpenAiApi.LogProbs logprobs()

Returns the value of the logprobs record component.

Returns:

the value of the logprobs record component