mirror of
https://github.com/infiniflow/ragflow.git
synced 2026-08-06 07:34:04 +08:00
197b142cef
## What Adds [**SereneDB**](https://serenedb.com) as a selectable doc-store engine on **both** RAGFlow paths: - the **Go** `DocEngine` (`internal/engine/serenedb`), alongside Elasticsearch and Infinity; - the **Python** `DocStoreConnection` (`rag/utils/serenedb_conn.py`) + `DOC_ENGINE=serenedb` registration. SereneDB is a PostgreSQL-wire engine (DuckDB execution) whose single inverted index carries **both** a scored text column (`@@`, BM25) and an IVF vector column (`<#>`, inner product), so hybrid search is one SQL statement. The Go engine connects with `database/sql` + `lib/pq` (already a dependency, no new module); the Python connector uses psycopg2 (already a dependency). ## Storage model One table per tenant with `kb_id` as a filter column - the **Elasticsearch / OceanBase** model, not Infinity's per-dataset tables. This keeps BM25 statistics (IDF, avgdl) computed over the whole tenant corpus (global IDF). Both connectors use this identical layout, so they are storage- and retrieval-compatible: `hybrid` proxy routing and Python↔Go switching are safe. On the Python side the connector is wired as OceanBase's plain-SQL sibling (chunk_data JSON metadata, inline chunk vectors, verbatim ES field names); the ES tokenizer path is unchanged. Metadata stays one table per tenant (`ragflow_doc_meta_<tenant>`). The query shapes mirror the Python connector, including the five empirically-found landmines: the scored dictionary needs `frequency + norm` (else `BM25()` silently returns 0.0), the `@@` query is the tokenized query, the scored lexical branch matches one column, vectors use an L2-normalized shadow column with `ip`/`sq8`, and the similarity threshold goes directly in the ANN scan's `WHERE`. **Minimum engine version: SereneDB 26.07.4.** --------- Co-authored-by: Claude Opus 4.8 <noreply@anthropic.com>
118 lines
3.0 KiB
Go
118 lines
3.0 KiB
Go
//
|
|
// Copyright 2026 The InfiniFlow Authors. All Rights Reserved.
|
|
//
|
|
// Licensed under the Apache License, Version 2.0 (the "License");
|
|
// you may not use this file except in compliance with the License.
|
|
// You may obtain a copy of the License at
|
|
//
|
|
// http://www.apache.org/licenses/LICENSE-2.0
|
|
//
|
|
// Unless required by applicable law or agreed to in writing, software
|
|
// distributed under the License is distributed on an "AS IS" BASIS,
|
|
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
// See the License for the specific language governing permissions and
|
|
// limitations under the License.
|
|
//
|
|
|
|
package engine
|
|
|
|
import (
|
|
"fmt"
|
|
"ragflow/internal/common"
|
|
"ragflow/internal/engine/nats"
|
|
"ragflow/internal/server"
|
|
"sync"
|
|
|
|
"ragflow/internal/engine/elasticsearch"
|
|
"ragflow/internal/engine/infinity"
|
|
"ragflow/internal/engine/serenedb"
|
|
|
|
"ragflow/internal/tokenizer"
|
|
|
|
"go.uber.org/zap"
|
|
)
|
|
|
|
var (
|
|
globalEngine DocEngine
|
|
engineType string
|
|
messageQueueEngine MessageQueue
|
|
once sync.Once
|
|
)
|
|
|
|
// InitDocEngine initializes document engine
|
|
func InitDocEngine() error {
|
|
|
|
var initErr error
|
|
once.Do(func() {
|
|
globalConfig := server.GetConfig()
|
|
engineType = globalConfig.DocEngineType()
|
|
tokenizer.SetEngineType(engineType)
|
|
var err error
|
|
switch engineType {
|
|
case "elasticsearch":
|
|
globalEngine, err = elasticsearch.NewEngine(globalConfig.GetElasticsearchConfig())
|
|
case "infinity":
|
|
globalEngine, err = infinity.NewEngine(globalConfig.GetInfinityConfig())
|
|
case "serenedb":
|
|
globalEngine, err = serenedb.NewEngine(globalConfig.GetSereneDBConfig())
|
|
default:
|
|
err = fmt.Errorf("unsupported doc engine type: %s", engineType)
|
|
}
|
|
|
|
if err != nil {
|
|
initErr = fmt.Errorf("failed to create doc engine: %w", err)
|
|
return
|
|
}
|
|
common.Info("Doc engine initialized", zap.String("type", engineType))
|
|
})
|
|
return initErr
|
|
}
|
|
|
|
// GetEngineType returns the document engine type
|
|
func GetEngineType() string {
|
|
return engineType
|
|
}
|
|
|
|
// Get gets global document engine instance
|
|
func Get() DocEngine {
|
|
return globalEngine
|
|
}
|
|
|
|
// Close closes document engine
|
|
func Close() error {
|
|
if globalEngine != nil {
|
|
return globalEngine.Close()
|
|
}
|
|
return nil
|
|
}
|
|
|
|
func GetMessageQueueEngine() MessageQueue {
|
|
return messageQueueEngine
|
|
}
|
|
|
|
// SetMessageQueueEngine installs the global message-queue engine. It exists
|
|
// primarily as a test seam so callers can drive Start() without a real server
|
|
// config; production code uses InitMessageQueue.
|
|
func SetMessageQueueEngine(mq MessageQueue) {
|
|
messageQueueEngine = mq
|
|
}
|
|
|
|
func InitMessageQueue() error {
|
|
globalConfig := server.GetConfig()
|
|
messageQueueType := globalConfig.QueueEngineType()
|
|
switch messageQueueType {
|
|
case "nats":
|
|
natsConfig := globalConfig.GetNATSConfig()
|
|
messageQueueEngine = nats.NewNatsEngine(natsConfig.Host, natsConfig.Port)
|
|
err := messageQueueEngine.Init()
|
|
if err != nil {
|
|
return err
|
|
}
|
|
case "":
|
|
return fmt.Errorf("message queue type is empty")
|
|
default:
|
|
return fmt.Errorf("unsupported message queue type: %s", messageQueueType)
|
|
}
|
|
return nil
|
|
}
|