retrievers

Documentation

Index

• Constants
• type BasicRetriever
  • func (r *BasicRetriever) Name() string
  • func (r *BasicRetriever) Retrieve(ctx context.Context, store store.Store, query string, datasetID string) ([]vs.Document, error)
• type Retriever
  • func GetDefaultRetriever() Retriever
  • func GetRetriever(name string) (Retriever, error)
• type RoutingRetriever
  • func (r *RoutingRetriever) Name() string
  • func (r *RoutingRetriever) Retrieve(ctx context.Context, store store.Store, query string, datasetID string) ([]vs.Document, error)
• type SubqueryRetriever
  • func (s SubqueryRetriever) Name() string
  • func (s SubqueryRetriever) Retrieve(ctx context.Context, store store.Store, query string, datasetID string) ([]vs.Document, error)

Constants

const BasicRetrieverName = "basic"

const RoutingRetrieverName = "routing"

const SubqueryRetrieverName = "subquery"

Types

type BasicRetriever

type BasicRetriever struct {
	TopK int
}

func (*BasicRetriever) Name

func (r *BasicRetriever) Name() string

func (*BasicRetriever) Retrieve

func (r *BasicRetriever) Retrieve(ctx context.Context, store store.Store, query string, datasetID string) ([]vs.Document, error)

type Retriever

type Retriever interface {
	Retrieve(ctx context.Context, store store.Store, query string, datasetID string) ([]vs.Document, error)
	Name() string
}

func GetDefaultRetriever

func GetDefaultRetriever() Retriever

func GetRetriever

func GetRetriever(name string) (Retriever, error)

type RoutingRetriever

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

func (*RoutingRetriever) Name

func (r *RoutingRetriever) Name() string

func (*RoutingRetriever) Retrieve

func (r *RoutingRetriever) Retrieve(ctx context.Context, store store.Store, query string, datasetID string) ([]vs.Document, error)

type SubqueryRetriever

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

func (SubqueryRetriever) Name

func (s SubqueryRetriever) Name() string

func (SubqueryRetriever) Retrieve

func (s SubqueryRetriever) Retrieve(ctx context.Context, store store.Store, query string, datasetID string) ([]vs.Document, error)