index

Documentation

Index

• type Document
• type Embedder
• type ListOptions
• type Page
• type Provider
• type QueryOptions
• type Reranker
• type Result

Types

type Document

type Document struct {
	ID string

	Title   string
	Source  string
	Content string

	Metadata map[string]string

	Embedding []float32
}

type Embedder

type Embedder = provider.Embedder

type ListOptions

type ListOptions struct {
	Limit  *int
	Cursor string
}

type Page

type Page[T Document] struct {
	Items []T

	Cursor string
}

type Provider

type Provider interface {
	List(ctx context.Context, options *ListOptions) (*Page[Document], error)

	Index(ctx context.Context, documents ...Document) error
	Delete(ctx context.Context, ids ...string) error

	Query(ctx context.Context, query string, options *QueryOptions) ([]Result, error)
}

type QueryOptions

type QueryOptions struct {
	Limit *int

	Filters map[string]string
}

type Reranker

type Reranker = provider.Reranker

type Result

type Result struct {
	Document
	Score float32
}