Package-level declarations

Types

Link copied to clipboard
@Serializable
class DeleteResponse(val id: String, val objectType: String, val deleted: Boolean)

Delete operation response.

Link copied to clipboard
@Serializable
value class Endpoint(val path: String)
Link copied to clipboard
@Serializable
value class FinishReason(val value: String)
Link copied to clipboard
@Serializable
data class LastError(val code: String, val message: String)

The last error information.

Link copied to clipboard
@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.

Link copied to clipboard
@Serializable
value class OrganizationId(val id: String)

Organization identifier.

Link copied to clipboard
@Serializable
data class PaginatedList<T>(val data: List<T>, val hasMore: Boolean? = null, val firstId: String? = null, val lastId: String? = null) : List<T>
Link copied to clipboard
data class Parameters(val schema: JsonElement)

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

Link copied to clipboard
@Serializable
value class RequestId(val id: String)

An unique identifier for the OpenAI API request.

Link copied to clipboard
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.

Link copied to clipboard
@Serializable
value class Role(val role: String)

The role of the author of a message.

Link copied to clipboard
@Serializable
value class SortOrder(val order: String)
Link copied to clipboard
@Serializable
value class Status(val value: String)

Operation status.

Link copied to clipboard
@Serializable
data class Usage(val promptTokens: Int? = null, val completionTokens: Int? = null, val totalTokens: Int? = null)