Class ConversationHistory`Internal`

The request options for a conversation.

This class is used internally by the library and is not meant to be instantiated by consumers of the library.

Hierarchy

ConversationHistory

Constructors

constructor

new ConversationHistory(pluginService, config, options?): ConversationHistory
Parameters
- pluginService: ConversationPluginService<ConversationPlugin<string, any, any>[]>
- config: ConversationConfig
- options: {
  messages?: ({ role: "function" | "user" | "assistant" | "system"; content: string | null; id?: string | undefined; name?: string | undefined; function_call?: { name: string; arguments: Record<string, any>; } | undefined; model?: string | undefined; flags?: string[] | ... 1 more ... | undefined; })[];
  } = {}
  - Optional messages?: ({ role: "function" | "user" | "assistant" | "system"; content: string | null; id?: string | undefined; name?: string | undefined; function_call?: { name: string; arguments: Record<string, any>; } | undefined; model?: string | undefined; flags?: string[] | ... 1 more ... | undefined; })[]
Returns ConversationHistory
- Defined in packages/lib/src/classes/ConversationHistory.ts:26

Properties

`Private` addMessageEvents

addMessageEvents: EventManager<AddMessageListener> = ...

`Private` `Readonly` config

config: ConversationConfig

`Private` messages

messages: Message[] = []

`Private` `Readonly` pluginService

pluginService: ConversationPluginService<ConversationPlugin<string, any, any>[]>

`Private` removeMessageEvents

removeMessageEvents: EventManager<RemoveMessageListener> = ...

Methods

addAssistantMessage

addAssistantMessage(message): Message
Adds a message with the role of "assistant" to the conversation.
Parameters
- message: string
  
  The content of the message.
Returns Message
The Message object that was added to the conversation
- Defined in packages/lib/src/classes/ConversationHistory.ts:143

addFunctionCallMessage

addFunctionCallMessage(functionCall): Message
Adds a message with the role of "assistant" to the conversation with the function call generated by the assistant.
Parameters
- functionCall: {
  arguments: Record<string, any>;
  name: string;
  }
  
  The name and arguments of the function to call, generated by the assistant.
  - arguments: Record<string, any>
  - name: string
Returns Message
The Message object that was added to the conversation
- Defined in packages/lib/src/classes/ConversationHistory.ts:175

addFunctionMessage

addFunctionMessage(message, name): Message
Adds a message with the role of "function" to the conversation with the content being the return value of the function call, called by your own code.
Parameters
- message: string
  
  The return value of the function call, stringified if needed.
- name: string
  
  The name of the function that was called.
Returns Message
The Message object that was added to the conversation
- Defined in packages/lib/src/classes/ConversationHistory.ts:198

addMessage

addMessage(message): Message
Adds a message to the conversation.
Parameters
- message: Message
  
  The message instance to add to the conversation.
Returns Message
The added message.

Remarks
This method is mostly meant to be internal, but exposed for convenience. You should use the addAssistantMessage, addUserMessage, addFunctionCallMessage, or addFunctionMessage methods when possible.
- Defined in packages/lib/src/classes/ConversationHistory.ts:103

`Private` addSystemMessage

addSystemMessage(message): Message
Parameters
- message: string
Returns Message
- Defined in packages/lib/src/classes/ConversationHistory.ts:272

addUserMessage

addUserMessage(message): Message
Adds a message with the role of "user" to the conversation.
Parameters
- message: string
  
  The content of the message.
Returns Message
The Message object that was added to the conversation
- Defined in packages/lib/src/classes/ConversationHistory.ts:161

clearMessages

clearMessages(): void
Clears all messages in the conversation except the context message, if it is set.

Returns void
- Defined in packages/lib/src/classes/ConversationHistory.ts:244

getContext

getContext(): null | string
Returns the context message content, if it is set.

Returns null | string
- Defined in packages/lib/src/classes/ConversationHistory.ts:223

getCreateChatCompletionMessages

getCreateChatCompletionMessages(): (CreateChatCompletionMessage | CreateChatCompletionFunctionCallMessage | CreateChatCompletionFunctionMessage)[]
Returns the messages in a format OpenAI's Chat Completion API can understand.

Returns (CreateChatCompletionMessage | CreateChatCompletionFunctionCallMessage | CreateChatCompletionFunctionMessage)[]
- Defined in packages/lib/src/classes/ConversationHistory.ts:268

getMessages

getMessages(includeContext?): Message[]
Get the messages in the conversation.
Parameters
- includeContext: boolean = false
  
  Whether to include the context message in the returned array.
Returns Message[]
A shallow copy of the messages array.
- Defined in packages/lib/src/classes/ConversationHistory.ts:236

offMessageAdded

offMessageAdded(listener): void
Removes a listener function from the list of listeners that was previously added with onMessageAdded.
Parameters
- listener: AddMessageListener
  
  The function to remove from the list of listeners.
Returns void
- Defined in packages/lib/src/classes/ConversationHistory.ts:302

offMessageRemoved

offMessageRemoved(listener): void
Removes a listener function from the list of listeners that was previously added with onMessageRemoved.
Parameters
- listener: RemoveMessageListener
  
  The function to remove from the list of listeners.
Returns void
- Defined in packages/lib/src/classes/ConversationHistory.ts:331

onMessageAdded

onMessageAdded(listener): (() => void)
Adds a listener function that is called whenever a message is added to the conversation.
Parameters
- listener: AddMessageListener
  
  The function to call when a message is added to the conversation.
Returns (() => void)
A function that removes the listener from the list of listeners.
- - (): void
  - Returns void
- Defined in packages/lib/src/classes/ConversationHistory.ts:283

onMessageRemoved

onMessageRemoved(listener): (() => void)
Adds a listener function that is called whenever a message is removed to the conversation.
Parameters
- listener: RemoveMessageListener
  
  The function to call when a message is removed to the conversation.
Returns (() => void)
A function that removes the listener from the list of listeners.
- - (): void
  - Returns void
- Defined in packages/lib/src/classes/ConversationHistory.ts:312

onceMessageAdded

onceMessageAdded(listener): (() => void)
Adds a listener function that is called only once whenever a message is added to the conversation.
Parameters
- listener: AddMessageListener
  
  The function to call when a message is added to the conversation.
Returns (() => void)
A function that removes the listener from the list of listeners.
- - (): void
  - Returns void
- Defined in packages/lib/src/classes/ConversationHistory.ts:293

onceMessageRemoved

onceMessageRemoved(listener): (() => void)
Adds a listener function that is called only once whenever a message is removed to the conversation.
Parameters
- listener: RemoveMessageListener
  
  The function to call when a message is removed to the conversation.
Returns (() => void)
A function that removes the listener from the list of listeners.
- - (): void
  - Returns void
- Defined in packages/lib/src/classes/ConversationHistory.ts:322

removeMessage

removeMessage(message): void
Removes a message from the conversation's history.
Parameters
- message: string | Message
  
  Either the ID of the message to remove, or the message object itself (where the ID will be extracted from).
Returns void
- Defined in packages/lib/src/classes/ConversationHistory.ts:257

setContext

setContext(context): void
Sets the first message sent to the OpenAI API with the role of "system". This gives context the Chat Completion and can be used to customize its behavior.
Parameters
- context: string
  
  The content of the system message.
Returns void
- Defined in packages/lib/src/classes/ConversationHistory.ts:216

toJSON

toJSON(): {
messages?: ({ role: "function" | "user" | "assistant" | "system"; content: string | null; id?: string | undefined; name?: string | undefined; function_call?: { name: string; arguments: Record<string, any>; } | undefined; model?: string | undefined; flags?: string[] | ... 1 more ... | undefined; })[];
}
Internal
Serializes the ConversationHistory to JSON.

Returns {
messages?: ({ role: "function" | "user" | "assistant" | "system"; content: string | null; id?: string | undefined; name?: string | undefined; function_call?: { name: string; arguments: Record<string, any>; } | undefined; model?: string | undefined; flags?: string[] | ... 1 more ... | undefined; })[];
}
A JSON representation of the ConversationHistory instance.

This method is used internally by the library and is not meant to be used by consumers of the library.
- Optional messages?: ({ role: "function" | "user" | "assistant" | "system"; content: string | null; id?: string | undefined; name?: string | undefined; function_call?: { name: string; arguments: Record<string, any>; } | undefined; model?: string | undefined; flags?: string[] | ... 1 more ... | undefined; })[]
- Defined in packages/lib/src/classes/ConversationHistory.ts:78

Class ConversationHistoryInternal

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

pluginService: ConversationPluginService<ConversationPlugin<string, any, any>[]>

config: ConversationConfig

Returns ConversationHistory

Properties

Private addMessageEvents

Private Readonly config

Private messages

Private Readonly pluginService

Private removeMessageEvents

Methods

addAssistantMessage

Parameters

message: string

Returns Message

addFunctionCallMessage

Parameters

functionCall: { arguments: Record<string, any>; name: string; }

arguments: Record<string, any>

name: string

Returns Message

addFunctionMessage

Parameters

message: string

name: string

Returns Message

addMessage

Parameters

message: Message

Returns Message

Remarks

Private addSystemMessage

Parameters

message: string

Returns Message

addUserMessage

Parameters

message: string

Returns Message

clearMessages

Returns void

getContext

Returns null | string

getCreateChatCompletionMessages

Returns (CreateChatCompletionMessage | CreateChatCompletionFunctionCallMessage | CreateChatCompletionFunctionMessage)[]

getMessages

Parameters

includeContext: boolean = false

Returns Message[]

offMessageAdded

Parameters

listener: AddMessageListener

Returns void

offMessageRemoved

Parameters

listener: RemoveMessageListener

Returns void

onMessageAdded

Parameters

listener: AddMessageListener

Returns (() => void)

Returns void

onMessageRemoved

Parameters

listener: RemoveMessageListener

Returns (() => void)

Returns void

onceMessageAdded

Parameters

listener: AddMessageListener

Returns (() => void)

Returns void

Class ConversationHistory`Internal`

`Private` addMessageEvents

`Private` `Readonly` config

`Private` messages

`Private` `Readonly` pluginService

`Private` removeMessageEvents

functionCall: {
arguments: Record<string, any>;
name: string;
}

`Private` addSystemMessage