Class BaseConversationSummaryMemoryAbstract

Abstract class that provides a structure for storing and managing the memory of a conversation. It includes methods for predicting a new summary for the conversation given the existing messages and summary.

Hierarchy (view full)

Constructors

constructor

Properties

aiPrefix chatHistory humanPrefix llm memoryKey prompt returnMessages summaryChatMessageClass inputKey? outputKey?

Methods

clear predictNewSummary saveContext

Constructors

constructor

Properties

aiPrefix

aiPrefix: string = "AI"

chatHistory

chatHistory: BaseChatMessageHistory

humanPrefix

humanPrefix: string = "Human"

llm

llm: BaseLanguageModelInterface<any, BaseLanguageModelCallOptions>

memoryKey

memoryKey: string = "history"

prompt

prompt: BasePromptTemplate<any, BasePromptValueInterface, any> = SUMMARY_PROMPT

returnMessages

returnMessages: boolean = false

summaryChatMessageClass

summaryChatMessageClass: (new (content) => BaseMessage) = SystemMessage

Type declaration

    • new (content): BaseMessage

    • Parameters

      • content: string

      Returns BaseMessage

Optional inputKey

inputKey?: string

Optional outputKey

outputKey?: string

Methods

clear

predictNewSummary

  • predictNewSummary(messages, existingSummary): Promise<string>

  • Predicts a new summary for the conversation given the existing messages and summary.

    Parameters

    • messages: BaseMessage[]

      Existing messages in the conversation.

    • existingSummary: string

      Current summary of the conversation.

    Returns Promise<string>

    A promise that resolves to a new summary string.

saveContext

  • saveContext(inputValues, outputValues): Promise<void>

  • Method to add user and AI messages to the chat history in sequence.

    Parameters

    • inputValues: InputValues

      The input values from the user.

    • outputValues: OutputValues

      The output values from the AI.

    Returns Promise<void>

    Promise that resolves when the context has been saved.

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc