Class OpenAIAgentTokenBufferMemory

Memory used to save agent output and intermediate steps.

Hierarchy

BaseChatMemory
- OpenAIAgentTokenBufferMemory

Index

Constructors

Properties

aiPrefix chatHistory humanPrefix intermediateStepsKey llm maxTokenLimit memoryKey outputKey returnMessages inputKey?

Accessors

Methods

clear getMessages loadMemoryVariables saveContext

Constructors

constructor

new OpenAIAgentTokenBufferMemory(fields): OpenAIAgentTokenBufferMemory
Parameters
- fields: OpenAIAgentTokenBufferMemoryFields
Returns OpenAIAgentTokenBufferMemory
Overrides BaseChatMemory.constructor
- Defined in docs/api_refs/langchain/src/agents/toolkits/conversational_retrieval/token_buffer_memory.ts:51

Properties

aiPrefix

aiPrefix: string = "AI"

chatHistory

chatHistory: BaseChatMessageHistory

humanPrefix

humanPrefix: string = "Human"

intermediateStepsKey

intermediateStepsKey: string = "intermediateSteps"

llm

llm: ChatOpenAI<ChatOpenAICallOptions>

maxTokenLimit

maxTokenLimit: number = 12000

memoryKey

memoryKey: string = "history"

outputKey

outputKey: string = "output"

returnMessages

returnMessages: boolean = true

`Optional` inputKey

inputKey?: string

Accessors

memoryKeys

get memoryKeys(): string[]
Returns string[]
Overrides BaseChatMemory.memoryKeys
- Defined in docs/api_refs/langchain/src/agents/toolkits/conversational_retrieval/token_buffer_memory.ts:64

Methods

clear

clear(): Promise<void>
Method to clear the chat history.

Returns Promise<void>
Promise that resolves when the chat history has been cleared.
Inherited from BaseChatMemory.clear
- Defined in docs/api_refs/langchain/src/memory/chat_memory.ts:67

getMessages

getMessages(): Promise<BaseMessage[]>
Retrieves the messages from the chat history.

Returns Promise<BaseMessage[]>
Promise that resolves with the messages from the chat history.
- Defined in docs/api_refs/langchain/src/agents/toolkits/conversational_retrieval/token_buffer_memory.ts:72

loadMemoryVariables

loadMemoryVariables(_values): Promise<MemoryVariables>
Loads memory variables from the input values.
Parameters
- _values: InputValues
  
  Input values.
Returns Promise<MemoryVariables>
Promise that resolves with the loaded memory variables.
Overrides BaseChatMemory.loadMemoryVariables
- Defined in docs/api_refs/langchain/src/agents/toolkits/conversational_retrieval/token_buffer_memory.ts:81

saveContext

saveContext(inputValues, outputValues): Promise<void>
Saves the context of the chat, including user input, AI output, and intermediate steps. Prunes the chat history if the total token count exceeds the maximum limit.
Parameters
- inputValues: InputValues
  
  Input values.
- outputValues: OutputValues
  
  Output values.
Returns Promise<void>
Promise that resolves when the context has been saved.
Overrides BaseChatMemory.saveContext
- Defined in docs/api_refs/langchain/src/agents/toolkits/conversational_retrieval/token_buffer_memory.ts:103

Generated using TypeDoc