retriever

Documentation

Index

• func AddReferencesToArgs(args map[string]any, refs []Reference) map[string]any
• func GenerateKnowledgebaseRetriever(ctx context.Context, cli client.Client, ...) (outArg map[string]any, finish func(), err error)
• type Fakeretriever
  • func (f *Fakeretriever) GetRelevantDocuments(ctx context.Context, query string) ([]langchaingoschema.Document, error)
• type KnowledgeBaseRetriever
  • func NewKnowledgeBaseRetriever(baseNode base.BaseNode) *KnowledgeBaseRetriever
  • func (l *KnowledgeBaseRetriever) Cleanup()
  • func (l *KnowledgeBaseRetriever) Init(ctx context.Context, cli client.Client, _ map[string]any) error
  • func (l *KnowledgeBaseRetriever) Ready() (isReady bool, msg string)
  • func (l *KnowledgeBaseRetriever) Run(ctx context.Context, cli client.Client, args map[string]any) (map[string]any, error)
• type MultiQueryRetriever
  • func NewMultiQueryRetriever(baseNode base.BaseNode) *MultiQueryRetriever
  • func (l *MultiQueryRetriever) Init(ctx context.Context, cli client.Client, _ map[string]any) error
  • func (l *MultiQueryRetriever) Ready() (isReady bool, msg string)
  • func (l *MultiQueryRetriever) Run(ctx context.Context, cli client.Client, args map[string]any) (map[string]any, error)
• type Reference
  • func ConvertDocuments(ctx context.Context, docs []langchaingoschema.Document, retrieverName string) (newDocs []langchaingoschema.Document, refs []Reference)
  • func (reference Reference) SimpleString() string
  • func (reference Reference) String() string
• type RerankRequestBody
• type RerankRetriever
  • func NewRerankRetriever(baseNode base.BaseNode) *RerankRetriever
  • func (l *RerankRetriever) Init(ctx context.Context, cli client.Client, _ map[string]any) error
  • func (l *RerankRetriever) Ready() (isReady bool, msg string)
  • func (l *RerankRetriever) Run(ctx context.Context, cli client.Client, args map[string]any) (map[string]any, error)

Functions

func AddReferencesToArgs

func AddReferencesToArgs(args map[string]any, refs []Reference) map[string]any

func GenerateKnowledgebaseRetriever

func GenerateKnowledgebaseRetriever(ctx context.Context, cli client.Client, knowledgebaseName, knowledgebaseNamespace string, retrieverConfig apiretriever.CommonRetrieverConfig, args map[string]any) (outArg map[string]any, finish func(), err error)

Types

type Fakeretriever

type Fakeretriever struct {
	Name string
	Docs []langchaingoschema.Document
}

func (*Fakeretriever) GetRelevantDocuments

func (f *Fakeretriever) GetRelevantDocuments(ctx context.Context, query string) ([]langchaingoschema.Document, error)

type KnowledgeBaseRetriever

type KnowledgeBaseRetriever struct {
	base.BaseNode
	Instance *apiretriever.KnowledgeBaseRetriever
	Finish   func()
}

func NewKnowledgeBaseRetriever

func NewKnowledgeBaseRetriever(baseNode base.BaseNode) *KnowledgeBaseRetriever

func (*KnowledgeBaseRetriever) Cleanup

func (l *KnowledgeBaseRetriever) Cleanup()

func (*KnowledgeBaseRetriever) Init

func (l *KnowledgeBaseRetriever) Init(ctx context.Context, cli client.Client, _ map[string]any) error

func (*KnowledgeBaseRetriever) Ready

func (l *KnowledgeBaseRetriever) Ready() (isReady bool, msg string)

func (*KnowledgeBaseRetriever) Run

func (l *KnowledgeBaseRetriever) Run(ctx context.Context, cli client.Client, args map[string]any) (map[string]any, error)

type MultiQueryRetriever

type MultiQueryRetriever struct {
	base.BaseNode
	Instance *apiretriever.MultiQueryRetriever
}

func NewMultiQueryRetriever

func NewMultiQueryRetriever(baseNode base.BaseNode) *MultiQueryRetriever

func (*MultiQueryRetriever) Init

func (l *MultiQueryRetriever) Init(ctx context.Context, cli client.Client, _ map[string]any) error

func (*MultiQueryRetriever) Ready

func (l *MultiQueryRetriever) Ready() (isReady bool, msg string)

func (*MultiQueryRetriever) Run

func (l *MultiQueryRetriever) Run(ctx context.Context, cli client.Client, args map[string]any) (map[string]any, error)

type Reference

type Reference struct {
	// Question row
	Question string `json:"question" example:"q: 旷工最小计算单位为多少天？"`
	// Answer row
	Answer string `json:"answer" example:"旷工最小计算单位为 0.5 天。"`
	// vector search score
	Score float32 `json:"score" example:"0.34"`
	// the qa file fullpath
	QAFilePath string `json:"qa_file_path" example:"dataset/dataset-playground/v1/qa.csv"`
	// line number in the qa file
	QALineNumber int `json:"qa_line_number" example:"7"`
	// source file name, only file name, not full path
	FileName string `json:"file_name" example:"员工考勤管理制度-2023.pdf"`
	// page number in the source file
	PageNumber int `json:"page_number" example:"1"`
	// related content in the source file or in webpage
	Content string `` /* 144-byte string literal not displayed */
	// Title of the webpage
	Title string `json:"title,omitempty" example:"开始使用 Microsoft 帐户 – Microsoft"`
	// URL of the webpage
	URL string `json:"url,omitempty" example:"https://www.microsoft.com/zh-cn/welcome"`
	// RerankScore
	RerankScore float32        `json:"rerank_score,omitempty" example:"0.58124"`
	Metadata    map[string]any `json:"-"`
}

func ConvertDocuments

func ConvertDocuments(ctx context.Context, docs []langchaingoschema.Document, retrieverName string) (newDocs []langchaingoschema.Document, refs []Reference)

func (Reference) SimpleString

func (reference Reference) SimpleString() string

func (Reference) String

func (reference Reference) String() string

type RerankRequestBody

type RerankRequestBody struct {
	Query    string   `json:"question"`
	Passages []string `json:"answers"`
}

type RerankRetriever

type RerankRetriever struct {
	base.BaseNode
	Instance *apiretriever.RerankRetriever
}

func NewRerankRetriever

func NewRerankRetriever(baseNode base.BaseNode) *RerankRetriever

func (*RerankRetriever) Init

func (l *RerankRetriever) Init(ctx context.Context, cli client.Client, _ map[string]any) error

func (*RerankRetriever) Ready

func (l *RerankRetriever) Ready() (isReady bool, msg string)

func (*RerankRetriever) Run

func (l *RerankRetriever) Run(ctx context.Context, cli client.Client, args map[string]any) (map[string]any, error)