vearch

README

Vearch sdk for langchaingo.

Documentation

Overview

Package vearch contains an implementation of the VectorStore interface using vearch.

Index

• Constants
• Variables
• func DoRequest(ctx context.Context, url url.URL, apiKey, method string, payload interface{}) (io.ReadCloser, int, error)
• type Option
  • func WithDBName(name string) Option
  • func WithEmbedder(embedder embeddings.Embedder) Option
  • func WithSpaceName(name string) Option
  • func WithURL(clusterURL url.URL) Option
• type Store
  • func New(opts ...Option) (Store, error)
  • func (s Store) AddDocuments(ctx context.Context, docs []schema.Document, options ...vectorstores.Option) ([]string, error)
  • func (s *Store) SimilaritySearch(ctx context.Context, query string, numDocuments int, ...) ([]schema.Document, error)

Constants

const (
	DefaultDBName    = "ts_db"
	DefaultSpaceName = "ts_space"
)

Variables

var ErrInvalidOptions = errors.New("invalid options")

ErrInvalidOptions is returned when the options given are invalid.

Functions

func DoRequest

func DoRequest(ctx context.Context,
	url url.URL,
	apiKey,
	method string,
	payload interface{},
) (io.ReadCloser, int, error)

doRequest performs an HTTP request to the Qdrant API.

Types

type Option

type Option func(store *Store)

Option is a function that configures an Options.

func WithDBName

func WithDBName(name string) Option

WithDbName returns an Option for setting the database name. Required.

func WithEmbedder

func WithEmbedder(embedder embeddings.Embedder) Option

WithEmbedder is an option for setting the embedder to use. Must be set.

func WithSpaceName

func WithSpaceName(name string) Option

WithSpaceName returns an Option for setting the space name. Required.

func WithURL

func WithURL(clusterURL url.URL) Option

WithURL returns an Option for setting the Vearch cluster URL. Required.

type Store

type Store struct {
	DBName     string
	SpaceName  string
	ClusterURL url.URL
	// contains filtered or unexported fields
}

func New

func New(opts ...Option) (Store, error)

func (Store) AddDocuments

func (s Store) AddDocuments(
	ctx context.Context,
	docs []schema.Document,
	options ...vectorstores.Option,
) ([]string, error)

func (*Store) SimilaritySearch

func (s *Store) SimilaritySearch(
	ctx context.Context,
	query string,
	numDocuments int,
	options ...vectorstores.Option,
) ([]schema.Document, error)