memory

package module

v0.4.0 Latest Latest Go to latest Published: May 5, 2023 License: MIT Imports: 5 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/chand1012/memory

Links

Open Source Insights

Documentation ¶

Index ¶

type Memory
- func New(path string) (*Memory, bool, error)
type MemoryFragment

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

This section is empty.

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 ¶ added in v0.3.0

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 ¶ added in v0.4.0

func SortByAverage(fragments []MemoryFragment) []MemoryFragment

func SortByScore ¶ added in v0.4.0

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

Source Files ¶

View all Source files

Directories ¶

Path	Synopsis
chatsort

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL