memory

Documentation

Overview

Package memory defines conversation memory and provides a concurrent buffer implementation.

Index

• type BufferMemory
  • func NewBufferMemory(capacity int) *BufferMemory
  • func (m *BufferMemory) Add(msg types.Message)
  • func (m *BufferMemory) Clear()
  • func (m *BufferMemory) Get(index int) (types.Message, bool)
  • func (m *BufferMemory) Len() int
  • func (m *BufferMemory) Recent(n int) []types.Message
  • func (m *BufferMemory) Snapshot() []types.Message
• type Memory
• type SummaryMemory
  • func NewSummaryMemory(keepRecent int) *SummaryMemory
  • func (m *SummaryMemory) Add(message types.Message)
  • func (m *SummaryMemory) Clear()
  • func (m *SummaryMemory) Compact(summary string)
  • func (m *SummaryMemory) Get(index int) (types.Message, bool)
  • func (m *SummaryMemory) Len() int
  • func (m *SummaryMemory) Recent(count int) []types.Message
  • func (m *SummaryMemory) Restore(summary string, messages []types.Message)
  • func (m *SummaryMemory) Snapshot() []types.Message
  • func (m *SummaryMemory) Summary() string

Types

type BufferMemory

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

func NewBufferMemory

func NewBufferMemory(capacity int) *BufferMemory

func (*BufferMemory) Add

func (m *BufferMemory) Add(msg types.Message)

func (*BufferMemory) Clear

func (m *BufferMemory) Clear()

func (*BufferMemory) Get

func (m *BufferMemory) Get(index int) (types.Message, bool)

func (*BufferMemory) Len

func (m *BufferMemory) Len() int

func (*BufferMemory) Recent

func (m *BufferMemory) Recent(n int) []types.Message

func (*BufferMemory) Snapshot

func (m *BufferMemory) Snapshot() []types.Message

type Memory

type Memory interface {
	Add(msg types.Message)
	Get(index int) (types.Message, bool)
	Recent(n int) []types.Message
	Snapshot() []types.Message
	Clear()
	Len() int
}

type SummaryMemory

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

SummaryMemory retains raw messages until the engine supplies a successful summary. It never silently discards history at its hard limit.

func NewSummaryMemory

func NewSummaryMemory(keepRecent int) *SummaryMemory

func (*SummaryMemory) Add

func (m *SummaryMemory) Add(message types.Message)

func (*SummaryMemory) Clear

func (m *SummaryMemory) Clear()

func (*SummaryMemory) Compact

func (m *SummaryMemory) Compact(summary string)

Compact installs a caller-produced summary only after it has succeeded and retains the configured recent raw messages.

func (*SummaryMemory) Get

func (m *SummaryMemory) Get(index int) (types.Message, bool)

func (*SummaryMemory) Len

func (m *SummaryMemory) Len() int

func (*SummaryMemory) Recent

func (m *SummaryMemory) Recent(count int) []types.Message

func (*SummaryMemory) Restore

func (m *SummaryMemory) Restore(summary string, messages []types.Message)

func (*SummaryMemory) Snapshot

func (m *SummaryMemory) Snapshot() []types.Message

func (*SummaryMemory) Summary

func (m *SummaryMemory) Summary() string