index

Documentation

Index

• Constants
• Variables
• func DeepCopyMetadata(metadata types.Meta) types.Meta
• func GetDefaultOptions() *option.Options
• type AddDataCallback
• type Data
• type Embedder
• type Index
  • func New(vectorDB VectorDB, embedder Embedder) *Index
  • func (i *Index) Add(ctx context.Context, data *Data) error
  • func (i *Index) Drop(ctx context.Context) error
  • func (i *Index) Embedder() Embedder
  • func (i *Index) IsEmpty(ctx context.Context) (bool, error)
  • func (i *Index) LoadFromDocuments(ctx context.Context, documents []document.Document) error
  • func (i *Index) Query(ctx context.Context, query string, opts ...option.Option) (SearchResults, error)
  • func (i *Index) Search(ctx context.Context, values []float64, opts ...option.Option) (SearchResults, error)
  • func (i *Index) WithAddDataCallback(callback AddDataCallback) *Index
  • func (i *Index) WithBatchInsertSize(batchInsertSize int) *Index
  • func (i *Index) WithIncludeContents(includeContents bool) *Index
• type SearchResult
  • func (s *SearchResult) Content() string
• type SearchResults
  • func (s SearchResults) ToDocuments() []document.Document
• type VectorDB

Constants

const (
	DefaultKeyID      = "id"
	DefaultKeyContent = "content"
)

Variables

var (
	ErrInternal = errors.New("internal index error")
)

Functions

func DeepCopyMetadata

func DeepCopyMetadata(metadata types.Meta) types.Meta

func GetDefaultOptions

func GetDefaultOptions() *option.Options

Types

type AddDataCallback

type AddDataCallback func(data *Data) error

type Data

type Data struct {
	ID       string
	Values   []float64
	Metadata types.Meta
}

type Embedder

type Embedder interface {
	Embed(ctx context.Context, texts []string) ([]embedder.Embedding, error)
}

type Index

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

func New

func New(vectorDB VectorDB, embedder Embedder) *Index

func (*Index) Add

func (i *Index) Add(ctx context.Context, data *Data) error

func (*Index) Drop

func (i *Index) Drop(ctx context.Context) error

func (*Index) Embedder

func (i *Index) Embedder() Embedder

func (*Index) IsEmpty

func (i *Index) IsEmpty(ctx context.Context) (bool, error)

func (*Index) LoadFromDocuments

func (i *Index) LoadFromDocuments(ctx context.Context, documents []document.Document) error

func (*Index) Query

func (i *Index) Query(ctx context.Context, query string, opts ...option.Option) (SearchResults, error)

func (*Index) Search

func (i *Index) Search(ctx context.Context, values []float64, opts ...option.Option) (SearchResults, error)

func (*Index) WithAddDataCallback

func (i *Index) WithAddDataCallback(callback AddDataCallback) *Index

WithAddDataCallback allows to modify the data before it is added to the index. This can be useful to add additional metadata to the vector.

func (*Index) WithBatchInsertSize

func (i *Index) WithBatchInsertSize(batchInsertSize int) *Index

func (*Index) WithIncludeContents

func (i *Index) WithIncludeContents(includeContents bool) *Index

type SearchResult

type SearchResult struct {
	Data
	Score float64
}

func (*SearchResult) Content

func (s *SearchResult) Content() string

type SearchResults

type SearchResults []SearchResult

func (SearchResults) ToDocuments

func (s SearchResults) ToDocuments() []document.Document

type VectorDB

type VectorDB interface {
	Insert(context.Context, []Data) error
	IsEmpty(context.Context) (bool, error)
	Search(context.Context, []float64, *option.Options) (SearchResults, error)
	Drop(ctx context.Context) error
	Delete(ctx context.Context, ids []string) error
}