combinators

Documentation

Overview

Package combinators contains tools to put various retrieval components together to make full retrievers

Index

• type RetrieverWithCandidateFinder
  • func (rcf RetrieverWithCandidateFinder) Retrieve(ctx context.Context, request types.RetrievalRequest, ...) (*types.RetrievalStats, error)
• type SplitRetriever
  • func (m SplitRetriever) Retrieve(ctx context.Context, request types.RetrievalRequest, ...) types.CandidateRetrieval

Types

type RetrieverWithCandidateFinder

type RetrieverWithCandidateFinder struct {
	CandidateFinder    types.CandidateFinder
	CandidateRetriever types.CandidateRetriever
}

RetrieverWithCandidateFinder retrieves from a candidate retriever after first retrieving candidates from a candidate finder

func (RetrieverWithCandidateFinder) Retrieve

func (rcf RetrieverWithCandidateFinder) Retrieve(ctx context.Context, request types.RetrievalRequest, events func(types.RetrievalEvent)) (*types.RetrievalStats, error)

type SplitRetriever

type SplitRetriever struct {
	CandidateSplitter   types.CandidateSplitter
	CandidateRetrievers []types.CandidateRetriever
	CoordinationKind    types.CoordinationKind
}

SplitRetriever retrieves by first splitting candidates with a splitter, then passing the split sets to multiple retrievers using the given coordination style

func (SplitRetriever) Retrieve

func (m SplitRetriever) Retrieve(ctx context.Context, request types.RetrievalRequest, events func(types.RetrievalEvent)) types.CandidateRetrieval