openai-core/com.aallam.openai.api.core

Package-level declarations

Types

DeleteResponse

@Serializable

class DeleteResponse(val id: String, val objectType: String, val deleted: Boolean)

Delete operation response.

FinishReason

@Serializable

@JvmInline

value class FinishReason(val value: String)

LastError

@Serializable

data class LastError(val code: String, val message: String)

The last error information.

ListResponse

@Serializable

class ListResponse<T>(val data: List<T>, val usage: Usage? = null, val firstId: String? = null, val lastId: String? = null, val hasMore: Boolean? = null) : List<T>

Response as List of T.

OrganizationId

@Serializable

@JvmInline

value class OrganizationId(val id: String)

Organization identifier.

PaginatedList

@Serializable

data class PaginatedList<T>(val data: List<T>, val hasMore: Boolean? = null, val firstId: String? = null, val lastId: String? = null) : List<T>

Parameters

@Serializable(with = Parameters.JsonDataSerializer::class)

data class Parameters(val schema: JsonElement)

Represents parameters that a function accepts, described as a JSON Schema object.

RequestOptions

data class RequestOptions(val headers: Map<String, String> = emptyMap(), val urlParameters: Map<String, String> = emptyMap(), val timeout: Timeout? = null)

Represents options for configuring a request to an endpoint.

Role

@JvmInline

@Serializable

value class Role(val role: String)

The role of the author of a message.

SortOrder

@Serializable

@JvmInline

value class SortOrder(val order: String)

Status

@Serializable

@JvmInline

value class Status(val value: String)

Operation status.

Usage

@Serializable

data class Usage(val promptTokens: Int? = null, val completionTokens: Int? = null, val totalTokens: Int? = null)