Skip to main content

Class: History

Defined in: core/dist/types/history/history.d.ts:29

Unified History class - segment-based storage (V2)

Constructors​

Constructor​

new History(storage): History

Defined in: core/dist/types/history/history.d.ts:33

Parameters​

storage​

HistoryStorage

Returns​

History

Methods​

addAssistantResponse()​

addAssistantResponse(content): Promise<void>

Defined in: core/dist/types/history/history.d.ts:124

Add a complete assistant response (for non-streaming use cases like spawn-agent)

Parameters​

content​

string

Returns​

Promise<void>

addMessage()​

addMessage(message): Promise<void>

Defined in: core/dist/types/history/history.d.ts:132

Add a message (backward-compatible API)

Parameters​

message​

ChatMessage

Returns​

Promise<void>

addUserMessage()​

addUserMessage(content): Promise<void>

Defined in: core/dist/types/history/history.d.ts:120

Add a user message directly

Parameters​

content​

string

Returns​

Promise<void>

append()​

append(event): Promise<void>

Defined in: core/dist/types/history/history.d.ts:68

Append a streaming event or user message to the history

Parameters​

event​

BaleybotStreamEvent | { content: string; type: "user_message"; }

Returns​

Promise<void>

clear()​

clear(): Promise<void>

Defined in: core/dist/types/history/history.d.ts:140

Clear all segments

Returns​

Promise<void>

getFinalizedSegments()​

getFinalizedSegments(): StreamSegment[]

Defined in: core/dist/types/history/history.d.ts:79

Get finalized segments (streaming flags set to false)

Returns​

StreamSegment[]

getMessageCount()​

getMessageCount(): number

Defined in: core/dist/types/history/history.d.ts:128

Get total count of segments (for metrics)

Returns​

number

getMessagesForAPI()​

getMessagesForAPI(limit?, options?): Promise<ChatMessage[]>

Defined in: core/dist/types/history/history.d.ts:111

Get messages in API-compatible format. Derives ChatMessage[] from segments (which now include UserSegments).

Parameters​

limit?​

number

options?​

GetMessagesForAPIOptions

Returns​

Promise<ChatMessage[]>

getSegments()​

getSegments(): StreamSegment[]

Defined in: core/dist/types/history/history.d.ts:75

Get segments directly (canonical UI representation)

Returns​

StreamSegment[]

getSegmentState()​

getSegmentState(): StreamSegmentState

Defined in: core/dist/types/history/history.d.ts:83

Get full segment state (for advanced usage)

Returns​

StreamSegmentState

getSummary()​

getSummary(): Promise<string>

Defined in: core/dist/types/history/history.d.ts:144

Get a text summary of the conversation history

Returns​

Promise<string>

getUserMessages()​

getUserMessages(): UserMessage[]

Defined in: core/dist/types/history/history.d.ts:87

Get user messages (derived from segments)

Returns​

UserMessage[]

isDone()​

isDone(): boolean

Defined in: core/dist/types/history/history.d.ts:91

Check if streaming is complete

Returns​

boolean

load()​

load(): Promise<void>

Defined in: core/dist/types/history/history.d.ts:60

Load history from storage. Safe to call multiple times (no-op after first load).

Returns​

Promise<void>

matchesPendingResume()​

matchesPendingResume(options): Promise<boolean>

Defined in: core/dist/types/history/history.d.ts:99

True when a tool_call segment is paused awaiting one of the supplied approval or interrupt ids — i.e. the given resume payload actually targets a pending pause in this history. Resume flows use this to distinguish a genuine resume (do not re-append the user message) from a stray payload on a normal turn.

Parameters​

options​
approvalResponses?​

readonly object[]

interruptResponses?​

readonly object[]

Returns​

Promise<boolean>

reset()​

reset(): void

Defined in: core/dist/types/history/history.d.ts:152

Reset the builder (start fresh for new conversation)

Returns​

void

save()​

save(): Promise<void>

Defined in: core/dist/types/history/history.d.ts:136

Save the current state to storage (V2 format)

Returns​

Promise<void>

serialize()​

serialize(): Promise<string>

Defined in: core/dist/types/history/history.d.ts:148

Serialize history to JSON string

Returns​

Promise<string>

file()​

static file(filepath): History

Defined in: core/dist/types/history/history.d.ts:41

Create a file-based history

Parameters​

filepath​

string

Returns​

History

fromData()​

static fromData(stored): Promise<History>

Defined in: core/dist/types/history/history.d.ts:56

Create a History instance pre-loaded with serialized data.

Useful for restoring agent state from a database or API response — e.g., resuming a paused agent with its full conversation context.

Parameters​

stored​

StoredHistoryV2

Returns​

Promise<History>

Example​

const serialized = await originalBot.getHistory().serialize();
const stored = JSON.parse(serialized);
const history = await History.fromData(stored);
const resumedBot = Baleybot.create({ ..., keepHistory: history });

inMemory()​

static inMemory(maxMessages?): History

Defined in: core/dist/types/history/history.d.ts:37

Create an in-memory history

Parameters​

maxMessages?​

number

Returns​

History