memory

Documentation

Index

• type Memory
  • func New(path string) (*Memory, bool, error)
  • func (m *Memory) Add(id string, content string) error
  • func (m *Memory) Close() error
  • func (m *Memory) Destroy() error
  • func (m *Memory) IsIndexed(id string) (bool, error)
  • func (m *Memory) Search(query string) ([]MemoryFragment, error)
• type MemoryFragment
  • func SortByAverage(fragments []MemoryFragment) []MemoryFragment
  • func SortByScore(fragments []MemoryFragment) []MemoryFragment
  • func TopFragmentAvg(fragments []MemoryFragment) MemoryFragment
  • func TopFragmentScore(fragments []MemoryFragment) MemoryFragment

Types

type Memory

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

func New

func New(path string) (*Memory, bool, error)

New creates a new memory index if one does not exist at the given path. If one does exist, it opens it. Specify ":memory:" as the path to create a new in-memory index.

func (*Memory) Add

func (m *Memory) Add(id string, content string) error

Add adds a new memory fragment to the index

func (*Memory) Close

func (m *Memory) Close() error

Close closes the index

func (*Memory) Destroy

func (m *Memory) Destroy() error

Destroy closes the index and deletes the index file

func (*Memory) IsIndexed

func (m *Memory) IsIndexed(id string) (bool, error)

IsIndexed returns true if the given ID is indexed

func (*Memory) Search

func (m *Memory) Search(query string) ([]MemoryFragment, error)

Search searches the index for the given query

type MemoryFragment

type MemoryFragment struct {
	ID    string
	Score float64
	Avg   float64
}

func SortByAverage

func SortByAverage(fragments []MemoryFragment) []MemoryFragment

func SortByScore

func SortByScore(fragments []MemoryFragment) []MemoryFragment

func TopFragmentAvg

func TopFragmentAvg(fragments []MemoryFragment) MemoryFragment

TopFragmentAvg returns the fragment with the highest average score

func TopFragmentScore

func TopFragmentScore(fragments []MemoryFragment) MemoryFragment

TopFragmentScore returns the fragment with the highest score