ai-mocks-openai/dev.mokksy.aimocks.openai.model.chat

Package-level declarations

Types

AudioInputObject

@Serializable

data class AudioInputObject(val data: String, val format: String)

Represents an audio input object.

CallableFunction

@Serializable

data class CallableFunction(val name: String, val arguments: String)

Represents a function that can be called by the AI model.

ChatCompletionRequest

@Serializable

data class ChatCompletionRequest(val messages: List<Message>, val model: String, val store: Boolean = false, val reasoningEffort: String = "medium", val metadata: Metadata? = null, val maxCompletionTokens: Int? = null, val frequencyPenalty: Double? = 0.0, val presencePenalty: Double? = 0.0, val responseFormat: ResponseFormat? = null, val temperature: Double = 1.0, val topP: Double? = 1.0, val n: Int? = 1, val stop: List<String>? = null, val logitBias: Map<String, Int>? = null, val user: String? = null, val seed: Int? = null, val stream: Boolean = false, val streamOptions: ChatCompletionStreamOptions? = null, val tools: List<Tool>? = null, val toolChoice: ToolChoice? = null)

Represents a request for generating a chat-based completions in an OpenAI-like environment. See Create chat completions.

ChatCompletionRequestBuilder

class ChatCompletionRequestBuilder

Builder class for creating ChatCompletionRequest instances.

ChatResponse

@Serializable

data class ChatResponse(val id: String, val objectType: String = "chat.completions", val created: Long, val model: String, val serviceTier: String? = null, val systemFingerprint: String? = null, val usage: Usage, val choices: List<Choice>)

Represents a response to a chat completion request.

Choice

@Serializable

data class Choice(val index: Int, val delta: Delta? = null, val message: Message? = null, val logprobs: String? = null, val finishReason: String? = null)

Represents a choice in a completion response.

Chunk

@Serializable

data class Chunk(val id: String, val objectType: String = "chat.completion.chunk", val created: Long, val model: String, val serviceTier: String? = null, val systemFingerprint: String, val usage: Usage? = null, val choices: List<Choice>)

Represents a chunk of a streaming response.

CompletionTokensDetails

@Serializable

data class CompletionTokensDetails(val reasoningTokens: Int, val acceptedPredictionTokens: Int, val rejectedPredictionTokens: Int)

Represents details about completion tokens.

ContentPart

@Serializable

sealed class ContentPart

Represents a content part in a message.

Delta

@Serializable

data class Delta(val role: ChatCompletionRole? = null, val content: String? = null)

Represents a delta in a streaming response.

FunctionObject

@Serializable

data class FunctionObject(val name: String, val description: String? = null, val parameters: JsonElement? = null, val strict: Boolean? = false)

Represents a function that can be called by the model.

ImageUrlObject

@Serializable

data class ImageUrlObject(val url: String, val detail: String? = null)

Represents an image URL object.

Message

@Serializable

data class Message(val role: ChatCompletionRole, val content: MessageContent, val refusal: String? = null, val toolCalls: List<ToolCall>? = null, val name: String? = null, val toolCallId: String? = null)

Represents a message in a chat conversation.

MessageContent

@Serializable

sealed class MessageContent

Represents the content of a message, which can be either a simple string or an array of content parts.

MessageContentSerializer

class MessageContentSerializer : KSerializer<MessageContent>

Custom serializer for MessageContent that handles both string and array formats.

Metadata

@Serializable

data class Metadata(val tags: Map<String, String>? = null)

Represents metadata for a request.

ResponseFormat

typealias ~~ResponseFormat~~ = dev.mokksy.aimocks.openai.ResponseFormat

Backward-compatible typealias for dev.mokksy.aimocks.openai.ResponseFormat.

TokenDetails

@Serializable

data class TokenDetails(val cachedTokens: Int? = null)

Represents details about tokens.

Tool

@Serializable

data class Tool(val type: String = "function", val function: FunctionObject)

Represents a tool that can be used by the model.

ToolCall

@Serializable

data class ToolCall(val id: String, val type: String = "function", val function: CallableFunction)

Represents a tool call made by the model.

ToolChoice

@Serializable(with = ToolChoiceSerializer::class)

sealed class ToolChoice

Represents a sealed class that defines choices for tools used in a process or operation.

ToolChoiceFunction

@Serializable

data class ToolChoiceFunction(val name: String)

Represents a function that the model should call.

ToolChoiceSerializer

class ToolChoiceSerializer : KSerializer<ToolChoice>

Custom serializer for ToolChoice that handles both string and object formats.

Usage

@Serializable

data class Usage(val promptTokens: Int, val completionTokens: Int, val totalTokens: Int, val completionTokensDetails: CompletionTokensDetails, val promptTokensDetails: TokenDetails? = null)

Represents usage statistics for a completion.