Skip to content

agents / Exports / ConversationSession

Class: ConversationSession

Conversation Session for a single conversation/session with enhanced features

Implements ConversationHistoryInterface with additional features like duplicate prevention and API format conversion.

Implements

  • ConversationHistoryInterface

Table of contents

Constructors

Methods

Constructors

constructor

new ConversationSession(maxMessages?): ConversationSession

Parameters

NameTypeDefault value
maxMessagesnumber100

Returns

ConversationSession

Defined in

packages/agents/src/managers/conversation-history-manager.ts:585

Methods

addMessage

addMessage(message): void

Add any message to history

Parameters

NameType
messageTUniversalMessage

Returns

void

Implementation of

ConversationHistoryInterface.addMessage

Defined in

packages/agents/src/managers/conversation-history-manager.ts:592


addUserMessage

addUserMessage(content, metadata?): void

Add user message

Parameters

NameType
contentstring
metadata?TUniversalMessageMetadata

Returns

void

Implementation of

ConversationHistoryInterface.addUserMessage

Defined in

packages/agents/src/managers/conversation-history-manager.ts:599


addAssistantMessage

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

Add assistant message with optional tool calls

Parameters

NameType
contentnull | string
toolCalls?IToolCall[]
metadata?TUniversalMessageMetadata

Returns

void

Implementation of

ConversationHistoryInterface.addAssistantMessage

Defined in

packages/agents/src/managers/conversation-history-manager.ts:606


addSystemMessage

addSystemMessage(content, metadata?): void

Add system message

Parameters

NameType
contentstring
metadata?TUniversalMessageMetadata

Returns

void

Implementation of

ConversationHistoryInterface.addSystemMessage

Defined in

packages/agents/src/managers/conversation-history-manager.ts:617


addToolMessage

addToolMessage(content, toolCallId, toolName?, metadata?): void

Add tool result message

Parameters

NameType
contentstring
toolCallIdstring
toolName?string
metadata?TUniversalMessageMetadata

Returns

void

Defined in

packages/agents/src/managers/conversation-history-manager.ts:624


addToolMessageWithId

addToolMessageWithId(content, toolCallId, toolName, metadata?): void

Add tool execution result message with tool call ID (for tool calling format) High-level API matching core package with duplicate prevention

Throws error if a tool message with the same toolCallId already exists.

Parameters

NameType
contentstring
toolCallIdstring
toolNamestring
metadata?TUniversalMessageMetadata

Returns

void

Implementation of

ConversationHistoryInterface.addToolMessageWithId

Defined in

packages/agents/src/managers/conversation-history-manager.ts:634


getMessages

getMessages(): TUniversalMessage[]

Get all messages in chronological order

Returns

TUniversalMessage[]

Implementation of

ConversationHistoryInterface.getMessages

Defined in

packages/agents/src/managers/conversation-history-manager.ts:651


getMessagesByRole

getMessagesByRole(role): TUniversalMessage[]

Get messages filtered by specific role

Parameters

NameType
roleTUniversalMessageRole

Returns

TUniversalMessage[]

Implementation of

ConversationHistoryInterface.getMessagesByRole

Defined in

packages/agents/src/managers/conversation-history-manager.ts:658


getRecentMessages

getRecentMessages(count): TUniversalMessage[]

Get the most recent n messages

Parameters

NameType
countnumber

Returns

TUniversalMessage[]

Implementation of

ConversationHistoryInterface.getRecentMessages

Defined in

packages/agents/src/managers/conversation-history-manager.ts:665


getMessagesForAPI

getMessagesForAPI(): APIMessage[]

Get messages formatted for API consumption

Returns

APIMessage[]

Defined in

packages/agents/src/managers/conversation-history-manager.ts:672


getMessageCount

getMessageCount(): number

Get total message count

Returns

number

Implementation of

ConversationHistoryInterface.getMessageCount

Defined in

packages/agents/src/managers/conversation-history-manager.ts:694


clear

clear(): void

Clear all conversation history

Returns

void

Implementation of

ConversationHistoryInterface.clear

Defined in

packages/agents/src/managers/conversation-history-manager.ts:701

Released under the MIT License.