gorag

May 11, 2026

Changes in this version

+ const GORAG_API_KEY

+ const GORAG_AUTH_TOKEN

+ const GORAG_BASE_URL

+ const GORAG_MODEL

+ const GORAG_MODEL_PATH

+ func CheckModel(modelId, modelFile string) (string, error)

+ func New(dataDir string, opts ...RAGOption) (core.Indexer, error)

+ func Open(dataDir string) (core.Indexer, error)

+ type Config struct

+ ModelFile string

+ Name string

+ Type string

+ type HybridIndexer struct

+ func NewHybridIndexer(logger logging.Logger, vectorStore core.VectorStore, ...) (*HybridIndexer, error)

+ func (h *HybridIndexer) Add(ctx context.Context, content string) (*core.Chunk, error)

+ func (h *HybridIndexer) AddFile(ctx context.Context, filePath string) (*core.Chunk, error)

+ func (h *HybridIndexer) AddIndexer(indexer core.Indexer, weight float32)

+ func (h *HybridIndexer) Close(ctx context.Context) error

+ func (h *HybridIndexer) GetIndexer(name string) (core.Indexer, bool)

+ func (h *HybridIndexer) GetWeights() map[string]float32

+ func (h *HybridIndexer) IndexChunk(ctx context.Context, chunk *core.Chunk) error

+ func (h *HybridIndexer) IndexChunks(ctx context.Context, chunks []*core.Chunk) error

+ func (h *HybridIndexer) ListIndexers() []string

+ func (h *HybridIndexer) Name() string

+ func (h *HybridIndexer) NewQuery(terms string) core.Query

+ func (h *HybridIndexer) Remove(ctx context.Context, chunkID string) error

+ func (h *HybridIndexer) RemoveIndexer(name string)

+ func (h *HybridIndexer) Search(ctx context.Context, query core.Query) ([]core.Hit, error)

+ func (h *HybridIndexer) Type() string

+ type HybridOption func(*HybridIndexer)

+ func WithCacheStore(cache core.CacheStore) HybridOption

+ func WithCacheStoreOrNil(dataDir string) HybridOption

+ type IndexingService struct

+ func NewRAGService(dataDir string, opts ...ServiceOption) (*IndexingService, error)

+ func (s *IndexingService) Index() error

+ func (s *IndexingService) Reindex(ctx context.Context, file string) error

+ func (s *IndexingService) Stop() error

+ func (s *IndexingService) Watch() error

type RAGOption

+ func WithIndexType(indexType string) RAGOption

+ func WithModelFile(modelFile string) RAGOption

+ type ServiceOption func(*IndexingService)

+ func WithLogger(logger logging.Logger) ServiceOption

+ func WithWatchs(dirs ...string) ServiceOption

+ func WithWorkerCount(count int) ServiceOption

Mar 25, 2026

Changes in this version

+ func CheckEnvironment(ctx context.Context) (bool, []string)

+ func PrepareEnvironment(ctx context.Context, ...) error

type RAG

+ func DefaultCRAG(opts ...RAGOption) (RAG, error)

+ func DefaultSelfRAG(opts ...RAGOption) (RAG, error)

type RAGConfig

+ EnableSemanticCache bool

+ GraphDepth int

+ GraphLimit int

+ MaxRetries int

+ Name string

+ SelfRAGThreshold float32

+ SemanticCacheType string

type RAGOption

+ func WithDepth(d int) RAGOption

+ func WithLimit(l int) RAGOption

+ func WithMaxRetries(r int) RAGOption

+ func WithMetrics(m core.Metrics) RAGOption

+ func WithName(name string) RAGOption

+ func WithSemanticCache(enable bool, cacheType ...string) RAGOption

+ func WithThreshold(t float32) RAGOption

+ func WithTracer(t observability.Tracer) RAGOption

+ func WithWebSearcher(s core.WebSearcher) RAGOption

Mar 22, 2026

Changes in this version

+ type RAG interface

+ Close func() error

+ Container func() *di.Container

+ IndexDirectory func(ctx context.Context, dirPath string, recursive bool) error

+ IndexFile func(ctx context.Context, filePath string) error

+ Search func(ctx context.Context, query string, topK int) (*core.RetrievalResult, error)

+ func DefaultAdvancedRAG(opts ...RAGOption) (RAG, error)

+ func DefaultAgenticRAG(opts ...RAGOption) (RAG, error)

+ func DefaultGraphRAG(opts ...RAGOption) (RAG, error)

+ func DefaultNativeRAG(opts ...RAGOption) (RAG, error)

+ type RAGConfig struct

+ APIKeyEnv string

+ BaseURL string

+ Dimension int

+ EmbedderType string

+ LLMType string

+ ModelName string

+ ModelPath string

+ TopK int

+ VectorDBType string

+ WorkDir string

+ type RAGOption func(*RAGConfig)

+ func WithAPIKeyEnv(name string) RAGOption

+ func WithBaseURL(url string) RAGOption

+ func WithContainer(ctr *di.Container) RAGOption

+ func WithDimension(dim int) RAGOption

+ func WithEmbedder(e embedding.Provider) RAGOption

+ func WithLLM(l gochat.Client) RAGOption

+ func WithModelName(name string) RAGOption

+ func WithModelPath(path string) RAGOption

+ func WithParsers(p ...core.Parser) RAGOption

+ func WithTopK(k int) RAGOption

+ func WithWorkDir(path string) RAGOption