Documentation
¶
Index ¶
- func UniqueDocuments(docs []schema.Document) []schema.Document
- type MergerRetriever
- type MultiQueryRetriever
- func (m *MultiQueryRetriever) GenerateQueries(ctx context.Context, query string) ([]string, error)
- func (m *MultiQueryRetriever) GetRelevantDocuments(ctx context.Context, query string) ([]schema.Document, error)
- func (m *MultiQueryRetriever) RetrieveDocuments(ctx context.Context, queries []string) ([]schema.Document, error)
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
Types ¶
type MergerRetriever ¶
MergerRetriever is a retriever that merges the results of multiple retrievers.
func NewMergerRetriever ¶
func NewMergerRetriever( retrievers []schema.Retriever, ) MergerRetriever
NewMergerRetriever creates a new MergerRetriever.
func (*MergerRetriever) GetRelevantDocuments ¶
func (m *MergerRetriever) GetRelevantDocuments(ctx context.Context, query string) ([]schema.Document, error)
GetRelevantDocuments returns documents from the MergerRetriever's all retrievers.
type MultiQueryRetriever ¶
type MultiQueryRetriever struct {
Retriever schema.Retriever
LLMChain *chains.LLMChain
// Whether to include the original query in the list of generated queries.
IncludeOriginal bool
InputKey string
// Delay time in seconds between each query from base retriever, default to 0.
DelayTime int
CallbacksHandler callbacks.Handler
}
func NewMultiQueryRetriever ¶
func NewMultiQueryRetriever( retriever schema.Retriever, llmChain *chains.LLMChain, includeOriginal bool, ) MultiQueryRetriever
NewMultiQueryRetriever creates a new MultiQueryRetriever.
func NewMultiQueryRetrieverFromLLM ¶
func NewMultiQueryRetrieverFromLLM( retriever schema.Retriever, llm llms.Model, prompt prompts.FormatPrompter, includeOriginal bool, opts ...chains.ChainCallOption, ) MultiQueryRetriever
func (*MultiQueryRetriever) GenerateQueries ¶
GenerateQueries Generate queries based upon user input.
func (*MultiQueryRetriever) GetRelevantDocuments ¶
func (*MultiQueryRetriever) RetrieveDocuments ¶
func (m *MultiQueryRetriever) RetrieveDocuments(ctx context.Context, queries []string) ([]schema.Document, error)
RetrieveDocuments Run all LLM generated queries and return the results.
Source Files
Click to show internal directories.
Click to hide internal directories.