localvec

Documentation

Overview

Package localvec is a local vector database for development and testing. The database is stored in a file in the local file system. Production code should use a real vector database.

Index

• func DefineIndexerAndRetriever(name string, cfg Config) (ai.Indexer, ai.Retriever, error)
• func Indexer(name string) ai.Indexer
• func Init() error
• func IsDefinedIndexer(name string) bool
• func IsDefinedRetriever(name string) bool
• func Retriever(name string) ai.Retriever
• type Config
• type RetrieverOptions

Functions

func DefineIndexerAndRetriever

func DefineIndexerAndRetriever(name string, cfg Config) (ai.Indexer, ai.Retriever, error)

DefineIndexerAndRetriever defines an Indexer and Retriever that share the same underlying storage. The name uniquely identifies the the Indexer and Retriever in the registry.

func Indexer

func Indexer(name string) ai.Indexer

Indexer returns the registered indexer with the given name.

func Init

func Init() error

Init initializes the plugin.

func IsDefinedIndexer

func IsDefinedIndexer(name string) bool

IsDefinedIndexer reports whether the named Indexer is defined by this plugin.

func IsDefinedRetriever

func IsDefinedRetriever(name string) bool

IsDefinedRetriever reports whether the named Retriever is defined by this plugin.

func Retriever

func Retriever(name string) ai.Retriever

Retriever returns the retriever with the given name. The name must match the [Config.Name] value passed to Init.

Types

type Config

type Config struct {
	// Where to store the data. Defaults to os.TempDir.
	Dir             string
	Embedder        ai.Embedder
	EmbedderOptions any
}

type RetrieverOptions

type RetrieverOptions struct {
	K int `json:"k,omitempty"` // number of entries to return
}

RetrieverOptions may be passed in the Options field of ai.RetrieverRequest to pass options to the retriever. The Options field should be either nil or a value of type *RetrieverOptions.