draftrag

package

Go to main page

Versions in this module

v1

v1.0.0

Jul 14, 2026

Changes in this version

+ var Diff = domain.Diff

+ var ErrAllProvidersFailed = resilience.ErrAllProvidersFailed

+ var ErrMissingRequiredField = errors.New("missing required config field")

+ var ErrNilContext = errors.New("nil context")

+ var ErrSubDecomposeNotSupported = errors.New("sub-query decomposition not supported: no QueryDecomposer configured")

+ var ErrToolsNotSupportedInStream = errors.New("tool calling is not supported in streaming mode")

+ var ErrUnknownConfigKey = errors.New("unknown config key")

+ func LivenessHandler() http.HandlerFunc

+ func ReadinessHandler(hc *HealthChecker) http.HandlerFunc

+ func StartupHandler(hc *HealthChecker) http.HandlerFunc

+ type AnthropicLLMConfig struct

+ APIKey string

+ AnthropicVersion string

+ BaseURL string

+ MaxTokens *int

+ Model string

+ Temperature *float64

+ type BasicChunkerConfig struct

+ ChunkOverlap int

+ ChunkSize int

+ type BatchReranker = domain.BatchReranker

type CachedEmbedder

+ func (c *CachedEmbedder) Health(ctx context.Context) error

+ type ChromaDBStoreConfig struct

+ AuthToken string

+ BaseURL string

+ Collection string

+ Dimension int

type Chunker

+ func NewContextualChunker(opts ContextualChunkerOptions) (Chunker, error)

+ func NewSemanticChunker(opts SemanticChunkerOptions) (Chunker, error)

+ type ChunkerConfig struct

+ Basic *BasicChunkerConfig

+ Semantic *SemanticChunkerConfig

+ Type string

+ type CircuitBreakerConfig struct

+ MaxFailures int

+ ResetAfter time.Duration

+ type Closer = domain.Closer

+ type ComponentHealth struct

+ Health HealthCheckFunc

+ Name string

+ type Config struct

+ Chunker ChunkerConfig

+ CostTracking CostTrackingConfig

+ Embedder EmbedderConfig

+ LLM LLMConfig

+ Pipeline PipelineConfig

+ Reranker RerankerConfig

+ Resilience ResilienceConfig

+ Store StoreConfig

+ func LoadConfig(path string) (Config, error)

+ func LoadConfigFromEnv() (Config, error)

+ type ContextualChunkerOptions struct

+ Base Chunker

+ ContextKey string

+ Template string

+ type CostSnapshot = domain.CostSnapshot

+ type CostTracker struct

+ func NewCostTracker(llm LLMProvider, pricing map[string]ModelPricing) *CostTracker

+ func (ct *CostTracker) Checkpoint() CostSnapshot

+ func (ct *CostTracker) Generate(ctx context.Context, systemPrompt, userMessage string) (string, error)

+ func (ct *CostTracker) GenerateStream(ctx context.Context, systemPrompt, userMessage string) (<-chan string, error)

+ func (ct *CostTracker) Health(ctx context.Context) error

+ func (ct *CostTracker) Reset()

+ func (ct *CostTracker) SetDefaultModel(model string)

+ func (ct *CostTracker) Snapshot() CostSnapshot

+ type CostTrackingConfig struct

+ Enabled bool

+ type DeepSeekLLMConfig struct

+ APIKey string

+ BaseURL string

+ Model string

+ Timeout time.Duration

type Embedder

+ func NewTokenBucketEmbedder(emb Embedder, opts TokenBucketOptions) (Embedder, error)

+ type EmbedderConfig struct

+ Mistral *MistralEmbedderConfig

+ Ollama *OllamaEmbedderConfig

+ OpenAICompatible *OpenAICompatibleEmbedderConfig

+ Type string

+ type ExternalDeps struct

+ DB *sql.DB

+ HTTPClient *http.Client

+ type FallbackLLMProvider struct

+ func NewFallbackLLMProvider(providers []LLMProvider, logger Logger, hooks Hooks) (*FallbackLLMProvider, error)

+ type FallbackStats = resilience.FallbackStats

+ type FallbackStreamingLLMProvider struct

+ func NewFallbackStreamingLLMProvider(providers []StreamingLLMProvider, logger Logger, hooks Hooks) (*FallbackStreamingLLMProvider, error)

+ type FallbackUsageAwareLLMProvider struct

+ func NewFallbackUsageAwareLLMProvider(providers []UsageAwareLLMProvider, logger Logger, hooks Hooks) (*FallbackUsageAwareLLMProvider, error)

+ type Handler = domain.Handler

+ type HealthCheckFunc func(context.Context) error

+ type HealthChecker struct

+ func NewHealthChecker(components ...ComponentHealth) *HealthChecker

+ func (hc *HealthChecker) Check(ctx context.Context) *HealthCheckerResult

+ func (hc *HealthChecker) Register(component ComponentHealth)

+ type HealthCheckerResult struct

+ Error string

+ Healthy bool

+ Name string

+ type LLMConfig struct

+ Anthropic *AnthropicLLMConfig

+ DeepSeek *DeepSeekLLMConfig

+ Mistral *MistralLLMConfig

+ Ollama *OllamaLLMConfig

+ OpenAICompatible *OpenAICompatibleLLMConfig

+ Type string

type LLMProvider

+ func NewTokenBucketLLMProvider(llm LLMProvider, opts TokenBucketOptions) (LLMProvider, error)

+ type LLMReranker = reranker.LLMReranker

+ func NewLLMReranker(llm LLMProvider, opts ...LLMRerankerOption) (*LLMReranker, error)

+ type LLMRerankerConfig struct

+ BatchSize int

+ MaxRetries int

+ type LLMRerankerOption interface

+ func WithBatchSize(n int) LLMRerankerOption

+ func WithMaxRetries(n int) LLMRerankerOption

+ func WithPromptTemplate(tmpl string) LLMRerankerOption

+ type MemoryStoreConfig struct

+ type Middleware = domain.Middleware

+ func NewLoggingMiddleware() Middleware

+ func NewPIIDetectorMiddleware(detector PIIDetector) Middleware

+ type MilvusStoreConfig struct

+ Address string

+ Collection string

+ Dimension int

+ Password string

+ User string

+ type MistralEmbedderConfig struct

+ APIKey string

+ Model string

+ Timeout time.Duration

+ type MistralLLMConfig struct

+ APIKey string

+ BaseURL string

+ Model string

+ Timeout time.Duration

+ type ModelPricing = domain.ModelPricing

+ type OllamaEmbedderConfig struct

+ APIKey string

+ BaseURL string

+ Model string

+ Timeout time.Duration

+ type OllamaLLMConfig struct

+ APIKey string

+ BaseURL string

+ Model string

+ Timeout time.Duration

+ type OpenAICompatibleEmbedderConfig struct

+ APIKey string

+ BaseURL string

+ Model string

+ Timeout time.Duration

+ type OpenAICompatibleLLMConfig struct

+ APIKey string

+ BaseURL string

+ Model string

+ Timeout time.Duration

+ type PIICategories = piidetector.PIICategories

+ type PIIDetector = domain.PIIDetector

+ func NewCompositePIIDetector(detectors ...PIIDetector) PIIDetector

+ func NewDefaultPIIDetector(cats PIICategories) PIIDetector

+ type ParentDocumentStore = domain.ParentDocumentStore

+ type PgvectorStoreConfig struct

+ CreateExtension bool

+ EmbeddingDimension int

+ IndexMethod string

+ Lists int

+ TableName string

+ type PineconeOptions struct

+ APIKey string

+ Cloud string

+ Dimension int

+ Environment string

+ IndexName string

+ ProjectID string

+ Region string

+ Timeout time.Duration

+ func (o PineconeOptions) Validate() error

type Pipeline

+ func NewPipelineFromConfig(_ context.Context, cfg Config, deps ...ExternalDeps) (*Pipeline, error)

+ func (p *Pipeline) Close() error

+ func (p *Pipeline) Health(ctx context.Context) error

+ type PipelineConfig struct

+ DedupByParentID bool

+ DefaultTopK int

+ IndexBatchRateLimit int

+ IndexBatchRateLimitPerWorker bool

+ IndexConcurrency int

+ MMRCandidatePool int

+ MMREnabled bool

+ MMRLambda float64

+ MaxContextChars int

+ MaxContextChunks int

+ StreamBufferSize int

+ SystemPrompt string

type PipelineOptions

+ Middleware []Middleware

+ PIIDetector PIIDetector

+ ParentContextEnabled *bool

+ QueryDecomposer QueryDecomposer

+ QueryRewriter QueryRewriter

+ type QdrantStoreConfig struct

+ Collection string

+ Dimension int

+ Timeout time.Duration

+ URL string

+ type QueryDecomposer = domain.QueryDecomposer

+ func NewLLMQueryDecomposer(llm LLMProvider, promptTemplate string) (QueryDecomposer, error)

+ func NewRuleQueryDecomposer() QueryDecomposer

+ type QueryHistory = domain.QueryHistory

+ type QueryRewriter = domain.QueryRewriter

+ func NewLLMRewriter(llm LLMProvider, promptTemplate string) (QueryRewriter, error)

+ type RerankerConfig struct

+ LLM *LLMRerankerConfig

+ Type string

+ type ResilienceConfig struct

+ CircuitBreaker *CircuitBreakerConfig

+ Retry *RetryConfig

+ type RetryConfig struct

+ BaseDelay time.Duration

+ MaxAttempts int

+ MaxDelay time.Duration

+ type RewrittenQuery = domain.RewrittenQuery

type SearchBuilder

+ func (b *SearchBuilder) History(h QueryHistory) *SearchBuilder

+ func (b *SearchBuilder) Rewriter(r QueryRewriter) *SearchBuilder

+ func (b *SearchBuilder) SubDecompose() *SearchBuilder

+ func (b *SearchBuilder) ToolHandler(h func(ToolCall) ToolResult) *SearchBuilder

+ func (b *SearchBuilder) Tools(tools []ToolDefinition) *SearchBuilder

+ type SemanticChunkerConfig struct

+ MaxChunkSize int

+ MinChunkSize int

+ SimilarityThreshold float64

+ type SemanticChunkerOptions struct

+ Embedder Embedder

+ MaxChunkSize int

+ MinChunkSize int

+ SimilarityThreshold float64

+ type StageData = domain.StageData

+ type StoreConfig struct

+ ChromaDB *ChromaDBStoreConfig

+ Memory *MemoryStoreConfig

+ Milvus *MilvusStoreConfig

+ Pgvector *PgvectorStoreConfig

+ Qdrant *QdrantStoreConfig

+ Type string

+ Weaviate *WeaviateStoreConfig

type StreamingLLMProvider

+ func NewTokenBucketStreamingLLMProvider(llm StreamingLLMProvider, opts TokenBucketOptions) (StreamingLLMProvider, error)

+ type TokenBucketOptions struct

+ BurstSize float64

+ TokensPerSecond float64

+ type TokenUsage = domain.TokenUsage

+ type ToolCall = domain.ToolCall

+ type ToolCallingLLMProvider = domain.ToolCallingLLMProvider

+ type ToolDefinition = domain.ToolDefinition

+ type ToolResult = domain.ToolResult

+ type UsageAwareLLMProvider = domain.UsageAwareLLMProvider

+ type UsageAwareStreamingLLMProvider = domain.UsageAwareStreamingLLMProvider

type VectorStore

+ func NewPineconeStore(opts PineconeOptions) (VectorStore, error)

+ type WeaviateStoreConfig struct

+ APIKey string

+ Collection string

+ Host string

+ Scheme string

v0

v0.2.0

Jun 10, 2026

Changes in this version

+ var ErrUpdateNotAtomic = domain.ErrUpdateNotAtomic

+ func GetChromaCollectionUUID(ctx context.Context, opts ChromaDBOptions) (string, error)

type CachedEmbedder

+ func NewRedisCache(ctx context.Context, e Embedder, client RedisClient, ttl time.Duration) (*CachedEmbedder, error)

type ChromaDBOptions

+ CollectionUUID string

+ type DeepSeekLLMOptions struct

+ APIKey string

+ BaseURL string

+ HTTPClient *http.Client

+ MaxTokens *int

+ Model string

+ Temperature *float64

+ Timeout time.Duration

type Embedder

+ func NewMistralEmbedder(opts MistralEmbedderOptions) Embedder

type LLMProvider

+ func NewDeepSeekLLM(opts DeepSeekLLMOptions) LLMProvider

+ func NewMistralLLM(opts MistralLLMOptions) LLMProvider

+ type MistralEmbedderOptions struct

+ APIKey string

+ BaseURL string

+ HTTPClient *http.Client

+ Model string

+ Timeout time.Duration

+ type MistralLLMOptions struct

+ APIKey string

+ BaseURL string

+ HTTPClient *http.Client

+ MaxTokens *int

+ Model string

+ Temperature *float64

+ Timeout time.Duration

type PipelineOptions

+ DedupByParentID bool

+ IndexBatchRateLimitPerWorker bool

+ StreamBufferSize int

+ type RedisClient = cache.RedisClient

+ type TransactionalDocumentStore = domain.TransactionalDocumentStore

+ type TransactionalTx = domain.TransactionalTx

v0.1.0

Apr 16, 2026

Changes in this version

+ const CircuitClosed

+ const CircuitHalfOpen

+ const CircuitOpen

+ const HookStageChunking

+ const HookStageEmbed

+ const HookStageGenerate

+ const HookStageSearch

+ const LogLevelDebug

+ const LogLevelError

+ const LogLevelInfo

+ const LogLevelWarn

+ var DefaultHybridConfig = domain.DefaultHybridConfig

+ var ErrCircuitOpen = resilience.ErrCircuitOpen

+ var ErrDeleteNotSupported = errors.New("vector store does not support DeleteByParentID")

+ var ErrEmbeddingDimensionMismatch = domain.ErrEmbeddingDimensionMismatch

+ var ErrEmptyDocument = errors.New("empty document")

+ var ErrEmptyDocumentID = errors.New("document ID must not be empty")

+ var ErrEmptyQuery = errors.New("empty query")

+ var ErrFiltersNotSupported = errors.New("filters not supported")

+ var ErrHybridNotSupported = errors.New("vector store does not support hybrid search")

+ var ErrInvalidChunkerConfig = errors.New("invalid chunker config")

+ var ErrInvalidEmbedderConfig = errors.New("invalid embedder config")

+ var ErrInvalidLLMConfig = errors.New("invalid llm config")

+ var ErrInvalidTopK = errors.New("invalid topK")

+ var ErrInvalidVectorStoreConfig = errors.New("invalid vector store config")

+ var ErrStreamingNotSupported = errors.New("LLM provider does not support streaming")

+ var IsRetryable = resilience.IsRetryable

+ var WrapNonRetryable = resilience.WrapNonRetryable

+ var WrapRetryable = resilience.WrapRetryable

+ func ChromaCollectionExists(ctx context.Context, opts ChromaDBOptions) (bool, error)

+ func CollectionExists(ctx context.Context, opts QdrantOptions) (bool, error)

+ func CreateChromaCollection(ctx context.Context, opts ChromaDBOptions) error

+ func CreateCollection(ctx context.Context, opts QdrantOptions) error

+ func CreateWeaviateCollection(ctx context.Context, opts WeaviateOptions) error

+ func DeleteChromaCollection(ctx context.Context, opts ChromaDBOptions) error

+ func DeleteCollection(ctx context.Context, opts QdrantOptions) error

+ func DeleteWeaviateCollection(ctx context.Context, opts WeaviateOptions) error

+ func MigratePGVector(ctx context.Context, db *sql.DB, opts PGVectorMigrateOptions) error

+ func SetupPGVector(ctx context.Context, db *sql.DB, opts PGVectorOptions) error

+ func WeaviateCollectionExists(ctx context.Context, opts WeaviateOptions) (bool, error)

+ type AnthropicLLMOptions struct

+ APIKey string

+ AnthropicVersion string

+ BaseURL string

+ HTTPClient *http.Client

+ MaxTokens *int

+ Model string

+ Temperature *float64

+ Timeout time.Duration

+ type BasicChunkerOptions struct

+ ChunkSize int

+ MaxChunks int

+ Overlap int

+ type CacheOptions struct

+ Logger Logger

+ MaxSize int

+ Redis RedisCacheOptions

+ type CachedEmbedder struct

+ func NewCachedEmbedder(e Embedder, opts CacheOptions) (*CachedEmbedder, error)

+ func (c *CachedEmbedder) Embed(ctx context.Context, text string) ([]float64, error)

+ func (c *CachedEmbedder) Stats() EmbedCacheStats

+ type ChromaDBOptions struct

+ BaseURL string

+ Collection string

+ Dimension int

+ Timeout time.Duration

+ func (o ChromaDBOptions) Validate() error

+ type Chunk = domain.Chunk

+ type Chunker = domain.Chunker

+ func NewBasicChunker(opts BasicChunkerOptions) Chunker

+ type CircuitBreakerStats = resilience.Stats

+ type CircuitState = resilience.CircuitState

+ type Document = domain.Document

+ type DocumentStore = domain.DocumentStore

+ type EmbedCacheStats = cache.Stats

+ type Embedder = domain.Embedder

+ func NewOllamaEmbedder(opts OllamaEmbedderOptions) Embedder

+ func NewOpenAICompatibleEmbedder(opts OpenAICompatibleEmbedderOptions) Embedder

+ type HookStage = domain.HookStage

+ type Hooks = domain.Hooks

+ type HybridConfig = domain.HybridConfig

+ type HybridSearcher = domain.HybridSearcher

+ type IndexBatchError = domain.IndexBatchError

+ type IndexBatchResult = domain.IndexBatchResult

+ type InlineCitation = domain.InlineCitation

+ type LLMProvider = domain.LLMProvider

+ func NewAnthropicLLM(opts AnthropicLLMOptions) LLMProvider

+ func NewOllamaLLM(opts OllamaLLMOptions) LLMProvider

+ func NewOpenAICompatibleLLM(opts OpenAICompatibleLLMOptions) LLMProvider

+ type LogField = domain.LogField

+ type LogLevel = domain.LogLevel

+ type Logger = domain.Logger

+ type MetadataFilter = domain.MetadataFilter

+ type OllamaEmbedderOptions struct

+ APIKey string

+ BaseURL string

+ HTTPClient *http.Client

+ Model string

+ Timeout time.Duration

+ type OllamaLLMOptions struct

+ APIKey string

+ BaseURL string

+ HTTPClient *http.Client

+ MaxTokens *int

+ Model string

+ Temperature *float64

+ Timeout time.Duration

+ type OpenAICompatibleEmbedderOptions struct

+ APIKey string

+ BaseURL string

+ HTTPClient *http.Client

+ Model string

+ Timeout time.Duration

+ type OpenAICompatibleLLMOptions struct

+ APIKey string

+ BaseURL string

+ HTTPClient *http.Client

+ MaxOutputTokens *int

+ Model string

+ Temperature *float64

+ Timeout time.Duration

+ type PGVectorMigrateOptions struct

+ DDLTimeout time.Duration

+ type PGVectorOptions struct

+ CreateExtension bool

+ EmbeddingDimension int

+ IndexMethod string

+ Lists int

+ TableName string

+ type PGVectorRuntimeOptions struct

+ DeleteTimeout time.Duration

+ MaxContentBytes int

+ MaxParentIDs int

+ MaxTopK int

+ SearchTimeout time.Duration

+ UpsertTimeout time.Duration

+ type PGVectorStoreOptions struct

+ Runtime PGVectorRuntimeOptions

+ type ParentIDFilter = domain.ParentIDFilter

+ type Pipeline struct

+ func NewPipeline(store VectorStore, llm LLMProvider, embedder Embedder) *Pipeline

+ func NewPipelineWithChunker(store VectorStore, llm LLMProvider, embedder Embedder, chunker Chunker) *Pipeline

+ func NewPipelineWithOptions(store VectorStore, llm LLMProvider, embedder Embedder, opts PipelineOptions) *Pipeline

+ func (p *Pipeline) Answer(ctx context.Context, question string) (string, error)

+ func (p *Pipeline) DeleteDocument(ctx context.Context, docID string) error

+ func (p *Pipeline) Index(ctx context.Context, docs []Document) error

+ func (p *Pipeline) IndexBatch(ctx context.Context, docs []Document, batchSize int) (*IndexBatchResult, error)

+ func (p *Pipeline) Query(ctx context.Context, question string) (RetrievalResult, error)

+ func (p *Pipeline) Retrieve(ctx context.Context, question string, topK int) (RetrievalResult, error)

+ func (p *Pipeline) Search(question string) *SearchBuilder

+ func (p *Pipeline) UpdateDocument(ctx context.Context, doc Document) error

+ type PipelineOptions struct

+ Chunker Chunker

+ DedupSourcesByParentID bool

+ DefaultTopK int

+ Hooks Hooks

+ IndexBatchRateLimit int

+ IndexConcurrency int

+ MMRCandidatePool int

+ MMREnabled bool

+ MMRLambda float64

+ MaxContextChars int

+ MaxContextChunks int

+ Reranker Reranker

+ SystemPrompt string

+ type QdrantOptions struct

+ Collection string

+ Dimension int

+ Timeout time.Duration

+ URL string

+ func (o QdrantOptions) Validate() error

+ type RedisCacheClient interface

+ GetBytes func(ctx context.Context, key string) ([]byte, error)

+ SetBytes func(ctx context.Context, key string, value []byte, ttl time.Duration) error

+ type RedisCacheOptions struct

+ Client RedisCacheClient

+ KeyPrefix string

+ TTL time.Duration

+ type Reranker = domain.Reranker

+ type RetrievalResult = domain.RetrievalResult

+ type RetryEmbedder struct

+ func NewRetryEmbedder(e Embedder, opts RetryOptions) *RetryEmbedder

+ type RetryLLMProvider struct

+ func NewRetryLLMProvider(l LLMProvider, opts RetryOptions) *RetryLLMProvider

+ type RetryOptions struct

+ BaseDelay time.Duration

+ CBThreshold int

+ CBTimeout time.Duration

+ JitterFactor float64

+ Logger Logger

+ MaxDelay time.Duration

+ MaxRetries int

+ Multiplier float64

+ type SearchBuilder struct

+ func (b *SearchBuilder) Answer(ctx context.Context) (string, error)

+ func (b *SearchBuilder) Cite(ctx context.Context) (string, RetrievalResult, error)

+ func (b *SearchBuilder) Filter(f MetadataFilter) *SearchBuilder

+ func (b *SearchBuilder) HyDE() *SearchBuilder

+ func (b *SearchBuilder) Hybrid(cfg HybridConfig) *SearchBuilder

+ func (b *SearchBuilder) InlineCite(ctx context.Context) (string, RetrievalResult, []InlineCitation, error)

+ func (b *SearchBuilder) MultiQuery(n int) *SearchBuilder

+ func (b *SearchBuilder) ParentIDs(ids ...string) *SearchBuilder

+ func (b *SearchBuilder) Retrieve(ctx context.Context) (RetrievalResult, error)

+ func (b *SearchBuilder) Stream(ctx context.Context) (<-chan string, error)

+ func (b *SearchBuilder) StreamCite(ctx context.Context) (<-chan string, RetrievalResult, []InlineCitation, error)

+ func (b *SearchBuilder) StreamSources(ctx context.Context) (<-chan string, RetrievalResult, error)

+ func (b *SearchBuilder) TopK(n int) *SearchBuilder

+ type StageEndEvent = domain.StageEndEvent

+ type StageStartEvent = domain.StageStartEvent

+ type StreamingLLMProvider = domain.StreamingLLMProvider

+ type VectorStore = domain.VectorStore

+ func NewChromaDBStore(opts ChromaDBOptions) (VectorStore, error)

+ func NewInMemoryStore() VectorStore

+ func NewPGVectorStore(db *sql.DB, opts PGVectorOptions) VectorStore

+ func NewPGVectorStoreWithOptions(db *sql.DB, opts PGVectorStoreOptions) VectorStore

+ func NewPGVectorStoreWithRuntimeOptions(db *sql.DB, opts PGVectorOptions, runtime PGVectorRuntimeOptions) VectorStore

+ func NewQdrantStore(opts QdrantOptions) (VectorStore, error)

+ func NewWeaviateStore(opts WeaviateOptions) (VectorStore, error)

+ type VectorStoreWithFilters = domain.VectorStoreWithFilters

+ type WeaviateOptions struct

+ APIKey string

+ Collection string

+ Host string

+ Scheme string

+ Timeout time.Duration

+ func (o WeaviateOptions) Validate() error

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