All Implemented Interfaces:
```
public final class ChatCompletionChunk

                    
```
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
`public final class`	`ChatCompletionChunk.Builder`	A builder for ChatCompletionChunk.
`public final class`	`ChatCompletionChunk.Choice`
`public final class`	`ChatCompletionChunk.ServiceTier`	The service tier used for processing the request.

Field Summary

Fields
Modifier and Type	Field	Description

Constructor Summary

Constructors
Constructor	Description

Enum Constant Summary

Enum Constants
Enum Constant	Description

Method Summary

Modifier and Type	Method	Description
`final String`	`id()`	A unique identifier for the chat completion.
`final List<ChatCompletionChunk.Choice>`	`choices()`	A list of chat completion choices.
`final Long`	`created()`	The Unix timestamp (in seconds) of when the chat completion was created.
`final String`	`model()`	The model to generate the completion.
`final JsonValue`	`_object_()`	The object type, which is always `chat.completion.chunk`.
`final Optional<ChatCompletionChunk.ServiceTier>`	`serviceTier()`	The service tier used for processing the request.
`final Optional<String>`	`systemFingerprint()`	This fingerprint represents the backend configuration that the model runs with.
`final Optional<CompletionUsage>`	`usage()`	An optional field that will only be present when you set `stream_options: {"include_usage": true}` in your request.
`final JsonField<String>`	`_id()`	A unique identifier for the chat completion.
`final JsonField<List<ChatCompletionChunk.Choice>>`	`_choices()`	A list of chat completion choices.
`final JsonField<Long>`	`_created()`	The Unix timestamp (in seconds) of when the chat completion was created.
`final JsonField<String>`	`_model()`	The model to generate the completion.
`final JsonField<ChatCompletionChunk.ServiceTier>`	`_serviceTier()`	The service tier used for processing the request.
`final JsonField<String>`	`_systemFingerprint()`	This fingerprint represents the backend configuration that the model runs with.
`final JsonField<CompletionUsage>`	`_usage()`	An optional field that will only be present when you set `stream_options: {"include_usage": true}` in your request.
`final Map<String, JsonValue>`	`_additionalProperties()`
`final ChatCompletionChunk`	`validate()`
`final ChatCompletionChunk.Builder`	`toBuilder()`
`Boolean`	`equals(Object other)`
`Integer`	`hashCode()`
`String`	`toString()`
`final static ChatCompletionChunk.Builder`	`builder()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
- Method Detail
  - id
```
 final String id()
```
    A unique identifier for the chat completion. Each chunk has the same ID.
  - choices
```
 final List<ChatCompletionChunk.Choice> choices()
```
    A list of chat completion choices. Can contain more than one elements if n is greater than 1. Can also be empty for the last chunk if you set stream_options: {"include_usage": true}.
  - created
```
 final Long created()
```
    The Unix timestamp (in seconds) of when the chat completion was created. Each chunk has the same timestamp.
  - model
```
 final String model()
```
    The model to generate the completion.
  - _object_
```
 final JsonValue _object_()
```
    The object type, which is always chat.completion.chunk.
  - serviceTier
```
 final Optional<ChatCompletionChunk.ServiceTier> serviceTier()
```
    The service tier used for processing the request.
  - systemFingerprint
```
 final Optional<String> 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.
  - usage
```
 final Optional<CompletionUsage> usage()
```
    An optional field that will only be present when you set stream_options: {"include_usage": true} in your request. When present, it contains a null value except for the last chunk which contains the token usage statistics for the entire request.
  - _id
```
 final JsonField<String> _id()
```
    A unique identifier for the chat completion. Each chunk has the same ID.
  - _choices
```
 final JsonField<List<ChatCompletionChunk.Choice>> _choices()
```
    A list of chat completion choices. Can contain more than one elements if n is greater than 1. Can also be empty for the last chunk if you set stream_options: {"include_usage": true}.
  - _created
```
 final JsonField<Long> _created()
```
    The Unix timestamp (in seconds) of when the chat completion was created. Each chunk has the same timestamp.
  - _model
```
 final JsonField<String> _model()
```
    The model to generate the completion.
  - _serviceTier
```
 final JsonField<ChatCompletionChunk.ServiceTier> _serviceTier()
```
    The service tier used for processing the request.
  - _systemFingerprint
```
 final JsonField<String> _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.
  - _usage
```
 final JsonField<CompletionUsage> _usage()
```
    An optional field that will only be present when you set stream_options: {"include_usage": true} in your request. When present, it contains a null value except for the last chunk which contains the token usage statistics for the entire request.
  - _additionalProperties
```
 final Map<String, JsonValue> _additionalProperties()
```
  - validate
```
 final ChatCompletionChunk validate()
```
  - toBuilder
```
 final ChatCompletionChunk.Builder toBuilder()
```
  - equals
```
 Boolean equals(Object other)
```
  - hashCode
```
 Integer hashCode()
```
  - toString
```
 String toString()
```
  - builder
```
 final static ChatCompletionChunk.Builder builder()
```

Class ChatCompletionChunk

Nested Class Summary

Field Summary

Constructor Summary

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Method Detail

id

choices

created

model

_object_

serviceTier

systemFingerprint

usage

_id

_choices

_created

_model

_serviceTier

_systemFingerprint

_usage

_additionalProperties

validate

toBuilder

equals

hashCode

toString

builder