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 Index(ctx context.Context, docs []*ai.Document, ds *DocStore) error
• func Init() error
• func IsDefinedRetriever(g *genkit.Genkit, name string) bool
• func Retriever(g *genkit.Genkit, name string) ai.Retriever
• type Config
• type DbValue
• type DocStore
  • func DefineRetriever(g *genkit.Genkit, name string, cfg Config, opts *ai.RetrieverOptions) (*DocStore, ai.Retriever, error)
• type RetrieverOptions

Functions

func Index

func Index(ctx context.Context, docs []*ai.Document, ds *DocStore) error

Helper function to get started with indexing

func Init

func Init() error

Init initializes the plugin.

func IsDefinedRetriever

func IsDefinedRetriever(g *genkit.Genkit, name string) bool

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

func Retriever

func Retriever(g *genkit.Genkit, 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 DbValue

type DbValue struct {
	Doc       *ai.Document `json:"doc"`
	Embedding []float32    `json:"embedding"`
}

DbValue is the type of a document stored in the database.

type DocStore

type DocStore struct {
	Filename        string
	Embedder        ai.Embedder
	EmbedderOptions any
	Data            map[string]DbValue
}

DocStore implements a local vector database. This is based on js/plugins/dev-local-vectorstore/src/index.ts.

func DefineRetriever

func DefineRetriever(g *genkit.Genkit, name string, cfg Config, opts *ai.RetrieverOptions) (*DocStore, ai.Retriever, error)

DefineRetriever defines a Retriever and docStore which is also used by the retriever. The name uniquely identifies the Retriever in the registry.

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.