ChatGPT-Java-API/com.cjcrafter.openai.chat/ChatResponse

ChatResponse

data class ChatResponse(val id: String, val created: Long, val choices: List<ChatChoice>, val usage: ChatUsage)

The ChatResponse contains all the data returned by the OpenAI Chat API. For most use cases, ChatResponse.get (passing 0 to the index argument) is all you need.

Constructors

ChatResponse

constructor(id: String, created: Long, choices: List<ChatChoice>, usage: ChatUsage)

Create Chat response (for internal usage).

Functions

get

operator fun get(index: Int): ChatChoice

Shorthand for accessing the generated messages (shorthand for ChatResponse.choices).

getTime

fun getTime(): Instant

Returns the Instant time that the OpenAI Chat API sent this response. The time is measured as a unix timestamp (measured in seconds since 00:00:00 UTC on January 1, 1970).

getZonedTime

@JvmOverloads

fun getZonedTime(timezone: ZoneId = TimeZone.getDefault().toZoneId()): ZonedDateTime

Returns the time-zoned instant that the OpenAI Chat API sent this response. By default, this method uses the system's timezone.

Properties

choices

val choices: List<ChatChoice>

The list of generated messages.

created

val created: Long

The Unix timestamp (measured in seconds since 00:00:00 UTC on January 1, 1970) when the API response was created.

val id: String

The unique id for your request.

usage

val usage: ChatUsage

The number of tokens used in this request/response.