core / Exports / ConversationHistory
Interface: ConversationHistory
Conversation history interface
Interface for managing conversation history, designed in a neutral form independent of AI Provider
Implemented by
Table of contents
Methods
- addMessage
- addUserMessage
- addAssistantMessage
- addSystemMessage
- addToolMessage
- getMessages
- getMessagesByRole
- getRecentMessages
- clear
- getMessageCount
Methods
addMessage
▸ addMessage(message): void
Add message to conversation history
Parameters
| Name | Type |
|---|---|
message | UniversalMessage |
Returns
void
Defined in
addUserMessage
▸ addUserMessage(content, metadata?): void
Add user message (convenience method)
Parameters
| Name | Type |
|---|---|
content | string |
metadata? | Record<string, any> |
Returns
void
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
Defined in
addSystemMessage
▸ addSystemMessage(content, metadata?): void
Add system message (convenience method)
Parameters
| Name | Type |
|---|---|
content | string |
metadata? | Record<string, any> |
Returns
void
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
Defined in
getMessages
▸ getMessages(): UniversalMessage[]
Get all messages
Returns
Defined in
getMessagesByRole
▸ getMessagesByRole(role): UniversalMessage[]
Get messages by specific role
Parameters
| Name | Type |
|---|---|
role | UniversalMessageRole |
Returns
Defined in
getRecentMessages
▸ getRecentMessages(count): UniversalMessage[]
Get recent n messages
Parameters
| Name | Type |
|---|---|
count | number |
Returns
Defined in
clear
▸ clear(): void
Clear conversation history
Returns
void
Defined in
getMessageCount
▸ getMessageCount(): number
Return message count
Returns
number