index

package

v0.8.0 Latest Latest Go to latest Published: Jul 18, 2026 License: MIT Imports: 3 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/dotcommander/reliquary

Links

Open Source Insights

Documentation ¶

Overview ¶

Package index defines the candidate-retrieval boundary used by Reliquary.

Constants ¶

This section is empty.

Variables ¶

View Source

var ErrDimensionMismatch = errors.New("reliquary index: vector dimension mismatch")

ErrDimensionMismatch reports incompatible query and indexed vector spaces.

View Source

var ErrIdentityMismatch = errors.New("reliquary index: identity mismatch")

ErrIdentityMismatch reports an attempt to mix different embedding or chunking spaces in one index.

Functions ¶

This section is empty.

Types ¶

type Index ¶

type Index interface {
	Upsert(ctx context.Context, items []*retrieval.Result) error
	DeleteDocument(ctx context.Context, documentID string) error
	Search(ctx context.Context, query IndexQuery) ([]*retrieval.Result, error)
}

Index stores embedded chunks and retrieves a bounded candidate set.

type IndexQuery ¶

type IndexQuery struct {
	Identity string
	Text     string
	Vector   []float32
	Limit    int
	Filter   map[string]any
}

IndexQuery describes candidate retrieval. A zero Limit leaves the candidate count implementation-defined or unbounded.

type Resetter ¶

type Resetter interface {
	Reset(ctx context.Context) error
}

Resetter is implemented by indexes that can destructively remove every stored result. It is optional so custom Index implementations remain source compatible.

Source Files ¶

View all Source files

index.go

Directories ¶

Path	Synopsis
indextest Package indextest provides a reusable contract suite for Index implementations.	Package indextest provides a reusable contract suite for Index implementations.
inmem Package inmem provides Reliquary's concurrency-safe in-process index.	Package inmem provides Reliquary's concurrency-safe in-process index.

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