index

Documentation

Index

• Variables
• type Embedder
• type Option
  • func WithFilter(filter interface{}) Option
  • func WithTopK(topK int) Option
• type Pinecone
  • func NewPinecone(options PineconeOptions, embedder Embedder) *Pinecone
  • func (p *Pinecone) IsEmpty(ctx context.Context) (bool, error)
  • func (p *Pinecone) LoadFromDocuments(ctx context.Context, documents []document.Document) error
  • func (p *Pinecone) SimilaritySearch(ctx context.Context, query string, opts ...Option) (SearchResponses, error)
  • func (p *Pinecone) WithAPIKeyAndEnvironment(apiKey, environment string) *Pinecone
• type PineconeCreateIndexOptions
• type PineconeOptions
• type Qdrant
  • func NewQdrant(options QdrantOptions, embedder Embedder) *Qdrant
  • func (p *Qdrant) IsEmpty(ctx context.Context) (bool, error)
  • func (q *Qdrant) LoadFromDocuments(ctx context.Context, documents []document.Document) error
  • func (q *Qdrant) SimilaritySearch(ctx context.Context, query string, opts ...Option) (SearchResponses, error)
  • func (q *Qdrant) WithAPIKeyAndEdpoint(apiKey, endpoint string) *Qdrant
• type QdrantCreateCollectionOptions
• type QdrantDistance
• type QdrantOptions
• type SearchResponse
• type SearchResponses
  • func (s SearchResponses) ToDocuments() []document.Document
• type SimpleVectorIndex
  • func NewSimpleVectorIndex(name string, outputPath string, embedder Embedder) *SimpleVectorIndex
  • func (s *SimpleVectorIndex) IsEmpty() (bool, error)
  • func (s *SimpleVectorIndex) LoadFromDocuments(ctx context.Context, documents []document.Document) error
  • func (s *SimpleVectorIndex) SimilaritySearch(ctx context.Context, query string, opts ...Option) (SearchResponses, error)
• type SimpleVectorIndexFilterFn

Variables

var (
	ErrInternal = "internal index error"
)

Types

type Embedder

type Embedder interface {
	Embed(ctx context.Context, texts []string) ([]embedder.Embedding, error)
}

type Option

type Option func(*options)

func WithFilter

func WithFilter(filter interface{}) Option

func WithTopK

func WithTopK(topK int) Option

type Pinecone

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

func NewPinecone

func NewPinecone(options PineconeOptions, embedder Embedder) *Pinecone

func (*Pinecone) IsEmpty

func (p *Pinecone) IsEmpty(ctx context.Context) (bool, error)

func (*Pinecone) LoadFromDocuments

func (p *Pinecone) LoadFromDocuments(ctx context.Context, documents []document.Document) error

func (*Pinecone) SimilaritySearch

func (p *Pinecone) SimilaritySearch(ctx context.Context, query string, opts ...Option) (SearchResponses, error)

func (*Pinecone) WithAPIKeyAndEnvironment

func (p *Pinecone) WithAPIKeyAndEnvironment(apiKey, environment string) *Pinecone

type PineconeCreateIndexOptions

type PineconeCreateIndexOptions struct {
	Dimension int
	Replicas  int
	Metric    string
	PodType   string
}

type PineconeOptions

type PineconeOptions struct {
	IndexName       string
	Namespace       string
	IncludeContent  bool
	BatchUpsertSize *int
	CreateIndex     *PineconeCreateIndexOptions
}

type Qdrant

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

func NewQdrant

func NewQdrant(options QdrantOptions, embedder Embedder) *Qdrant

func (*Qdrant) IsEmpty

func (p *Qdrant) IsEmpty(ctx context.Context) (bool, error)

func (*Qdrant) LoadFromDocuments

func (q *Qdrant) LoadFromDocuments(ctx context.Context, documents []document.Document) error

func (*Qdrant) SimilaritySearch

func (q *Qdrant) SimilaritySearch(ctx context.Context, query string, opts ...Option) (SearchResponses, error)

func (*Qdrant) WithAPIKeyAndEdpoint

func (q *Qdrant) WithAPIKeyAndEdpoint(apiKey, endpoint string) *Qdrant

type QdrantCreateCollectionOptions

type QdrantCreateCollectionOptions struct {
	Dimension uint64
	Distance  QdrantDistance
	OnDisk    bool
}

type QdrantDistance

type QdrantDistance string

const (
	QdrantDistanceCosine    QdrantDistance = QdrantDistance(qdrantrequest.DistanceCosine)
	QdrantDistanceEuclidean QdrantDistance = QdrantDistance(qdrantrequest.DistanceEuclidean)
	QdrantDistanceDot       QdrantDistance = QdrantDistance(qdrantrequest.DistanceDot)
)

type QdrantOptions

type QdrantOptions struct {
	CollectionName   string
	IncludeContent   bool
	BatchUpsertSize  *int
	CreateCollection *QdrantCreateCollectionOptions
}

type SearchResponse

type SearchResponse struct {
	ID       string
	Document document.Document
	Score    float64
}

type SearchResponses

type SearchResponses []SearchResponse

func (SearchResponses) ToDocuments

func (s SearchResponses) ToDocuments() []document.Document

type SimpleVectorIndex

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

func NewSimpleVectorIndex

func NewSimpleVectorIndex(name string, outputPath string, embedder Embedder) *SimpleVectorIndex

func (*SimpleVectorIndex) IsEmpty

func (s *SimpleVectorIndex) IsEmpty() (bool, error)

func (*SimpleVectorIndex) LoadFromDocuments

func (s *SimpleVectorIndex) LoadFromDocuments(ctx context.Context, documents []document.Document) error

func (*SimpleVectorIndex) SimilaritySearch

func (s *SimpleVectorIndex) SimilaritySearch(ctx context.Context, query string, opts ...Option) (SearchResponses, error)

type SimpleVectorIndexFilterFn

type SimpleVectorIndexFilterFn func([]SearchResponse) []SearchResponse