memory

Memory maintains Chain state, incorporating context from past runs.

Class hierarchy for Memory:

BaseMemory --> BaseChatMemory --> <name>Memory  # Examples: ZepMemory, MotorheadMemory

Main helpers:

BaseChatMessageHistory

Chat Message History stores the chat message history in different stores.

Class hierarchy for ChatMessageHistory:

BaseChatMessageHistory --> <name>ChatMessageHistory  # Example: ZepChatMessageHistory

Main helpers:

AIMessage, BaseMessage, HumanMessage

Classes

memory.buffer.ConversationBufferMemory	Buffer for storing conversation memory.
memory.buffer.ConversationStringBufferMemory	Buffer for storing conversation memory.
memory.buffer_window.ConversationBufferWindowMemory	Buffer for storing conversation memory inside a limited size window.
memory.chat_memory.BaseChatMemory	Abstract base class for chat memory.
memory.combined.CombinedMemory	Combining multiple memories' data together.
memory.entity.BaseEntityStore	Abstract base class for Entity store.
memory.entity.ConversationEntityMemory	Entity extractor & summarizer memory.
memory.entity.InMemoryEntityStore	In-memory Entity store.
memory.entity.RedisEntityStore	Redis-backed Entity store.
memory.entity.SQLiteEntityStore	SQLite-backed Entity store
memory.entity.UpstashRedisEntityStore	Upstash Redis backed Entity store.
memory.readonly.ReadOnlySharedMemory	Memory wrapper that is read-only and cannot be changed.
memory.simple.SimpleMemory	Simple memory for storing context or other information that shouldn't ever change between prompts.
memory.summary.ConversationSummaryMemory	Conversation summarizer to chat memory.
memory.summary.SummarizerMixin	Mixin for summarizer.
memory.summary_buffer.ConversationSummaryBufferMemory	Buffer with summarizer for storing conversation memory.
memory.token_buffer.ConversationTokenBufferMemory	Conversation chat memory with token limit.
memory.vectorstore.VectorStoreRetrieverMemory	VectorStoreRetriever-backed memory.
memory.vectorstore_token_buffer_memory.ConversationVectorStoreTokenBufferMemory	Conversation chat memory with token limit and vectordb backing.

Functions

memory.utils.get_prompt_input_key(inputs, ...)

Get the prompt input key.