core / Exports / SimpleConversationHistory
Class: SimpleConversationHistory
Default conversation history implementation
Implements
Table of contents
Constructors
Methods
- addMessage
- addUserMessage
- addAssistantMessage
- addSystemMessage
- addToolMessage
- getMessages
- getMessagesByRole
- getRecentMessages
- getMessageCount
- clear
Constructors
constructor
• new SimpleConversationHistory(options?
): SimpleConversationHistory
Parameters
Name | Type |
---|---|
options? | Object |
options.maxMessages? | number |
Returns
Defined in
Methods
addMessage
▸ addMessage(message
): void
Add message to conversation history
Parameters
Name | Type |
---|---|
message | UniversalMessage |
Returns
void
Implementation of
ConversationHistory.addMessage
Defined in
addUserMessage
▸ addUserMessage(content
, metadata?
): void
Add user message (convenience method)
Parameters
Name | Type |
---|---|
content | string |
metadata? | Record <string , any > |
Returns
void
Implementation of
ConversationHistory.addUserMessage
Defined in
addAssistantMessage
▸ addAssistantMessage(content
, functionCall?
, metadata?
): void
Add assistant message (convenience method)
Parameters
Name | Type |
---|---|
content | string |
functionCall? | any |
metadata? | Record <string , any > |
Returns
void
Implementation of
ConversationHistory.addAssistantMessage
Defined in
addSystemMessage
▸ addSystemMessage(content
, metadata?
): void
Add system message (convenience method)
Parameters
Name | Type |
---|---|
content | string |
metadata? | Record <string , any > |
Returns
void
Implementation of
ConversationHistory.addSystemMessage
Defined in
addToolMessage
▸ addToolMessage(toolResult
, metadata?
): void
Add tool execution result message (convenience method)
Parameters
Name | Type |
---|---|
toolResult | FunctionCallResult |
metadata? | Record <string , any > |
Returns
void
Implementation of
ConversationHistory.addToolMessage
Defined in
getMessages
▸ getMessages(): UniversalMessage
[]
Get all messages
Returns
Implementation of
ConversationHistory.getMessages
Defined in
getMessagesByRole
▸ getMessagesByRole(role
): UniversalMessage
[]
Get messages by specific role
Parameters
Name | Type |
---|---|
role | UniversalMessageRole |
Returns
Implementation of
ConversationHistory.getMessagesByRole
Defined in
getRecentMessages
▸ getRecentMessages(count
): UniversalMessage
[]
Get recent n messages
Parameters
Name | Type |
---|---|
count | number |
Returns
Implementation of
ConversationHistory.getRecentMessages
Defined in
getMessageCount
▸ getMessageCount(): number
Return message count
Returns
number
Implementation of
ConversationHistory.getMessageCount
Defined in
clear
▸ clear(): void
Clear conversation history
Returns
void