memory

Documentation

Overview

Package memory contains implementations for managing conversation data and facilitating the persistence of state between chain or agent calls.

Index

• type Combined
  • func NewCombined(memories ...schema.Memory) (*Combined, error)
  • func (m *Combined) Clear(ctx context.Context) error
  • func (m *Combined) LoadMemoryVariables(ctx context.Context, inputs map[string]any) (map[string]any, error)
  • func (m *Combined) MemoryKeys() []string
  • func (m *Combined) SaveContext(ctx context.Context, inputs map[string]any, outputs map[string]any) error
• type ConversationBuffer
  • func NewConversationBuffer(optFns ...func(o *ConversationBufferOptions)) *ConversationBuffer
  • func (m *ConversationBuffer) Clear(ctx context.Context) error
  • func (m *ConversationBuffer) LoadMemoryVariables(ctx context.Context, inputs map[string]any) (map[string]any, error)
  • func (m *ConversationBuffer) MemoryKeys() []string
  • func (m *ConversationBuffer) SaveContext(ctx context.Context, inputs map[string]any, outputs map[string]any) error
• type ConversationBufferOptions
• type ConversationTokenBuffer
  • func NewConversationTokenBuffer(tokenizer schema.Tokenizer, optFns ...func(o *ConversationTokenBufferOptions)) *ConversationTokenBuffer
  • func (m *ConversationTokenBuffer) Clear(ctx context.Context) error
  • func (m *ConversationTokenBuffer) LoadMemoryVariables(ctx context.Context, inputs map[string]any) (map[string]any, error)
  • func (m *ConversationTokenBuffer) MemoryKeys() []string
  • func (m *ConversationTokenBuffer) SaveContext(ctx context.Context, inputs map[string]any, outputs map[string]any) error
• type ConversationTokenBufferOptions
• type Readonly
  • func NewReadonly(memory schema.Memory) Readonly
  • func (m *Readonly) Clear(ctx context.Context) error
  • func (m *Readonly) LoadMemoryVariables(ctx context.Context, inputs map[string]any) (map[string]any, error)
  • func (m *Readonly) MemoryKeys() []string
  • func (m *Readonly) SaveContext(ctx context.Context, inputs map[string]any, outputs map[string]any) error
• type Simple
  • func NewSimple() Simple
  • func (m *Simple) Clear(ctx context.Context) error
  • func (m *Simple) LoadMemoryVariables(ctx context.Context, inputs map[string]any) (map[string]any, error)
  • func (m *Simple) MemoryKeys() []string
  • func (m *Simple) SaveContext(ctx context.Context, inputs map[string]any, outputs map[string]any) error

Types

type Combined

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

func NewCombined

func NewCombined(memories ...schema.Memory) (*Combined, error)

func (*Combined) Clear

func (m *Combined) Clear(ctx context.Context) error

func (*Combined) LoadMemoryVariables

func (m *Combined) LoadMemoryVariables(ctx context.Context, inputs map[string]any) (map[string]any, error)

func (*Combined) MemoryKeys

func (m *Combined) MemoryKeys() []string

func (*Combined) SaveContext

func (m *Combined) SaveContext(ctx context.Context, inputs map[string]any, outputs map[string]any) error

type ConversationBuffer

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

ConversationBuffer is a memory type that manages conversation buffers.

func NewConversationBuffer

func NewConversationBuffer(optFns ...func(o *ConversationBufferOptions)) *ConversationBuffer

NewConversationBuffer creates a new instance of ConversationBuffer memory type.

func (*ConversationBuffer) Clear

func (m *ConversationBuffer) Clear(ctx context.Context) error

Clear clears the chat message history.

func (*ConversationBuffer) LoadMemoryVariables

func (m *ConversationBuffer) LoadMemoryVariables(ctx context.Context, inputs map[string]any) (map[string]any, error)

LoadMemoryVariables returns key-value pairs given the text input to the chain.

func (*ConversationBuffer) MemoryKeys

func (m *ConversationBuffer) MemoryKeys() []string

MemoryKeys returns the memory keys for ConversationBuffer.

func (*ConversationBuffer) SaveContext

func (m *ConversationBuffer) SaveContext(ctx context.Context, inputs map[string]any, outputs map[string]any) error

SaveContext saves the input and output messages to the chat message history.

type ConversationBufferOptions

type ConversationBufferOptions struct {
	HumanPrefix        string
	AIPrefix           string
	MemoryKey          string
	InputKey           string
	OutputKey          string
	ReturnMessages     bool
	ChatMessageHistory schema.ChatMessageHistory

	// Size of the interactions window
	K uint
}

ConversationBufferOptions contains options for configuring the ConversationBuffer memory type.

type ConversationTokenBuffer

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

ConversationTokenBuffer is a memory type that manages conversation token buffers.

func NewConversationTokenBuffer

func NewConversationTokenBuffer(tokenizer schema.Tokenizer, optFns ...func(o *ConversationTokenBufferOptions)) *ConversationTokenBuffer

NewConversationTokenBuffer creates a new instance of ConversationTokenBuffer memory type.

func (*ConversationTokenBuffer) Clear

func (m *ConversationTokenBuffer) Clear(ctx context.Context) error

Clear clears the chat message history.

func (*ConversationTokenBuffer) LoadMemoryVariables

func (m *ConversationTokenBuffer) LoadMemoryVariables(ctx context.Context, inputs map[string]any) (map[string]any, error)

LoadMemoryVariables returns key-value pairs given the text input to the chain.

func (*ConversationTokenBuffer) MemoryKeys

func (m *ConversationTokenBuffer) MemoryKeys() []string

MemoryKeys returns the memory keys for ConversationTokenBuffer.

func (*ConversationTokenBuffer) SaveContext

func (m *ConversationTokenBuffer) SaveContext(ctx context.Context, inputs map[string]any, outputs map[string]any) error

SaveContext saves the input and output messages to the chat message history.

type ConversationTokenBufferOptions

type ConversationTokenBufferOptions struct {
	HumanPrefix        string
	AIPrefix           string
	MemoryKey          string
	InputKey           string
	OutputKey          string
	ReturnMessages     bool
	ChatMessageHistory schema.ChatMessageHistory

	MaxTokenLimit uint
}

ConversationTokenBufferOptions contains options for configuring the ConversationTokenBuffer memory type.

type Readonly

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

func NewReadonly

func NewReadonly(memory schema.Memory) Readonly

func (*Readonly) Clear

func (m *Readonly) Clear(ctx context.Context) error

func (*Readonly) LoadMemoryVariables

func (m *Readonly) LoadMemoryVariables(ctx context.Context, inputs map[string]any) (map[string]any, error)

func (*Readonly) MemoryKeys

func (m *Readonly) MemoryKeys() []string

func (*Readonly) SaveContext

func (m *Readonly) SaveContext(ctx context.Context, inputs map[string]any, outputs map[string]any) error

type Simple

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

func NewSimple

func NewSimple() Simple

func (*Simple) Clear

func (m *Simple) Clear(ctx context.Context) error

func (*Simple) LoadMemoryVariables

func (m *Simple) LoadMemoryVariables(ctx context.Context, inputs map[string]any) (map[string]any, error)

func (*Simple) MemoryKeys

func (m *Simple) MemoryKeys() []string

func (*Simple) SaveContext

func (m *Simple) SaveContext(ctx context.Context, inputs map[string]any, outputs map[string]any) error