Package org.springframework.ai.openai.api

Record Class OpenAiApi.ChatCompletionChunk

java.lang.Object

java.lang.Record

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

Record Components:

id - A unique identifier for the chat completion. Each chunk has the same ID.

choices - A list of chat completion choices. Can be more than one if n is greater than 1.

created - The Unix timestamp (in seconds) of when the chat completion was created. Each chunk has the same timestamp.

model - The model used for the chat completion.

systemFingerprint - This fingerprint represents the backend configuration that the model runs with. Can be used in conjunction with the seed request parameter to understand when backend changes have been made that might impact determinism.

object - The object type, which is always 'chat.completion.chunk'.

Enclosing class:

OpenAiApi

public static record OpenAiApi.ChatCompletionChunk(String id, List<OpenAiApi.ChatCompletionChunk.ChunkChoice> choices, Long created, String model, String systemFingerprint, String object)
extends Record

Represents a streamed chunk of a chat completion response returned by model, based on the provided input.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final record	OpenAiApi.ChatCompletionChunk.ChunkChoice	Chat completion choice.

Constructor Summary

Constructors

Constructor	Description
ChatCompletionChunk(String id, List<OpenAiApi.ChatCompletionChunk.ChunkChoice> choices, Long created, String model, String systemFingerprint, String object)	Creates an instance of a ChatCompletionChunk record class.

Method Summary

Modifier and Type	Method	Description
List<OpenAiApi.ChatCompletionChunk.ChunkChoice>	choices()	Returns the value of the choices record component.
Long	created()	Returns the value of the created record component.
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
final int	hashCode()	Returns a hash code value for this object.
String	id()	Returns the value of the id record component.
String	model()	Returns the value of the model record component.
String	object()	Returns the value of the object record component.
String	systemFingerprint()	Returns the value of the systemFingerprint 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

ChatCompletionChunk

public ChatCompletionChunk(String id,
 List<OpenAiApi.ChatCompletionChunk.ChunkChoice> choices,
 Long created,
 String model,
 String systemFingerprint,
 String object)

Creates an instance of a ChatCompletionChunk record class.

Parameters:

id - the value for the id record component

choices - the value for the choices record component

created - the value for the created record component

model - the value for the model record component

systemFingerprint - the value for the systemFingerprint record component

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

id

public String id()

Returns the value of the id record component.

Returns:

the value of the id record component

choices

public List<OpenAiApi.ChatCompletionChunk.ChunkChoice> choices()

Returns the value of the choices record component.

Returns:

the value of the choices 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

systemFingerprint

public String systemFingerprint()

Returns the value of the systemFingerprint record component.

Returns:

the value of the systemFingerprint record component

object

public String object()

Returns the value of the object record component.

Returns:

the value of the object record component