mirror of
https://gitee.com/wanwujie/deer-flow
synced 2026-04-23 06:04:46 +08:00
doc: add knowledgebase rag examples in readme (#383)
* doc: add private knowledgebase examples in readme * doc: add private knowledgebase examples in readme * doc: add private knowledgebase examples in readme --------- Co-authored-by: Willem Jiang <willem.jiang@gmail.com>
This commit is contained in:
24
README.md
24
README.md
@@ -147,6 +147,8 @@ Explore more details in the [`web`](./web/) directory.
|
||||
|
||||
## Supported Search Engines
|
||||
|
||||
### Web Search
|
||||
|
||||
DeerFlow supports multiple search engines that can be configured in your `.env` file using the `SEARCH_API` variable:
|
||||
|
||||
- **Tavily** (default): A specialized search API for AI applications
|
||||
@@ -174,6 +176,19 @@ To configure your preferred search engine, set the `SEARCH_API` variable in your
|
||||
SEARCH_API=tavily
|
||||
```
|
||||
|
||||
### Private Knowledgebase
|
||||
|
||||
DeerFlow support private knowledgebase such as ragflow and vikingdb, so that you can use your private documents to answer questions.
|
||||
|
||||
- **[RAGFlow](https://ragflow.io/docs/dev/)**:open source RAG engine
|
||||
```
|
||||
# examples in .env.example
|
||||
RAG_PROVIDER=ragflow
|
||||
RAGFLOW_API_URL="http://localhost:9388"
|
||||
RAGFLOW_API_KEY="ragflow-xxx"
|
||||
RAGFLOW_RETRIEVAL_SIZE=10
|
||||
```
|
||||
|
||||
## Features
|
||||
|
||||
### Core Capabilities
|
||||
@@ -191,19 +206,12 @@ SEARCH_API=tavily
|
||||
- Web search via Tavily, Brave Search and more
|
||||
- Crawling with Jina
|
||||
- Advanced content extraction
|
||||
- Support for private knowledgebase
|
||||
|
||||
- 📃 **RAG Integration**
|
||||
|
||||
- Supports mentioning files from [RAGFlow](https://github.com/infiniflow/ragflow) within the input box. [Start up RAGFlow server](https://ragflow.io/docs/dev/).
|
||||
|
||||
```bash
|
||||
# .env
|
||||
RAG_PROVIDER=ragflow
|
||||
RAGFLOW_API_URL="http://localhost:9388"
|
||||
RAGFLOW_API_KEY="ragflow-xxx"
|
||||
RAGFLOW_RETRIEVAL_SIZE=10
|
||||
```
|
||||
|
||||
- 🔗 **MCP Seamless Integration**
|
||||
- Expand capabilities for private domain access, knowledge graph, web browsing and more
|
||||
- Facilitates integration of diverse research tools and methodologies
|
||||
|
||||
Reference in New Issue
Block a user