OpenAIMessageParam

@Serializable
sealed interface OpenAIMessageParam

Polymorphic request message parameter for the OpenAI API.

Discriminated by the "role" field. Each variant corresponds to a message role:

  • User — Input from the user.

  • System — System prompt.

  • Developer — Developer instructions (replaces system prompts for o1 and newer models).

  • Assistant — Model's previous response (for conversation history).

  • Tool — Tool execution result.

Inheritors

Types

Link copied to clipboard
@Serializable
@SerialName(value = "assistant")
data class Assistant(val content: OpenAIChatCompletionContent? = null, val name: String? = null, val refusal: String? = null, val audio: OpenAIAssistantAudioParam? = null, val functionCall: OpenAIFunctionCall? = null, val toolCalls: List<OpenAIToolCall>? = null) : OpenAIMessageParam

An assistant message (for conversation history).

Link copied to clipboard
Link copied to clipboard
@Serializable
@SerialName(value = "developer")
data class Developer(val content: OpenAIChatCompletionContent, val name: String? = null) : OpenAIMessageParam

Developer-provided instructions that the model follows regardless of user messages.

Link copied to clipboard
@Serializable
@SerialName(value = "system")
data class System(val content: OpenAIChatCompletionContent, val name: String? = null) : OpenAIMessageParam

A system message.

Link copied to clipboard
@Serializable
@SerialName(value = "tool")
data class Tool(val content: OpenAIChatCompletionContent, val toolCallId: String, val name: String? = null) : OpenAIMessageParam

A tool result message.

Link copied to clipboard
@Serializable
@SerialName(value = "user")
data class User(val content: OpenAIChatCompletionContent, val name: String? = null) : OpenAIMessageParam

A user message.