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

Package-level declarations

Types

Link copied to clipboard
class AssistantMessageBuilder

Assistant message builder.

Link copied to clipboard
@Serializable
data class ChatChoice(val index: Int, val message: ChatMessage, val finishReason: FinishReason? = null, val logprobs: Logprobs? = null)

A completion generated by OpenAI.

Link copied to clipboard
@Serializable
data class ChatChunk(val index: Int, val delta: ChatDelta? = null, val contentFilterOffsets: ContentFilterOffsets? = null, val contentFilterResults: ContentFilterResults? = null, val finishReason: FinishReason? = null)

A completion generated by OpenAI.

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

Link copied to clipboard
@Serializable
data class ChatCompletionChunk(val id: String, val created: Long, 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.

Link copied to clipboard
@Serializable
data class ChatCompletionFunction(val name: String, val description: String? = null, val parameters: Parameters)
Link copied to clipboard
Link copied to clipboard
@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, val instanceId: String? = null, val streamOptions: StreamOptions? = null)

Creates a completion for the chat message.

Link copied to clipboard
class ChatCompletionRequestBuilder

Creates a completion for the chat message.

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

Link copied to clipboard
@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, val contentFilterResults: List<ContentFilterResults>? = null, val contentFilterOffsets: List<ContentFilterOffsets>? = null)

The messages to generate chat completions for.

Link copied to clipboard
class ChatMessageBuilder

Builder of ChatMessageBuilder instances.

Link copied to clipboard
class ChatMessagesBuilder

Creates a list of ChatMessage.

Link copied to clipboard
@Serializable
data class ChatResponseFormat(val type: String)

An object specifying the format that the model must output.

Link copied to clipboard
typealias ChatRole = Role

The role of the author of a message.

Link copied to clipboard
@Serializable(with = ContentSerializer::class)
sealed interface Content

The contents of the chat message.

Link copied to clipboard
@Serializable
data class ContentFilterOffsets(val checkOffset: Int?, val startOffset: Int?, val endOffset: Int?)
Link copied to clipboard
@Serializable
data class ContentFilterResult(val filtered: Boolean, val severity: String)
Link copied to clipboard
@Serializable
data class ContentFilterResults(val hate: ContentFilterResult? = null, val selfHarm: ContentFilterResult? = null, val sexual: ContentFilterResult? = null, val violence: ContentFilterResult? = null, val jailbreak: ContentFilterResult? = null, val profanity: ContentFilterResult? = null)
Link copied to clipboard
@Serializable
sealed interface ContentPart

Represents a chat message part.

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

Link copied to clipboard
@Serializable(with = FunctionModeSerializer::class)
sealed interface FunctionMode

This interface determines how the model handles function calls.

Link copied to clipboard
class FunctionsBuilder

Creates a list of ChatCompletionFunction.

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

Link copied to clipboard
class FunctionToolCallBuilder

Tool call builder.

Link copied to clipboard
@Serializable
data class FunctionToolChoice(val name: String)

Represents the function to call by the model.

Link copied to clipboard
@Serializable
@SerialName(value = "image_url")
data class ImagePart(val imageUrl: ImagePart.ImageURL) : ContentPart

Image content part.

Link copied to clipboard
@JvmInline
@Serializable
value class ListContent(val content: List<ContentPart>) : Content

The chat message content as a list of content parts.

Link copied to clipboard
@Serializable
data class Logprobs(val content: List<LogprobsContent>? = null)

An object containing log probability information for the choice.

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

Link copied to clipboard
typealias Parameters = com.aallam.openai.api.core.Parameters

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

Link copied to clipboard
@Serializable
data class StreamOptions(val includeUsage: Boolean? = null)

Options for streaming response.

Link copied to clipboard
Link copied to clipboard
class SystemMessageBuilder

System message builder.

Link copied to clipboard
@JvmInline
@Serializable
value class TextContent(val content: String) : Content

The chat message content as text.

Link copied to clipboard
@Serializable
@SerialName(value = "text")
data class TextPart(val text: String) : ContentPart

Text content part.

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

Link copied to clipboard
class ToolBuilder

Creates a list of Tool.

Link copied to clipboard
@Serializable
sealed interface ToolCall

Details of the tool call.

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

Link copied to clipboard
class ToolCallsBuilder

List of tool calls builder.

Link copied to clipboard
@Serializable(with = ToolChoiceSerializer::class)
sealed interface ToolChoice

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

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

The ID of the tool call.

Link copied to clipboard
class ToolMessageBuilder

Tool message builder.

Link copied to clipboard
@JvmInline
@Serializable
value class ToolType(val value: String)

The type of the tool.

Link copied to clipboard
@Serializable
data class TopLogprob(val token: String, val logprob: Double, val bytes: List<Int>? = null)

An object containing a token and their log probability.

Link copied to clipboard
class UserMessageBuilder

User message builder.

Functions

Link copied to clipboard
fun assistantMessage(block: AssistantMessageBuilder.() -> Unit): ChatMessage

Assistant chat message.

Link copied to clipboard
fun chatCompletionFunction(block: ChatCompletionFunctionBuilder.() -> Unit): ChatCompletionFunction

The function to generate chat completion function instances.

Link copied to clipboard
fun chatCompletionRequest(block: ChatCompletionRequestBuilder.() -> Unit): ChatCompletionRequest

The messages to generate chat completions for.

Link copied to clipboard
fun chatMessage(block: ChatMessageBuilder.() -> Unit): ChatMessage

The messages to generate chat completions for.

Link copied to clipboard
fun function(block: FunctionToolCallBuilder.() -> Unit): ToolCall.Function

Tool: function call.

Link copied to clipboard
fun streamOptions(block: StreamOptionsBuilder.() -> Unit): StreamOptions

Create a new StreamOptions instance.

Link copied to clipboard
fun systemMessage(block: SystemMessageBuilder.() -> Unit): ChatMessage

System chat message.

Link copied to clipboard
fun toolMessage(block: ToolMessageBuilder.() -> Unit): ChatMessage

Tool chat message.

Link copied to clipboard
fun userMessage(block: UserMessageBuilder.() -> Unit): ChatMessage

User chat message.