Embabel Agent Documentation/com.embabel.chat

Package-level declarations

Types

Asset

interface Asset : LlmReferenceProvider

Asset associated with a conversation. An asset may be persistent or ephemeral.

AssetTracker

interface AssetTracker : AssetView

Extended by anything that can track assets

AssetView

interface AssetView

View of tracked assets

AssetViewImpl

class AssetViewImpl(val assets: List<Asset>) : AssetView

AssistantMessage

open class AssistantMessage constructor(content: String, val name: String? = null, val awaitable: Awaitable<*, *>? = null, val assets: List<Asset> = emptyList(), val timestamp: Instant = Instant.now()) : BaseMessage, AssistantContent, AssetView

Message sent by the assistant - currently text-only

AssistantMessageWithToolCalls

class AssistantMessageWithToolCalls constructor(content: String = "", val toolCalls: List<ToolCall>, val name: String? = null, val timestamp: Instant = Instant.now()) : BaseMessage, AssistantContent

An assistant message that includes tool calls. When an LLM requests tool calls, it may or may not include text content. This class handles both cases - empty content is valid for tool-call-only responses.

BaseMessage

sealed class BaseMessage : Message, HasContent

Base message implementation supporting multimodal content.

Chatbot

interface Chatbot

A chatbot can conduct multiple chat sessions, each identified by a conversationId.

ChatSession

interface ChatSession

Simplest possible conversation session implementation Responsible for keeping its conversation up to date via Conversation.addMessage(), and for sending messages to the OutputChannel.

ContentPart

sealed interface ContentPart

Represents a part of a multimodal message. This sealed interface ensures type safety and extensibility for future media types.

Conversation

interface Conversation : AssetView

Conversation shim for agent system. Mutable. Conversation AssetView shows assets both from our AssetTracker and messages.

ConversationFactory

interface ConversationFactory

Factory for creating and loading Conversation instances.

ConversationFactoryProvider

interface ConversationFactoryProvider

Provider for ConversationFactory instances by type.

ConversationFormatter

fun interface ConversationFormatter

Format a conversation into a String for inclusion in a prompt. Note that we often prefer to use messages.

ConversationStoreType

enum ConversationStoreType : Enum<ConversationStoreType>

Type of conversation storage.

ImagePart

data class ImagePart(val mimeType: String, val data: ByteArray) : ContentPart

A part of a message containing image data.

MapConversationFactoryProvider

class MapConversationFactoryProvider(factories: Map<ConversationStoreType, ConversationFactory>) : ConversationFactoryProvider

Simple map-based implementation of ConversationFactoryProvider.

MergedAssetView

class MergedAssetView(views: List<AssetView>) : AssetView

An AssetView that merges assets from multiple views.

Message

interface Message

Core message interface for the agent system. This is the minimal contract that all messages must implement, suitable for both in-memory usage and persistence.

MessageFormatter

fun interface MessageFormatter

MessageRole

enum MessageRole : Enum<MessageRole>

Role of the message sender.

Role

typealias Role = MessageRole

Role of the message sender. Typealias for backwards compatibility.

SimpleMessageFormatter

object SimpleMessageFormatter : MessageFormatter

SystemMessage

class SystemMessage constructor(content: String, val timestamp: Instant = Instant.now()) : BaseMessage

System message - text-only

TextPart

data class TextPart(val text: String) : ContentPart

A part of a message containing text content.

ToolCall

data class ToolCall(val id: String, val name: String, val arguments: String)

Represents a tool call requested by the assistant.

ToolResultMessage

class ToolResultMessage constructor(val toolCallId: String, val toolName: String, content: String, val timestamp: Instant = Instant.now()) : BaseMessage

Message containing the result of a tool execution. This is sent back to the LLM after executing a tool.

UserMessage

class UserMessage : BaseMessage, UserContent

Message sent by the user - supports multimodal content

UserMessageBuilder

class UserMessageBuilder

Builder for creating multimodal UserMessages fluently

WindowingConversationFormatter

class WindowingConversationFormatter constructor(messageFormatter: MessageFormatter = SimpleMessageFormatter, windowSize: Int = 100, startIndex: Int = 0) : ConversationFormatter

Conversation formatter that shows the last windowSize messages, optionally skipping the first startIndex messages.

Functions

userMessage

fun userMessage(): UserMessageBuilder

Create a UserMessage builder