Interface IOutlineMessage

Interface representing a message in the outline system. Used to structure messages stored in the outline history, typically for user, assistant, or system interactions.

interface IOutlineMessage {
    content: string;
    images?: string[] | Blob[];
    role: BaseMessageRole;
    tool_call_id?: string;
    tool_calls?: IToolCall[];
}

Hierarchy (View Summary)

Properties

content: string

The content of the message, representing the primary data or text being communicated. Contains the raw text or data of the message, used in history storage or processing.

images?: string[] | Blob[]

Optional array of images associated with the message. Represented as binary data (Blob) or base64 strings. Used for messages involving visual content (e.g., user-uploaded images or tool-generated visuals).

The role of the message sender. Common roles include "assistant", "system", "tool", and "user". Specific message types may extend this with additional roles.

tool_call_id?: string

Optional identifier of the tool call this message responds to. Links tool outputs to their originating requests. Used to correlate tool responses with their corresponding tool calls.

tool_calls?: IToolCall[]

Optional array of tool calls associated with the message. Present when the model requests tool execution. Each tool call contains function name, arguments, and a unique identifier.