Skip to main content

Class: History

Defined in: packages/core/src/history/history.ts:159

Constructors​

Constructor​

new History(storage, options?): History

Defined in: packages/core/src/history/history.ts:169

Parameters​

storage​

HistoryStorage

options?​

HistoryOptions = {}

Returns​

History

Methods​

addAssistantResponse()​

addAssistantResponse(content): Promise<void>

Defined in: packages/core/src/history/history.ts:560

Add a complete assistant response, for callers that do not stream.

Parameters​

content​

string

Returns​

Promise<void>


addMessage()​

addMessage(message): Promise<void>

Defined in: packages/core/src/history/history.ts:577

Record a user or assistant ChatMessage; other roles are ignored.

Parameters​

message​

ChatMessage

Returns​

Promise<void>


addUserMessage()​

addUserMessage(content): Promise<void>

Defined in: packages/core/src/history/history.ts:555

Parameters​

content​

string

Returns​

Promise<void>


append()​

append(event): Promise<void>

Defined in: packages/core/src/history/history.ts:276

Parameters​

event​

HistoryEvent

Returns​

Promise<void>


clear()​

clear(): Promise<void>

Defined in: packages/core/src/history/history.ts:611

Returns​

Promise<void>


getFinalizedSegments()​

getFinalizedSegments(): StreamSegment[]

Defined in: packages/core/src/history/history.ts:449

The segments with every streaming flag set to false.

Returns​

StreamSegment[]


getMessageCount()​

getMessageCount(): number

Defined in: packages/core/src/history/history.ts:572

The number of segments, not of API messages.

Returns​

number


getMessagesForAPI()​

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

Defined in: packages/core/src/history/history.ts:509

The conversation as ChatMessage[], keeping the last limit messages, with every tool call given a result.

Parameters​

limit?​

number

options?​

GetMessagesForAPIOptions

Returns​

Promise<ChatMessage[]>


getSegments()​

getSegments(): StreamSegment[]

Defined in: packages/core/src/history/history.ts:444

Returns​

StreamSegment[]


getSegmentState()​

getSegmentState(): StreamSegmentState

Defined in: packages/core/src/history/history.ts:453

Returns​

StreamSegmentState


getSummary()​

getSummary(): Promise<string>

Defined in: packages/core/src/history/history.ts:619

One line per segment, user and assistant text cut to 100 characters.

Returns​

Promise<string>


getUserMessages()​

getUserMessages(): UserMessage[]

Defined in: packages/core/src/history/history.ts:457

Returns​

UserMessage[]


hasTurn()​

hasTurn(turnId): Promise<boolean>

Defined in: packages/core/src/history/history.ts:397

True when a turn with this id is recorded here (see recordTurn).

Parameters​

turnId​

string

Returns​

Promise<boolean>


isDone()​

isDone(): boolean

Defined in: packages/core/src/history/history.ts:466

Returns​

boolean


latestInstructions()​

latestInstructions(turnId?): Promise<string | undefined>

Defined in: packages/core/src/history/history.ts:389

The instructions the latest user message carries (see recordInstructions), if any — or, given a turn id, the ones that turn's recorded user message carries (see recordTurn).

Parameters​

turnId?​

string

Returns​

Promise<string | undefined>


load()​

load(): Promise<void>

Defined in: packages/core/src/history/history.ts:213

Load history from storage. A no-op after the first load.

Returns​

Promise<void>


recordInstructions()​

recordInstructions(instructions): Promise<void>

Defined in: packages/core/src/history/history.ts:345

Record the instructions a request sent just before the latest user message (UserSegment.instructions), so a later request rebuilds the conversation as this one sent it. Baleybot records its active skills' instructions here; a host replaying a conversation it builds itself can do the same.

Parameters​

instructions​

string

Returns​

Promise<void>


recordPreloaded()​

recordPreloaded(preloaded): Promise<void>

Defined in: packages/core/src/history/history.ts:364

Record skills the request pre-loaded as conversation before the latest user message (UserSegment.preloaded), added to any recorded already.

Parameters​

preloaded​

readonly object[]

Returns​

Promise<void>


recordTurn()​

recordTurn(turn): Promise<void>

Defined in: packages/core/src/history/history.ts:413

Record one turn under a stable id, replacing an earlier record of the same turn in place. A checkpointed turn that spans several calls (a yield, a stop, a crash) is recorded by each of them; every call writes the whole turn so far, so the history holds every completed step exactly once and a turn the person starts instead reads what was already done.

Segment ids: the user message is id, the given segments id:0…, and the segments this call's events add id:e0…. A segment rewritten under the id it had keeps its timestamp, so an unchanged record compares equal.

Parameters​

turn​

HistoryTurn

Returns​

Promise<void>


reset()​

reset(): void

Defined in: packages/core/src/history/history.ts:658

Empty the in-memory state without saving; storage is untouched.

Returns​

void


restore()​

restore(stored): Promise<void>

Defined in: packages/core/src/history/history.ts:204

Restore a durable snapshot without replacing the configured storage backend.

Parameters​

stored​

StoredHistoryV2

Returns​

Promise<void>


resumeOf()​

resumeOf(options): Promise<"resume" | "turn" | "stray">

Defined in: packages/core/src/history/history.ts:479

What a call's resume payload means for this history: 'turn' when it carries no decisions, 'resume' when one of them answers a pause this history holds (a tool call awaiting that approval or interrupt id), and 'stray' when none does (forged ids, or a turn that never paused). A resume re-issues the paused turn, so its user message is not appended again; a stray payload is not a resume. Every caller that has to tell them apart (Baleybot, ChatBot, a chat route) asks here.

Parameters​

options​
approvalResponses?​

readonly object[]

interruptResponses?​

readonly object[]

Returns​

Promise<"resume" | "turn" | "stray">


save()​

save(): Promise<void>

Defined in: packages/core/src/history/history.ts:590

A history not loaded yet loads first, so saving never replaces what storage holds with nothing.

Returns​

Promise<void>


serialize()​

serialize(): Promise<string>

Defined in: packages/core/src/history/history.ts:646

Returns​

Promise<string>


file()​

static file(filepath): History

Defined in: packages/core/src/history/history.ts:177

Parameters​

filepath​

string

Returns​

History


fromData()​

static fromData(stored): Promise<History>

Defined in: packages/core/src/history/history.ts:193

A history pre-loaded with serialized data. Its storage is read-only: saves are dropped, so the caller manages persistence.

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: packages/core/src/history/history.ts:173

Parameters​

maxMessages?​

number

Returns​

History