ChatGPT-Java-API/com.cjcrafter.openai.completions/CompletionResponse

CompletionResponse

data class CompletionResponse(val id: String, val created: Long, val model: String, val choices: List<CompletionChoice>, val usage: CompletionUsage)

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

Constructors

CompletionResponse

constructor(id: String, created: Long, model: String, choices: List<CompletionChoice>, usage: CompletionUsage)

Create Completion response (for internal usage)

Functions

get

operator fun get(index: Int): CompletionChoice

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

getTime

fun getTime(): Instant

Returns the Instant time that the OpenAI Completion 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 Completion API sent this response. By default, this method uses the system's timezone.