Skip to content

core / Exports / SimpleConversationHistory

Class: SimpleConversationHistory

Default conversation history implementation

Implements

Table of contents

Constructors

Methods

Constructors

constructor

new SimpleConversationHistory(options?): SimpleConversationHistory

Parameters

NameType
options?Object
options.maxMessages?number

Returns

SimpleConversationHistory

Defined in

conversation-history.ts:98

Methods

addMessage

addMessage(message): void

Add message to conversation history

Parameters

NameType
messageUniversalMessage

Returns

void

Implementation of

ConversationHistory.addMessage

Defined in

conversation-history.ts:102


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:107


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:116


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:126


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:135


getMessages

getMessages(): UniversalMessage[]

Get all messages

Returns

UniversalMessage[]

Implementation of

ConversationHistory.getMessages

Defined in

conversation-history.ts:150


getMessagesByRole

getMessagesByRole(role): UniversalMessage[]

Get messages by specific role

Parameters

NameType
roleUniversalMessageRole

Returns

UniversalMessage[]

Implementation of

ConversationHistory.getMessagesByRole

Defined in

conversation-history.ts:154


getRecentMessages

getRecentMessages(count): UniversalMessage[]

Get recent n messages

Parameters

NameType
countnumber

Returns

UniversalMessage[]

Implementation of

ConversationHistory.getRecentMessages

Defined in

conversation-history.ts:158


getMessageCount

getMessageCount(): number

Return message count

Returns

number

Implementation of

ConversationHistory.getMessageCount

Defined in

conversation-history.ts:162


clear

clear(): void

Clear conversation history

Returns

void

Implementation of

ConversationHistory.clear

Defined in

conversation-history.ts:166

Released under the MIT License.