reliquary

Jul 22, 2026

Changes in this version

type App

+ func (a *App) SearchBatch(ctx context.Context, queries []string, opts ...SearchOption) ([][]*retrieval.Result, error)

type SearchOption

+ func WithExplain() SearchOption

+ func WithRRF(k float64) SearchOption

+ func WithReranker(r retrieval.Reranker) SearchOption

Jul 21, 2026

Changes in this version

+ var ErrDuplicateDocumentID = indexcontract.ErrDuplicateDocumentID

+ var ErrInvalidDocumentID = indexcontract.ErrInvalidDocumentID

+ var ErrResultIDConflict = indexcontract.ErrResultIDConflict

+ type DocumentReplacement = indexcontract.DocumentReplacement

Jul 12, 2026

retracted

Changes in this version

+ var ErrIdentityMismatch = indexcontract.ErrIdentityMismatch

+ var ErrInvalidIndexIdentity = errors.New("reliquary: index identity must not be empty")

+ var ErrResetUnsupported = errors.New("reliquary: index does not support reset")

type App

+ func (a *App) ResetIndex(ctx context.Context) error

+ type Index = indexcontract.Index

+ func NewMemoryIndex() Index

+ type IndexQuery = indexcontract.IndexQuery

type Option

+ func WithIndex(index Index) Option

+ func WithIndexIdentity(identity string) Option

type SearchOption

+ func CandidateLimit(n int) SearchOption

+ func WithFilter(filter map[string]any) SearchOption

Jul 11, 2026

retracted

Changes in this version

+ var ErrNilApp = errors.New("reliquary: nil app")

+ var ErrNoEmbedder = errors.New("reliquary: an embedder is required (use WithEmbedder)")

+ type App struct

+ func InMemory(dim int) *App

+ func New(opts ...Option) (*App, error)

+ func Quickstart() *App

+ func (a *App) Ingest(ctx context.Context, docs ...document.Document) (int, error)

+ func (a *App) Search(ctx context.Context, query string, opts ...SearchOption) ([]*retrieval.Result, error)

+ type Option func(*App)

+ func WithChunker(strategy chunking.Strategy, size, overlap int) Option

+ func WithEmbedder(e embeddings.Embedder) Option

+ func WithStore(s Store) Option

+ func WithWeights(w retrieval.Weights) Option

+ type SearchOption func(*searchConfig)

+ func TopK(k int) SearchOption

+ func WithMMR(lambda float64) SearchOption

+ type Store interface

+ All func(ctx context.Context) ([]*retrieval.Result, error)

+ Put func(ctx context.Context, items []*retrieval.Result) error

+ func NewMemoryStore() Store