vectorstores

package
v0.1.2 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Apr 12, 2026 License: MIT Imports: 3 Imported by: 0

Documentation

Overview

Package vectorstores provides interfaces and implementations for vector stores.

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type DocumentWithScore

type DocumentWithScore struct {
	Document *core.Document
	Score    float64
}

DocumentWithScore pairs a document with its similarity score.

type VectorStore

type VectorStore interface {
	// AddDocuments embeds and adds documents to the store.
	AddDocuments(ctx context.Context, documents []*core.Document) ([]string, error)

	// SimilaritySearch searches for documents similar to the query.
	SimilaritySearch(ctx context.Context, query string, k int) ([]*core.Document, error)

	// SimilaritySearchWithScore searches and returns documents with similarity scores.
	SimilaritySearchWithScore(ctx context.Context, query string, k int) ([]DocumentWithScore, error)

	// Delete removes documents by their IDs.
	Delete(ctx context.Context, ids []string) error

	// GetEmbedder returns the embedder used by this store.
	GetEmbedder() embeddings.Embedder
}

VectorStore is the interface for vector stores that support similarity search over embedded documents.

Directories

Path Synopsis
Package inmemory provides an in-memory vector store implementation.
Package inmemory provides an in-memory vector store implementation.

Jump to

Keyboard shortcuts

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