vectorstore

Documentation

Overview

Package vectorstore provides functionality for storing and managing vector embeddings.

Index

• func ToRetriever(vectorStore schema.VectorStore, ...) schema.Retriever
• type InMemory
  • func NewInMemory(embedder schema.Embedder, optFns ...func(*InMemoryOptions)) *InMemory
  • func (vs *InMemory) AddDocuments(ctx context.Context, docs []schema.Document) error
  • func (vs *InMemory) AddItem(item InMemoryItem)
  • func (vs *InMemory) Data() []InMemoryItem
  • func (vs *InMemory) SimilaritySearch(ctx context.Context, query string) ([]schema.Document, error)
• type InMemoryItem
• type InMemoryOptions
• type Pinecone
  • func NewPinecone(client pinecone.Client, embedder schema.Embedder, textKey string, ...) (*Pinecone, error)
  • func (vs *Pinecone) AddDocuments(ctx context.Context, docs []schema.Document) error
  • func (vs *Pinecone) SimilaritySearch(ctx context.Context, query string) ([]schema.Document, error)
• type PineconeOptions
• type Weaviate
  • func NewWeaviate(client *weaviate.Client, embedder schema.Embedder, ...) *Weaviate
  • func (vs *Weaviate) AddDocuments(ctx context.Context, docs []schema.Document) error
  • func (vs *Weaviate) CreateClassIfNotExist(ctx context.Context) error
  • func (vs *Weaviate) Delete(ctx context.Context, uuid string) error
  • func (vs *Weaviate) SimilaritySearch(ctx context.Context, query string) ([]schema.Document, error)
• type WeaviateOptions

Functions

func ToRetriever

func ToRetriever(vectorStore schema.VectorStore, optFns ...func(o *retriever.VectorStoreOptions)) schema.Retriever

ToRetriever takes a vector store and returns a retriever

Types

type InMemory

type InMemory struct {
	// contains filtered or unexported fields
}

InMemory represents an in-memory vector store. Note: This implementation is intended for testing and demonstration purposes, not for production use.

func NewInMemory

func NewInMemory(embedder schema.Embedder, optFns ...func(*InMemoryOptions)) *InMemory

NewInMemory creates a new instance of the in-memory vector store.

func (*InMemory) AddDocuments

func (vs *InMemory) AddDocuments(ctx context.Context, docs []schema.Document) error

AddDocuments adds a batch of documents to the InMemory vector store.

func (*InMemory) AddItem

func (vs *InMemory) AddItem(item InMemoryItem)

AddItem adds a single item to the InMemory vector store.

func (*InMemory) Data

func (vs *InMemory) Data() []InMemoryItem

Data returns the underlying data stored in the InMemory vector store.

func (*InMemory) SimilaritySearch

func (vs *InMemory) SimilaritySearch(ctx context.Context, query string) ([]schema.Document, error)

SimilaritySearch performs a similarity search with the given query in the InMemory vector store.

type InMemoryItem

type InMemoryItem struct {
	Content  string         `json:"content"`
	Vector   []float32      `json:"vector"`
	Metadata map[string]any `json:"metadata"`
}

InMemoryItem represents an item stored in memory with its content, vector, and metadata.

type InMemoryOptions

type InMemoryOptions struct {
	TopK int
}

InMemoryOptions represents options for the in-memory vector store.

type Pinecone

type Pinecone struct {
	// contains filtered or unexported fields
}

func NewPinecone

func NewPinecone(client pinecone.Client, embedder schema.Embedder, textKey string, optFns ...func(*PineconeOptions)) (*Pinecone, error)

func (*Pinecone) AddDocuments

func (vs *Pinecone) AddDocuments(ctx context.Context, docs []schema.Document) error

func (*Pinecone) SimilaritySearch

func (vs *Pinecone) SimilaritySearch(ctx context.Context, query string) ([]schema.Document, error)

type PineconeOptions

type PineconeOptions struct {
	Namespace string
	TopK      int64
}

type Weaviate

type Weaviate struct {
	// contains filtered or unexported fields
}

Weaviate represents a Weaviate vector store.

func NewWeaviate

func NewWeaviate(client *weaviate.Client, embedder schema.Embedder, optFns ...func(*WeaviateOptions)) *Weaviate

NewWeaviate creates a new Weaviate vector store with the given Weaviate client, embedder, and optional configuration options.

func (*Weaviate) AddDocuments

func (vs *Weaviate) AddDocuments(ctx context.Context, docs []schema.Document) error

AddDocuments adds a batch of documents to the Weaviate vector store.

func (*Weaviate) CreateClassIfNotExist

func (vs *Weaviate) CreateClassIfNotExist(ctx context.Context) error

CreateClassIfNotExist checks if the Weaviate class for the vector store exists, and creates it if it doesn't.

func (*Weaviate) Delete

func (vs *Weaviate) Delete(ctx context.Context, uuid string) error

Delete removes a document from the Weaviate vector store based on its UUID.

func (*Weaviate) SimilaritySearch

func (vs *Weaviate) SimilaritySearch(ctx context.Context, query string) ([]schema.Document, error)

SimilaritySearch performs a similarity search with the given query in the Weaviate vector store.

type WeaviateOptions

type WeaviateOptions struct {
	// TextKey is the name of the property in the Weaviate objects where the text content is stored.
	TextKey string

	// TopK is the number of documents to retrieve in similarity search.
	TopK int

	// IndexName is the name of the index to store the vectors.
	IndexName string

	// AdditionalFields is a list of additional fields to retrieve during similarity search.
	AdditionalFields []string
}

WeaviateOptions contains options for configuring the Weaviate vector store.