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

ChatMessageBuilder

class ChatMessageBuilder

Builder of ChatMessageBuilder instances.

Constructors

ChatMessageBuilder

constructor()

Properties

var annotations: List<ChatAnnotation>?

Annotations associated with assistant content.

var content: String?

The contents of the message.

contentFilterOffsets

var contentFilterOffsets: List<ContentFilterOffsets>?

Azure content filter offsets

contentFilterResults

var contentFilterResults: List<ContentFilterResults>?

Azure content filter results

var ~~functionCall~~: FunctionCall?

The name and arguments of a function that should be called, as generated by the model.

var name: String?

The name of the author of this message. name is required if the role is `ChatRole.Function, and it should be the name of the function whose response is in the content. It May contain a-z, A-Z, 0-9, and underscores, with a maximum length of 64 characters.

reasoningContent

var reasoningContent: String?

Additional reasoning content returned by reasoning-capable models.

var role: ChatRole?

The role of the author of this message.

var toolCallId: ToolId?

Tool call ID.

var toolCalls: List<ToolCall>?

The tool calls generated by the model, such as function calls.

Functions

fun build(): ChatMessage

Create ChatMessage instance.

fun content(block: ContentPartBuilder.() -> Unit)

The contents of the message.