flows

Documentation

Index

• type IngestionFlow
  • func NewDefaultIngestionFlow(filetype string, textsplitterOpts *textsplitter.TextSplitterOpts) (IngestionFlow, error)
  • func (f *IngestionFlow) FillDefaults(filetype string, textsplitterOpts *textsplitter.TextSplitterOpts) error
  • func (f *IngestionFlow) Run(ctx context.Context, reader io.Reader) ([]vs.Document, error)
  • func (f *IngestionFlow) SupportsFiletype(filetype string) bool
  • func (f *IngestionFlow) Transform(ctx context.Context, docs []vs.Document) ([]vs.Document, error)
• type IngestionFlowGlobals
• type RetrievalFlow
  • func (f *RetrievalFlow) FillDefaults(topK int)
  • func (f *RetrievalFlow) Run(ctx context.Context, store store.Store, query string, datasetIDs []string, ...) (*dstypes.RetrievalResponse, error)
• type RetrievalFlowOpts

Types

type IngestionFlow

type IngestionFlow struct {
	Globals         IngestionFlowGlobals
	Filetypes       []string
	Load            documentloader.LoaderFunc
	Splitter        dstypes.TextSplitter
	Transformations []dstypes.DocumentTransformer
}

func NewDefaultIngestionFlow

func NewDefaultIngestionFlow(filetype string, textsplitterOpts *textsplitter.TextSplitterOpts) (IngestionFlow, error)

func (*IngestionFlow) FillDefaults

func (f *IngestionFlow) FillDefaults(filetype string, textsplitterOpts *textsplitter.TextSplitterOpts) error

func (*IngestionFlow) Run

func (f *IngestionFlow) Run(ctx context.Context, reader io.Reader) ([]vs.Document, error)

func (*IngestionFlow) SupportsFiletype

func (f *IngestionFlow) SupportsFiletype(filetype string) bool

func (*IngestionFlow) Transform

func (f *IngestionFlow) Transform(ctx context.Context, docs []vs.Document) ([]vs.Document, error)

type IngestionFlowGlobals

type IngestionFlowGlobals struct {
	SplitterOpts map[string]any
}

type RetrievalFlow

type RetrievalFlow struct {
	QueryModifiers []querymodifiers.QueryModifier
	Retriever      retrievers.Retriever
	Postprocessors []postprocessors.Postprocessor
}

func (*RetrievalFlow) FillDefaults

func (f *RetrievalFlow) FillDefaults(topK int)

func (*RetrievalFlow) Run

func (f *RetrievalFlow) Run(ctx context.Context, store store.Store, query string, datasetIDs []string, opts *RetrievalFlowOpts) (*dstypes.RetrievalResponse, error)

type RetrievalFlowOpts

type RetrievalFlowOpts struct {
	Where         map[string]string
	WhereDocument []chromem.WhereDocument
}