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

Package-level declarations

Types

AssistantMessageBuilder

class AssistantMessageBuilder

Assistant message builder.

@Serializable

data class ChatChoice(val index: Int, val message: ChatMessage, val finishReason: FinishReason? = null, val logprobs: Logprobs? = null)

A completion generated by OpenAI.

@Serializable

data class ChatChunk(val index: Int, val delta: ChatDelta, val finishReason: FinishReason?)

A completion generated by OpenAI.

@Serializable

data class ChatCompletion(val id: String, val created: Long, val model: ModelId, val choices: List<ChatChoice>, val usage: Usage? = null, val systemFingerprint: String? = null)

An object containing a response from the chat completion api.

ChatCompletionChunk

@Serializable

data class ChatCompletionChunk(val id: String, val created: Int, val model: ModelId, val choices: List<ChatChunk>, val usage: Usage? = null, val systemFingerprint: String? = null)

An object containing a response from the chat stream completion api.

ChatCompletionFunction

@Serializable

data class ChatCompletionFunction(val name: String, val description: String? = null, val parameters: Parameters)

ChatCompletionFunctionBuilder

class ChatCompletionFunctionBuilder

Builder of ChatCompletionFunction instances.

ChatCompletionRequest

@Serializable

class ChatCompletionRequest(val model: ModelId, val messages: List<ChatMessage>, val temperature: Double? = null, val topP: Double? = null, val n: Int? = null, val stop: List<String>? = null, val maxTokens: Int? = null, val presencePenalty: Double? = null, val frequencyPenalty: Double? = null, val logitBias: Map<String, Int>? = null, val user: String? = null, val functions: List<ChatCompletionFunction>? = null, val functionCall: FunctionMode? = null, val responseFormat: ChatResponseFormat? = null, val tools: List<Tool>? = null, val toolChoice: ToolChoice? = null, val seed: Int? = null, val logprobs: Boolean? = null, val topLogprobs: Int? = null)

Creates a completion for the chat message.

ChatCompletionRequestBuilder

class ChatCompletionRequestBuilder

Creates a completion for the chat message.

@Serializable

data class ChatDelta(val role: ChatRole? = null, val content: String? = null, val functionCall: FunctionCall? = null, val toolCalls: List<ToolCallChunk>? = null, val toolCallId: ToolId? = null)

Generated chat message.

@Serializable

data class ChatMessage(val role: ChatRole, val messageContent: Content? = null, val name: String? = null, val functionCall: FunctionCall? = null, val toolCalls: List<ToolCall>? = null, val toolCallId: ToolId? = null)

The messages to generate chat completions for.

ChatMessageBuilder

class ChatMessageBuilder

Builder of ChatMessageBuilder instances.

ChatMessagesBuilder

class ChatMessagesBuilder

Creates a list of ChatMessage.

ChatResponseFormat

@Serializable

data class ChatResponseFormat(val type: String)

An object specifying the format that the model must output.

typealias ChatRole = Role

The role of the author of a message.

@Serializable(with = ContentSerializer::class)

interface Content

The contents of the chat message.

@Serializable

interface ContentPart

Represents a chat message part.

ContentPartBuilder

class ContentPartBuilder

@Serializable

data class FunctionCall(val nameOrNull: String? = null, val argumentsOrNull: String? = null)

Represents a function invocation with its name and serialized arguments as generated by the model.

@Serializable(with = FunctionModeSerializer::class)

interface FunctionMode

This interface determines how the model handles function calls.

FunctionsBuilder

class FunctionsBuilder

Creates a list of ChatCompletionFunction.

@Serializable

data class FunctionTool(val name: String, val parameters: Parameters? = null, val description: String? = null)

A description of what the function does, used by the model to choose when and how to call the function.

FunctionToolCallBuilder

class FunctionToolCallBuilder

Tool call builder.

FunctionToolChoice

@Serializable

data class FunctionToolChoice(val name: String)

Represents the function to call by the model.

@Serializable

data class ImagePart(val imageUrl: ImagePart.ImageURL) : ContentPart

Image content part.

@Serializable

value class ListContent(val content: List<ContentPart>) : Content

The chat message content as a list of content parts.

@Serializable

data class Logprobs(val content: List<LogprobsContent>? = null)

An object containing log probability information for the choice.

LogprobsContent

@Serializable

data class LogprobsContent(val token: String, val logprob: Double, val bytes: List<Int>? = null, val topLogprobs: List<TopLogprob>)

An object containing logprobs for a single token

typealias ~~Parameters~~ = com.aallam.openai.api.core.Parameters

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

SystemMessageBuilder

class SystemMessageBuilder

System message builder.

@Serializable

value class TextContent(val content: String) : Content

The chat message content as text.

@Serializable

data class TextPart(val text: String) : ContentPart

Text content part.

@Serializable

data class Tool(val type: ToolType, val function: FunctionTool)

A list of tools the model may call. Use this to provide a list of functions the model may generate JSON inputs for.

class ToolBuilder

Creates a list of Tool.

@Serializable

interface ToolCall

Details of the tool call.

@Serializable

data class ToolCallChunk(val index: Int, val type: String? = null, val id: ToolId? = null, val function: FunctionCall? = null)

Details of the tool call chunk.

ToolCallsBuilder

class ToolCallsBuilder

List of tool calls builder.

@Serializable(with = ToolChoiceSerializer::class)

interface ToolChoice

Controls which (if any) function is called by the model.

@Serializable

value class ToolId(val id: String)

The ID of the tool call.

ToolMessageBuilder

class ToolMessageBuilder

Tool message builder.

@Serializable

value class ToolType(val value: String)

The type of the tool.

@Serializable

data class TopLogprob(val token: String, val logprob: Double, val bytes: List<Int>? = null)

An object containing a token and their log probability.

UserMessageBuilder

class UserMessageBuilder

User message builder.

Functions

assistantMessage

fun assistantMessage(block: AssistantMessageBuilder.() -> Unit): ChatMessage

Assistant chat message.

chatCompletionFunction

fun chatCompletionFunction(block: ChatCompletionFunctionBuilder.() -> Unit): ChatCompletionFunction

The function to generate chat completion function instances.

chatCompletionRequest

fun chatCompletionRequest(block: ChatCompletionRequestBuilder.() -> Unit): ChatCompletionRequest

The messages to generate chat completions for.

fun chatMessage(block: ChatMessageBuilder.() -> Unit): ChatMessage

The messages to generate chat completions for.

fun function(block: FunctionToolCallBuilder.() -> Unit): ToolCall.Function

Tool: function call.

fun systemMessage(block: SystemMessageBuilder.() -> Unit): ChatMessage

System chat message.

fun toolMessage(block: ToolMessageBuilder.() -> Unit): ChatMessage

Tool chat message.

fun userMessage(block: UserMessageBuilder.() -> Unit): ChatMessage

User chat message.