rag

package

Go to main page

Versions in this module

v1

v1.0.2

Mar 9, 2026

Changes in this version

type Cache

+ Close func() error

type ContextCompressor

+ func (c *ContextCompressor) WithMinRelevanceScore(score float32) *ContextCompressor

type Engine

+ func (e *Engine) StartWatchWithContext(ctx context.Context, targetIndexDir string) error

type MemoryCache

+ func (c *MemoryCache) Close() error

v1.0.1

Mar 9, 2026

Changes in this version

type Engine

+ func (e *Engine) RecordIndexedDocuments(ctx context.Context, count int)

+ func (e *Engine) RecordIndexingDocuments(ctx context.Context, count int)

+ func (e *Engine) RecordMonitoredDocuments(ctx context.Context, count int)

+ func (e *Engine) RecordSystemMetrics(ctx context.Context, cpuUsage float64, memoryUsage float64)

+ func (e *Engine) ReindexFile(ctx context.Context, filePath string, sourceType string) error

+ func (e *Engine) StartWatch(targetIndexDir string) error

+ func (e *Engine) StartWatchAsync(targetIndexDir string) error

type Option

+ func WithBatchProcessor(batchSize, maxWorkers int, rateLimit time.Duration) Option

+ func WithCircuitBreaker(maxFailures int, timeout time.Duration, halfOpenMax int) Option

+ func WithConnectionPool(maxConns, idleConns int, idleTimeout time.Duration) Option

+ func WithPluginConfig(config map[string]interface{}) Option

+ func WithPluginDirectory(directory string) Option

+ func WithQueryCache(ttl time.Duration, maxSize int) Option

+ type PluginOptions struct

+ PluginConfig map[string]interface{}

+ PluginDirectory string

v1.0.0

Mar 8, 2026

v0

v0.6.0

Mar 7, 2026

Changes in this version

+ type ComponentHealth struct

+ Details map[string]string

+ Error string

+ Latency time.Duration

+ Name string

+ Status HealthStatus

+ type ContextCompressor struct

+ func NewContextCompressor(llm llm.Client) *ContextCompressor

+ func (c *ContextCompressor) Compress(ctx context.Context, query string, results []core.Result) ([]core.Result, error)

+ func (c *ContextCompressor) WithMaxContextSize(size int) *ContextCompressor

+ func (c *ContextCompressor) WithSimilarityThreshold(threshold float32) *ContextCompressor

+ func (c *ContextCompressor) WithSummaryPrompt(prompt string) *ContextCompressor

+ type Conversation struct

+ CreatedAt time.Time

+ ID string

+ Messages []Message

+ UpdatedAt time.Time

+ func NewConversation() *Conversation

+ func (c *Conversation) AddMessage(role, content string)

+ func (c *Conversation) GetContext(maxMessages int) string

+ func (c *Conversation) GetRecentMessages(max int) []Message

+ type ConversationManager struct

+ func NewConversationManager() *ConversationManager

+ func (cm *ConversationManager) CreateConversation() *Conversation

+ func (cm *ConversationManager) DeleteConversation(id string)

+ func (cm *ConversationManager) GetConversation(id string) *Conversation

+ func (cm *ConversationManager) ListConversations() []*Conversation

+ func (cm *ConversationManager) UpdateConversation(conv *Conversation)

+ type ConversationOptions struct

+ ConversationID string

+ MaxHistory int

+ PromptTemplate string

type Engine

+ func (e *Engine) AddParser(format string, p parser.Parser)

+ func (e *Engine) AsyncIndexDirectory(ctx context.Context, directoryPath string) error

+ func (e *Engine) Debug(ctx context.Context, message string, fields map[string]interface{})

+ func (e *Engine) Error(ctx context.Context, message string, err error, fields map[string]interface{})

+ func (e *Engine) Extract(ctx context.Context) (observability.Span, bool)

+ func (e *Engine) Get(ctx context.Context, key string) (*query.Response, bool)

+ func (e *Engine) IndexDirectory(ctx context.Context, directoryPath string) error

+ func (e *Engine) Info(ctx context.Context, message string, fields map[string]interface{})

+ func (e *Engine) QueryWithConversation(ctx context.Context, question string, opts ConversationOptions) (*Response, error)

+ func (e *Engine) RecordErrorCount(ctx context.Context, errorType string)

+ func (e *Engine) RecordIndexCount(ctx context.Context, status string)

+ func (e *Engine) RecordIndexLatency(ctx context.Context, duration time.Duration)

+ func (e *Engine) RecordQueryCount(ctx context.Context, status string)

+ func (e *Engine) RecordQueryLatency(ctx context.Context, duration time.Duration)

+ func (e *Engine) Set(ctx context.Context, key string, value *query.Response, ...)

+ func (e *Engine) SetDefaultParser(p parser.Parser)

+ func (e *Engine) StartSpan(ctx context.Context, name string) (context.Context, observability.Span)

+ func (e *Engine) Warn(ctx context.Context, message string, fields map[string]interface{})

+ type HealthChecker struct

+ func NewHealthChecker(engine *Engine) *HealthChecker

+ func (h *HealthChecker) Check(ctx context.Context) *HealthReport

+ func (h *HealthChecker) WithTimeout(timeout time.Duration) *HealthChecker

+ func (h *HealthChecker) WithVersion(version string) *HealthChecker

+ type HealthReport struct

+ Components []ComponentHealth

+ Status HealthStatus

+ Timestamp time.Time

+ Uptime time.Duration

+ Version string

+ type HealthStatus string

+ const HealthStatusDegraded

+ const HealthStatusDown

+ const HealthStatusUp

+ type HyDE struct

+ func NewHyDE(llm llm.Client) *HyDE

+ func (h *HyDE) EnhanceQuery(ctx context.Context, query string) (string, error)

+ func (h *HyDE) WithPromptTemplate(template string) *HyDE

+ type Message struct

+ Content string

+ ID string

+ Role string

+ Timestamp time.Time

type Option

+ func WithAgenticRAG(agentic *retrieval.AgenticRAG) Option

+ func WithContextCompressor(c *ContextCompressor) Option

+ func WithConversationManager(cm *ConversationManager) Option

+ func WithHyDE(h *HyDE) Option

+ func WithMultiHopRAG(multiHop *retrieval.MultiHopRAG) Option

+ func WithParsers(parsers map[string]parser.Parser) Option

+ type Progress struct

+ CurrentFile string

+ EndTime *time.Time

+ Error string

+ FailedFiles []string

+ ID string

+ ProcessedFiles int

+ StartTime time.Time

+ Status ProgressStatus

+ TotalFiles int

+ func NewProgress(id string, totalFiles int) *Progress

+ func (p *Progress) AddFailedFile(file string)

+ func (p *Progress) Cancel()

+ func (p *Progress) Complete()

+ func (p *Progress) Duration() time.Duration

+ func (p *Progress) Fail(err error)

+ func (p *Progress) IncrementProcessed()

+ func (p *Progress) IsComplete() bool

+ func (p *Progress) Percentage() float64

+ func (p *Progress) SetCurrentFile(file string)

+ func (p *Progress) Snapshot() ProgressSnapshot

+ func (p *Progress) Start()

+ type ProgressChannel struct

+ Progress *Progress

+ Updates chan ProgressSnapshot

+ func NewProgressChannel(ctx context.Context, progress *Progress) *ProgressChannel

+ func (pc *ProgressChannel) Close()

+ func (pc *ProgressChannel) Send()

+ func (pc *ProgressChannel) Watch() <-chan ProgressSnapshot

+ type ProgressSnapshot struct

+ CurrentFile string

+ EndTime *time.Time

+ Error string

+ FailedFiles []string

+ ID string

+ ProcessedFiles int

+ StartTime time.Time

+ Status ProgressStatus

+ TotalFiles int

+ type ProgressStatus string

+ const ProgressStatusCancelled

+ const ProgressStatusCompleted

+ const ProgressStatusFailed

+ const ProgressStatusPending

+ const ProgressStatusRunning

+ type ProgressTracker struct

+ func NewProgressTracker() *ProgressTracker

+ func (t *ProgressTracker) Cleanup(maxAge time.Duration) int

+ func (t *ProgressTracker) Create(id string, totalFiles int) *Progress

+ func (t *ProgressTracker) Delete(id string)

+ func (t *ProgressTracker) Get(id string) (*Progress, bool)

+ func (t *ProgressTracker) List() []ProgressSnapshot

type QueryOptions

+ AgentInstructions string

+ MaxHops int

+ UseAgenticRAG bool

+ UseMultiHopRAG bool

v0.5.0

Mar 6, 2026

v0.3.0

Mar 6, 2026

Changes in this version

+ type Cache interface

+ Clear func(ctx context.Context)

+ Delete func(ctx context.Context, key string)

+ Get func(ctx context.Context, key string) (*Response, bool)

+ Set func(ctx context.Context, key string, value *Response, expiration time.Duration)

+ type DefaultRouter struct

+ func NewDefaultRouter() *DefaultRouter

+ func (r *DefaultRouter) Route(ctx context.Context, query string) (RouteResult, error)

+ type Engine struct

+ func New(opts ...Option) (*Engine, error)

+ func (e *Engine) AsyncBatchIndex(ctx context.Context, sources []Source) error

+ func (e *Engine) AsyncIndex(ctx context.Context, source Source) error

+ func (e *Engine) BatchIndex(ctx context.Context, sources []Source) error

+ func (e *Engine) BatchQuery(ctx context.Context, questions []string, opts QueryOptions) ([]*Response, error)

+ func (e *Engine) Index(ctx context.Context, source Source) error

+ func (e *Engine) Query(ctx context.Context, question string, opts QueryOptions) (*Response, error)

+ func (e *Engine) QueryStream(ctx context.Context, question string, opts QueryOptions) (<-chan StreamResponse, error)

+ type MemoryCache struct

+ func NewMemoryCache(expiry time.Duration) *MemoryCache

+ func (c *MemoryCache) Clear(ctx context.Context)

+ func (c *MemoryCache) Delete(ctx context.Context, key string)

+ func (c *MemoryCache) Get(ctx context.Context, key string) (*Response, bool)

+ func (c *MemoryCache) Set(ctx context.Context, key string, value *Response, expiration time.Duration)

+ type Option func(*Engine)

+ func WithCache(c Cache) Option

+ func WithEmbedder(e embedding.Provider) Option

+ func WithLLM(l llm.Client) Option

+ func WithLogger(l observability.Logger) Option

+ func WithMetrics(m observability.Metrics) Option

+ func WithParser(p parser.Parser) Option

+ func WithReranker(r *retrieval.Reranker) Option

+ func WithRetriever(r *retrieval.HybridRetriever) Option

+ func WithRouter(r Router) Option

+ func WithTracer(t observability.Tracer) Option

+ func WithVectorStore(s vectorstore.Store) Option

+ type QueryOptions struct

+ PromptTemplate string

+ Stream bool

+ TopK int

+ type Response struct

+ Answer string

+ Sources []vectorstore.Result

+ type RouteResult struct

+ Params map[string]interface{}

+ Type string

+ type Router interface

+ Route func(ctx context.Context, query string) (RouteResult, error)

+ type Source struct

+ Content string

+ Path string

+ Reader interface{}

+ Type string

+ type StreamResponse struct

+ Chunk string

+ Done bool

+ Error error

+ Sources []vectorstore.Result

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL