retrievers

Documentation

Index

• Constants
• func DefaultConfigDecoder(ret Retriever, cfg map[string]any) error
• func ExtractQuotedSubstrings(input string) []string
• type BM25Retriever
  • func (r *BM25Retriever) DecodeConfig(cfg map[string]any) error
  • func (r *BM25Retriever) Name() string
  • func (r *BM25Retriever) NormalizedScores() bool
  • func (r *BM25Retriever) Retrieve(ctx context.Context, store store.Store, query string, datasetIDs []string, ...) ([]vs.Document, error)
• type BasicRetriever
  • func (r *BasicRetriever) DecodeConfig(cfg map[string]any) error
  • func (r *BasicRetriever) Name() string
  • func (r *BasicRetriever) NormalizedScores() bool
  • func (r *BasicRetriever) Retrieve(ctx context.Context, store store.Store, query string, datasetIDs []string, ...) ([]vs.Document, error)
• type MergingRetriever
  • func (r *MergingRetriever) DecodeConfig(cfg map[string]any) error
  • func (r *MergingRetriever) Name() string
  • func (r *MergingRetriever) NormalizedScores() bool
  • func (r *MergingRetriever) Retrieve(ctx context.Context, store store.Store, query string, datasetIDs []string, ...) ([]vs.Document, error)
• type Retriever
  • func GetDefaultRetriever() Retriever
  • func GetRetriever(name string) (Retriever, error)
• type RetrieverToMerge
• type RoutingRetriever
  • func (r *RoutingRetriever) DecodeConfig(cfg map[string]any) error
  • func (r *RoutingRetriever) Name() string
  • func (r *RoutingRetriever) NormalizedScores() bool
  • func (r *RoutingRetriever) Retrieve(ctx context.Context, store store.Store, query string, datasetIDs []string, ...) ([]vs.Document, error)
• type SubqueryRetriever
  • func (s *SubqueryRetriever) DecodeConfig(cfg map[string]any) error
  • func (s *SubqueryRetriever) Name() string
  • func (s *SubqueryRetriever) NormalizedScores() bool
  • func (s *SubqueryRetriever) Retrieve(ctx context.Context, store store.Store, query string, datasetIDs []string, ...) ([]vs.Document, error)

Constants

const BM25RetrieverName = postprocessors.BM25PostprocessorName

const BasicRetrieverName = "basic"

const MergingRetrieverName = "merge"

const RoutingRetrieverName = "routing"

const SubqueryRetrieverName = "subquery"

Functions

func DefaultConfigDecoder

func DefaultConfigDecoder(ret Retriever, cfg map[string]any) error

func ExtractQuotedSubstrings

func ExtractQuotedSubstrings(input string) []string

Extract double-quoted substrings from a string

Types

type BM25Retriever

type BM25Retriever struct {
	TopN int

	K1 float64 // K1 should be between 1.2 and 2 - controls term frequency saturation
	B  float64 // B should be around 0.75 - controls the influence of document length normalization

	CleanStopWords []string // list of stopwords to remove from the documents - if empty, no stopwords are removed, if only "auto" is present, the language is detected automatically
}

func (*BM25Retriever) DecodeConfig

func (r *BM25Retriever) DecodeConfig(cfg map[string]any) error

func (*BM25Retriever) Name

func (r *BM25Retriever) Name() string

func (*BM25Retriever) NormalizedScores

func (r *BM25Retriever) NormalizedScores() bool

func (*BM25Retriever) Retrieve

func (r *BM25Retriever) Retrieve(ctx context.Context, store store.Store, query string, datasetIDs []string, where map[string]string, whereDocument []chromem.WhereDocument) ([]vs.Document, error)

type BasicRetriever

type BasicRetriever struct {
	TopK int
}

func (*BasicRetriever) DecodeConfig

func (r *BasicRetriever) DecodeConfig(cfg map[string]any) error

func (*BasicRetriever) Name

func (r *BasicRetriever) Name() string

func (*BasicRetriever) NormalizedScores

func (r *BasicRetriever) NormalizedScores() bool

func (*BasicRetriever) Retrieve

func (r *BasicRetriever) Retrieve(ctx context.Context, store store.Store, query string, datasetIDs []string, where map[string]string, whereDocument []chromem.WhereDocument) ([]vs.Document, error)

type MergingRetriever

type MergingRetriever struct {
	TopK       int
	Retrievers []RetrieverToMerge `json:"retrievers" mapstructure:"retrievers" yaml:"retrievers"`
	// contains filtered or unexported fields
}

func (*MergingRetriever) DecodeConfig

func (r *MergingRetriever) DecodeConfig(cfg map[string]any) error

func (*MergingRetriever) Name

func (r *MergingRetriever) Name() string

func (*MergingRetriever) NormalizedScores

func (r *MergingRetriever) NormalizedScores() bool

func (*MergingRetriever) Retrieve

func (r *MergingRetriever) Retrieve(ctx context.Context, store store.Store, query string, datasetIDs []string, where map[string]string, whereDocument []chromem.WhereDocument) ([]vs.Document, error)

type Retriever

type Retriever interface {
	Retrieve(ctx context.Context, store store.Store, query string, datasetIDs []string, where map[string]string, whereDocument []chromem.WhereDocument) ([]vs.Document, error)
	Name() string
	DecodeConfig(cfg map[string]any) error
	NormalizedScores() bool // whether the retriever returns normalized scores
}

func GetDefaultRetriever

func GetDefaultRetriever() Retriever

func GetRetriever

func GetRetriever(name string) (Retriever, error)

type RetrieverToMerge

type RetrieverToMerge struct {
	Name    string         `json:"name,omitempty" mapstructure:"name" yaml:"name"`
	Weight  *float32       `json:"weight,omitempty" mapstructure:"weight" yaml:"weight"`
	Options map[string]any `json:"options,omitempty" mapstructure:"options" yaml:"options"`
}

type RoutingRetriever

type RoutingRetriever struct {
	Model             llm.LLMConfig
	AvailableDatasets []string
	TopK              int
}

func (*RoutingRetriever) DecodeConfig

func (r *RoutingRetriever) DecodeConfig(cfg map[string]any) error

func (*RoutingRetriever) Name

func (r *RoutingRetriever) Name() string

func (*RoutingRetriever) NormalizedScores

func (r *RoutingRetriever) NormalizedScores() bool

func (*RoutingRetriever) Retrieve

func (r *RoutingRetriever) Retrieve(ctx context.Context, store store.Store, query string, datasetIDs []string, where map[string]string, whereDocument []chromem.WhereDocument) ([]vs.Document, error)

type SubqueryRetriever

type SubqueryRetriever struct {
	Model llm.LLMConfig
	Limit int
	TopK  int
}

func (*SubqueryRetriever) DecodeConfig

func (s *SubqueryRetriever) DecodeConfig(cfg map[string]any) error

func (*SubqueryRetriever) Name

func (s *SubqueryRetriever) Name() string

func (*SubqueryRetriever) NormalizedScores

func (s *SubqueryRetriever) NormalizedScores() bool

func (*SubqueryRetriever) Retrieve

func (s *SubqueryRetriever) Retrieve(ctx context.Context, store store.Store, query string, datasetIDs []string, where map[string]string, whereDocument []chromem.WhereDocument) ([]vs.Document, error)