Package-level declarations

Types

Link copied to clipboard
@Serializable
data class OpenAIImageGenToolUsage(val inputTokens: Int, val outputTokens: Int, val totalTokens: Int, val cachedTokens: Int? = null)

Token usage of the image generation tool.

Link copied to clipboard
@Serializable
data class OpenAIResponsesDeleteResponse(val id: String, val deleted: Boolean, val obj: String = "response.deleted")
Link copied to clipboard
@Serializable
data class OpenAIResponsesInputTokensDetails(val cachedTokens: Int = 0, val cacheWriteTokens: Int? = null)

Breakdown of input tokens for a Responses API call.

Link copied to clipboard
@Serializable
data class OpenAIResponsesOutputTokensDetails(val reasoningTokens: Int = 0)

Breakdown of output tokens for a Responses API call.

Link copied to clipboard
@Serializable
data class OpenAIResponsesRequestDto(val model: String, val input: OpenAIResponseInput, val instructions: String? = null, val maxOutputTokens: Int? = null, val maxToolCalls: Int? = null, val parallelToolCalls: Boolean? = null, val previousResponseId: String? = null, val metadata: OpenAIMetadata? = null, val background: Boolean = false, val reasoning: OpenAIReasoning? = null, val store: Boolean? = null, val temperature: Double? = null, val topP: Double? = null, val truncation: OpenAITruncation? = null, val text: OpenAIResponsesText? = null, val toolChoice: OpenAIToolChoice? = null, val serviceTier: OpenAIServiceTier? = null, val user: String? = null, val safetyIdentifier: String? = null, val promptCacheKey: String? = null, val tools: List<OpenAIResponsesToolDto> = emptyList())
Link copied to clipboard
@Serializable
data class OpenAIResponsesResponse(val id: String, val obj: String = "response", val createdAt: Long? = null, val completedAt: Long? = null, val status: OpenAIResponseStatus? = null, val error: OpenAIResponseError? = null, val output: List<OpenAIResponseOutputItem>, val incompleteDetails: OpenAIIncompleteDetails? = null, val instructions: String? = null, val model: String? = null, val maxOutputTokens: Int? = null, val maxToolCalls: Int? = null, val parallelToolCalls: Boolean? = null, val previousResponseId: String? = null, val reasoning: OpenAIReasoning? = null, val store: Boolean? = null, val temperature: Double? = null, val topP: Double? = null, val truncation: OpenAITruncation? = null, val text: OpenAIResponsesText? = null, val toolChoice: OpenAIToolChoice? = null, val tools: List<JsonElement> = emptyList(), val usage: OpenAIResponsesUsage? = null, val toolUsage: OpenAIResponsesToolUsage? = null, val serviceTier: OpenAIServiceTier? = null, val metadata: OpenAIMetadata? = null, val background: Boolean? = null, val user: String? = null, val safetyIdentifier: String? = null, val promptCacheKey: String? = null)

Raw OpenAI Responses API response.

Link copied to clipboard
@Serializable
data class OpenAIResponsesToolUsage(val imageGen: OpenAIImageGenToolUsage? = null, val webSearch: OpenAIWebSearchToolUsage? = null)

Token usage per hosted tool, when the response was served with tool usage metering.

Link copied to clipboard
@Serializable
data class OpenAIResponsesUsage(val inputTokens: Int, val outputTokens: Int, val totalTokens: Int, val inputTokensDetails: OpenAIResponsesInputTokensDetails? = null, val outputTokensDetails: OpenAIResponsesOutputTokensDetails? = null) : Mapper<TokensUsage>

Token usage statistics from an OpenAI Responses API response.

Link copied to clipboard
@Serializable
data class OpenAIWebSearchToolUsage(val numRequests: Int)

Usage of the web search tool.