Skip to content

core / Exports / PersistentSystemConversationHistory

Class: PersistentSystemConversationHistory

Conversation history implementation that maintains system messages

Implements

Table of contents

Constructors

Methods

Constructors

constructor

new PersistentSystemConversationHistory(systemPrompt, options?): PersistentSystemConversationHistory

Parameters

NameType
systemPromptstring
options?Object
options.maxMessages?number

Returns

PersistentSystemConversationHistory

Defined in

conversation-history.ts:193

Methods

addMessage

addMessage(message): void

Add message to conversation history

Parameters

NameType
messageUniversalMessage

Returns

void

Implementation of

ConversationHistory.addMessage

Defined in

conversation-history.ts:201


addUserMessage

addUserMessage(content, metadata?): void

Add user message (convenience method)

Parameters

NameType
contentstring
metadata?Record<string, any>

Returns

void

Implementation of

ConversationHistory.addUserMessage

Defined in

conversation-history.ts:205


addAssistantMessage

addAssistantMessage(content, functionCall?, metadata?): void

Add assistant message (convenience method)

Parameters

NameType
contentstring
functionCall?any
metadata?Record<string, any>

Returns

void

Implementation of

ConversationHistory.addAssistantMessage

Defined in

conversation-history.ts:209


addSystemMessage

addSystemMessage(content, metadata?): void

Add system message (convenience method)

Parameters

NameType
contentstring
metadata?Record<string, any>

Returns

void

Implementation of

ConversationHistory.addSystemMessage

Defined in

conversation-history.ts:213


addToolMessage

addToolMessage(toolResult, metadata?): void

Add tool execution result message (convenience method)

Parameters

NameType
toolResultFunctionCallResult
metadata?Record<string, any>

Returns

void

Implementation of

ConversationHistory.addToolMessage

Defined in

conversation-history.ts:217


getMessages

getMessages(): UniversalMessage[]

Get all messages

Returns

UniversalMessage[]

Implementation of

ConversationHistory.getMessages

Defined in

conversation-history.ts:221


getMessagesByRole

getMessagesByRole(role): UniversalMessage[]

Get messages by specific role

Parameters

NameType
roleUniversalMessageRole

Returns

UniversalMessage[]

Implementation of

ConversationHistory.getMessagesByRole

Defined in

conversation-history.ts:225


getRecentMessages

getRecentMessages(count): UniversalMessage[]

Get recent n messages

Parameters

NameType
countnumber

Returns

UniversalMessage[]

Implementation of

ConversationHistory.getRecentMessages

Defined in

conversation-history.ts:229


getMessageCount

getMessageCount(): number

Return message count

Returns

number

Implementation of

ConversationHistory.getMessageCount

Defined in

conversation-history.ts:233


clear

clear(): void

Clear conversation history

Returns

void

Implementation of

ConversationHistory.clear

Defined in

conversation-history.ts:237


updateSystemPrompt

updateSystemPrompt(systemPrompt): void

Update system prompt

Parameters

NameType
systemPromptstring

Returns

void

Defined in

conversation-history.ts:246


getSystemPrompt

getSystemPrompt(): string

Return current system prompt

Returns

string

Defined in

conversation-history.ts:265

Released under the MIT License.