rag

Documentation

Index

• Variables
• type Fusion
  • func NewFusion(index *index.Index, llm LLM) *Fusion
  • func (r *Fusion) Retrieve(ctx context.Context, query string) ([]string, error)
• type LLM
• type Loader
• type RAG
  • func New(index *index.Index) *RAG
  • func (r *RAG) AddDocuments(ctx context.Context, documents ...document.Document) error
  • func (r *RAG) AddSources(ctx context.Context, sources ...string) error
  • func (r *RAG) Retrieve(ctx context.Context, query string) ([]string, error)
  • func (r *RAG) WithChunkOverlap(chunkOverlap uint) *RAG
  • func (r *RAG) WithChunkSize(chunkSize uint) *RAG
  • func (r *RAG) WithLoader(sourceRegexp *regexp.Regexp, loader Loader) *RAG
  • func (r *RAG) WithTopK(topK uint) *RAG
• type SubDocumentRAG
  • func NewSubDocument(index *index.Index, llm LLM) *SubDocumentRAG
  • func (r *SubDocumentRAG) AddSources(ctx context.Context, sources ...string) error
  • func (r *SubDocumentRAG) WithChildChunkSize(childChunkSize uint) *SubDocumentRAG
  • func (r *SubDocumentRAG) WithChunkOverlap(chunkOverlap uint) *SubDocumentRAG
  • func (r *SubDocumentRAG) WithChunkSize(chunkSize uint) *SubDocumentRAG
  • func (r *SubDocumentRAG) WithLoader(sourceRegexp *regexp.Regexp, loader Loader) *SubDocumentRAG
  • func (r *SubDocumentRAG) WithTopK(topK uint) *SubDocumentRAG

Variables

var SubDocumentRAGSummarizePrompt = "Please give a concise summary of the context in 1-2 sentences.\n\nContext: {{.context}}"

Types

type Fusion

type Fusion struct {
	RAG
	// contains filtered or unexported fields
}

func NewFusion

func NewFusion(index *index.Index, llm LLM) *Fusion

func (*Fusion) Retrieve

func (r *Fusion) Retrieve(ctx context.Context, query string) ([]string, error)

type LLM

type LLM interface {
	Generate(context.Context, *thread.Thread) error
}

type Loader

type Loader interface {
	LoadFromSource(context.Context, string) ([]document.Document, error)
}

type RAG

type RAG struct {
	// contains filtered or unexported fields
}

func New

func New(index *index.Index) *RAG

func (*RAG) AddDocuments

func (r *RAG) AddDocuments(ctx context.Context, documents ...document.Document) error

func (*RAG) AddSources

func (r *RAG) AddSources(ctx context.Context, sources ...string) error

func (*RAG) Retrieve

func (r *RAG) Retrieve(ctx context.Context, query string) ([]string, error)

func (*RAG) WithChunkOverlap

func (r *RAG) WithChunkOverlap(chunkOverlap uint) *RAG

func (*RAG) WithChunkSize

func (r *RAG) WithChunkSize(chunkSize uint) *RAG

func (*RAG) WithLoader

func (r *RAG) WithLoader(sourceRegexp *regexp.Regexp, loader Loader) *RAG

func (*RAG) WithTopK

func (r *RAG) WithTopK(topK uint) *RAG

type SubDocumentRAG

type SubDocumentRAG struct {
	RAG
	// contains filtered or unexported fields
}

func NewSubDocument

func NewSubDocument(index *index.Index, llm LLM) *SubDocumentRAG

func (*SubDocumentRAG) AddSources

func (r *SubDocumentRAG) AddSources(ctx context.Context, sources ...string) error

func (*SubDocumentRAG) WithChildChunkSize

func (r *SubDocumentRAG) WithChildChunkSize(childChunkSize uint) *SubDocumentRAG

func (*SubDocumentRAG) WithChunkOverlap

func (r *SubDocumentRAG) WithChunkOverlap(chunkOverlap uint) *SubDocumentRAG

func (*SubDocumentRAG) WithChunkSize

func (r *SubDocumentRAG) WithChunkSize(chunkSize uint) *SubDocumentRAG

func (*SubDocumentRAG) WithLoader

func (r *SubDocumentRAG) WithLoader(sourceRegexp *regexp.Regexp, loader Loader) *SubDocumentRAG

func (*SubDocumentRAG) WithTopK

func (r *SubDocumentRAG) WithTopK(topK uint) *SubDocumentRAG