combinators

Documentation

Overview

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

Index

• type AsyncCandidateSplitter
  • func NewAsyncCandidateSplitter[T comparable](keys []T, newCandidateSplitter NewCandidateSplitterFn[T]) AsyncCandidateSplitter[T]
  • func (acs AsyncCandidateSplitter[T]) SplitRetrievalRequest(ctx context.Context, request types.RetrievalRequest, ...) types.AsyncRetrievalSplitter[T]
• type NewCandidateSplitterFn
• type RetrieverWithCandidateFinder
  • func (rcf RetrieverWithCandidateFinder) Retrieve(ctx context.Context, request types.RetrievalRequest, ...) (*types.RetrievalStats, error)
• type SplitRetriever
  • func (m SplitRetriever[T]) Retrieve(ctx context.Context, request types.RetrievalRequest, ...) types.CandidateRetrieval

Types

type AsyncCandidateSplitter

type AsyncCandidateSplitter[T comparable] struct {
	Keys              []T
	CandidateSplitter types.CandidateSplitter[T]
}

AsyncCandidateSplitter creates an splitter for a candidate stream from a simple function to split a set of candidates. Essentially, on each new candidate set from the stream, we run the splitter function, and feed the split candidates sets into the appropriate downstream candidate streams

func NewAsyncCandidateSplitter

func NewAsyncCandidateSplitter[T comparable](keys []T, newCandidateSplitter NewCandidateSplitterFn[T]) AsyncCandidateSplitter[T]

NewAsyncCandidateSplitter creates a new candidate splitter with the given passed in sync splitter constructor

func (AsyncCandidateSplitter[T]) SplitRetrievalRequest

func (acs AsyncCandidateSplitter[T]) SplitRetrievalRequest(ctx context.Context, request types.RetrievalRequest, events func(types.RetrievalEvent)) types.AsyncRetrievalSplitter[T]

SplitRetrievalRequest splits candidate streams for a given retrieval request

type NewCandidateSplitterFn

type NewCandidateSplitterFn[T comparable] func(keys []T) types.CandidateSplitter[T]

NewCandidateSplitterFn constructs a new candidate splitter for the given keys it's used to insurate

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[T comparable] struct {
	AsyncCandidateSplitter types.AsyncCandidateSplitter[T]
	CandidateRetrievers    map[T]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[T]) Retrieve

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