AI SDK Kotlin/ai.torad.aisdk.ui

Package-level declarations

Types

Chat

class Chat(val id: String = "chat", initialMessages: List<UIMessage> = emptyList(), transport: ChatTransport)

ChatRequest

class ChatRequest

ChatRequestBuilder

class ChatRequestBuilder

ChatSession

class ChatSession(chat: Chat)

ChatSessionFactory

object ChatSessionFactory

ChatState

data class ChatState(val id: String, val messages: List<UIMessage> = emptyList(), val status: ChatStatus = ChatStatus.Ready, val error: Throwable? = null)

ChatStatus

enum ChatStatus : Enum<ChatStatus>

ChatTransport

interface ChatTransport

DefaultChatTransport

class DefaultChatTransport(delegate: ChatTransport) : ChatTransport

DirectChatTransport

class DirectChatTransport(handler: (ChatRequest) -> Flow<UIMessage>) : ChatTransport

ModelMessageConversion

object ModelMessageConversion

UI-to-model message conversion. Groups convertToModelMessages and its helpers so none remain loose top-level functions.

SafeValidateUIMessagesResult

sealed class SafeValidateUIMessagesResult

ServerResponseWriter

interface ServerResponseWriter

TextStreamChatTransport

class TextStreamChatTransport(handler: (ChatRequest) -> Flow<String>, assistantMessageId: (ChatRequest) -> String = { request -> UiMessageStreams.getResponseUiMessageId(request.messages) }) : ChatTransport

TextStreamResponse

class TextStreamResponse(val textStream: Flow<String>, val status: Int = 200, val headers: Map<String, String> = UiMessageStreams.textStreamHeaders())

TextUIPartState

@Serializable

enum TextUIPartState : Enum<TextUIPartState>

Streaming-vs-final state for UIMessagePart.Text and UIMessagePart.Reasoning (per historical parity gap #30, mirrors v6's TextUIPart.state: 'streaming' | 'done'). Renderers use this to drive a typing cursor / fade animation while the model is still producing the part, and to commit a final layout pass on Done.

ToolCallState

@Serializable

enum ToolCallState : Enum<ToolCallState>

Tool call lifecycle in the UI. v6 names — input-streaming / input-available / output-available, NOT v5's partial-call / call / result.

ToolPartHandlerRegistry

class ToolPartHandlerRegistry<TRenderResult>

Registry of per-tool renderers. The SDK is UI-framework-agnostic — the registry holds renderer functions that take UIToolInvocation. An application can supply Compose composables, SwiftUI bridge closures, server-rendered nodes, or any other renderer value.

UIMessage

@Serializable

data class UIMessage(val id: String, val role: UIMessageRole, val parts: List<UIMessagePart>, val createdAtMs: Long = 0, val metadata: Map<String, JsonElement>? = null)

UI-shape message — what the chat surface renders. Carries an ordered list of UIMessageParts (Vercel AI SDK v6 message-parts model). The conversion from ai.torad.aisdk.StreamEvent flow into a growing list of these messages happens in streamToUiMessages.

UIMessageMetadata

object UIMessageMetadata

UIMessagePart

@Serializable

sealed interface UIMessagePart

UIMessageRole

@Serializable

enum UIMessageRole : Enum<UIMessageRole>

UIMessageStreamResponse

class UIMessageStreamResponse(val stream: Flow<UIMessage>, val status: Int = 200, val headers: Map<String, String> = UiMessageStreams.uiMessageStreamHeaders())

UiMessageStreams

object UiMessageStreams

UIMessageStreamWriter

interface UIMessageStreamWriter

UIToolInvocation

class UIToolInvocation<TInput, TOutput>(val toolCallId: String, val toolName: String, val state: ToolCallState, val payload: UIToolInvocationPayload<TInput, TOutput>, val metadata: UIToolInvocationMetadata = UIToolInvocationMetadata())

UIToolInvocationMetadata

class UIToolInvocationMetadata(val preliminary: Boolean = false, val approvalId: String? = null, val signature: String? = null)

UIToolInvocationPayload

class UIToolInvocationPayload<TInput, TOutput>(val input: TInput?, val output: TOutput?, val error: String?)

Typed invocation handle — what a per-tool renderer receives. Carries the typed input + output via the tool's own serializers.

Functions

ChatRequest

fun ChatRequest(block: ChatRequestBuilder.() -> Unit = {}): ChatRequest

ChatSession

fun ChatSession(id: String = "chat", initialMessages: List<UIMessage> = emptyList(), transport: ChatTransport): ChatSession

CreateTextStreamResponse

fun CreateTextStreamResponse(textStream: Flow<String>, status: Int = 200, headers: Map<String, String> = UiMessageStreams.textStreamHeaders()): TextStreamResponse

CreateUiMessageStream

fun CreateUiMessageStream(onError: (Throwable) -> UIMessage = { throwable -> UIMessage( id = "error", role = UIMessageRole.Assistant, parts = listOf(UIMessagePart.Error(throwable.message ?: "stream failed")), ) }, execute: suspend UIMessageStreamWriter.() -> Unit): Flow<UIMessage>

CreateUiMessageStreamResponse

fun CreateUiMessageStreamResponse(stream: Flow<UIMessage>, status: Int = 200, headers: Map<String, String> = UiMessageStreams.uiMessageStreamHeaders()): UIMessageStreamResponse

ReadUiMessageStream

fun ReadUiMessageStream(stream: Flow<UIMessage>): Flow<UIMessage>

StreamToUiMessages

fun StreamToUiMessages(events: Flow<StreamEvent>, assistantMessageId: String): Flow<UIMessage>

TextStreamFromEvents

fun TextStreamFromEvents(events: Flow<StreamEvent>): Flow<String>

ToolPartHandlerRegistry

fun <TRenderResult> ToolPartHandlerRegistry(fallback: (UIMessagePart.ToolUI) -> TRenderResult, block: ToolPartHandlerRegistry.Builder<TRenderResult>.() -> Unit): ToolPartHandlerRegistry<TRenderResult>

Faux-constructor builder for ToolPartHandlerRegistry.

ToUIMessageStream

fun ToUIMessageStream(events: Flow<StreamEvent>): Flow<JsonObject>

Bridge an agent StreamEvent flow to the v6 UI-message-stream wire protocol: each emission is a UIMessageChunk JSON object (e.g. { "type": "text-delta", "id": "...", "delta": "..." }) ready to be framed as an SSE data: line and consumed by a JS useChat client. Events with no wire counterpart (response-metadata, tool-input-end, raw) are dropped.

TransformTextToUiMessageStream

fun TransformTextToUiMessageStream(textStream: Flow<String>, assistantMessageId: String, metadata: Map<String, JsonElement>? = null): Flow<UIMessage>

UiMessageStreamError

fun UiMessageStreamError(message: String, cause: Throwable? = null): UiMessageStreamError