memory

type ChatMessageHistory struct {
	// contains filtered or unexported fields
}

type ConversationBufferMemory struct {
	// ChatHistory is the backing message store.
	ChatHistory *ChatMessageHistory

	// MemoryKey is the key used to store/retrieve messages. Default: "history".
	MemoryKey string

	// InputKey is the key for the human input. Default: "input".
	InputKey string

	// OutputKey is the key for the AI output. Default: "output".
	OutputKey string

	// ReturnMessages controls whether to return messages or a formatted string.
	ReturnMessages bool

	// HumanPrefix is the prefix for human messages in string output.
	HumanPrefix string

	// AIPrefix is the prefix for AI messages in string output.
	AIPrefix string

	// MaxMessages is the maximum number of messages to retain in history.
	// 0 means unlimited. When exceeded, the oldest messages are dropped.
	MaxMessages int
}

type ConversationWindowMemory struct {
	// ChatHistory is the backing message store.
	ChatHistory *ChatMessageHistory

	// K is the number of recent conversation turns (pairs of messages) to keep.
	K int

	// MemoryKey is the key used to store/retrieve messages. Default: "history".
	MemoryKey string

	// InputKey is the key for the human input.
	InputKey string

	// OutputKey is the key for the AI output.
	OutputKey string

	// ReturnMessages controls whether to return messages or a formatted string.
	ReturnMessages bool

	// HumanPrefix is the prefix for human messages in string output.
	HumanPrefix string

	// AIPrefix is the prefix for AI messages in string output.
	AIPrefix string
}

type Memory interface {
	// MemoryVariables returns the keys this memory will add to chain inputs.
	MemoryVariables() []string

	// LoadMemoryVariables returns key-value pairs to be added to chain inputs.
	LoadMemoryVariables(ctx context.Context, inputs map[string]any) (map[string]any, error)

	// SaveContext saves the input and output of a chain run to memory.
	SaveContext(ctx context.Context, inputs map[string]any, outputs map[string]any) error

	// Clear resets the memory.
	Clear(ctx context.Context) error
}