RAG引擎

界面操作

1. 在左侧菜单中，选择RAG 引擎 > 服务配置。

2. 在对象存储（OSS）配置面板中，配置以下参数：

   参数	说明	示例
   Storage Type	存储类型。	OSS、S3、MINIO
   Access Key ID	访问密钥ID。	AKxxxxxxxx
   Secret Key	访问密钥。服务端采用AES-GCM加密存储，已保存时留空则保留原值。	********
   Endpoint URL	服务地址。	https://oss-cn-hangzhou.aliyuncs.com
   Region	区域。	cn-hangzhou
   Bucket	默认桶名。	my-rag-bucket
   Prefix Path	存储前缀路径（可选）。	rag/
   Signature Version	签名版本。	s3、v4
   Addressing Style	寻址方式。	virtual、path

3. 单击测试连接，验证配置是否正确。

4. 单击保存配置。保存后系统将自动重启RAG引擎服务（约10~30秒）。

API调用

1. 保存OSS配置：

   POST /api/oss/config
   Content-Type: application/json
   
   {
     "storage_type":       "OSS",
     "endpoint_url":       "https://oss-cn-hangzhou.aliyuncs.com",
     "region":             "cn-hangzhou",
     "bucket":             "my-rag-bucket",
     "access_key":         "AKxxx",
     "secret_key":         "xxxxxxx",
     "prefix_path":        "rag/",
     "signature_version":  "s3",
     "addressing_style":   "virtual"
   }

2. 保存后系统自动重启RAG引擎服务（约10~30秒）。完成后调用测试接口验证连通性：

   POST /api/oss/test
   Content-Type: application/json
   
   {
     "storage_type":       "OSS",
     "endpoint_url":       "https://oss-cn-hangzhou.aliyuncs.com",
     "region":             "cn-hangzhou",
     "bucket":             "my-rag-bucket",
     "access_key":         "AKxxx",
     "secret_key":         "xxxxxxx",
     "prefix_path":        "rag/",
     "signature_version":  "s3",
     "addressing_style":   "virtual"
   }

   期望返回：{"code": 0, "connected": true}。

界面操作

1. 在服务配置页面中，滚动至文档引擎配置板块。

2. 在顶部引擎类型中，选择PostgreSQL或OpenSearch。

3. 切换到对应的Tab页，填写连接参数。

   • PostgreSQL Tab

     参数	默认值	说明
     Host / Port	localhost / 5432	PostgreSQL实例地址。
     Username / Password	postgres / 已保存留空	数据库用户名和密码，密码加密存储。
     Database	_rag_doc_db	专用文档库名称。
     Pool Size / Max Overflow / Pool Timeout	20 / 10 / 30	连接池参数。
     FTS Engine	gin	全文索引类型。
     FTS Language	chinese	分词语言。
     Hybrid Mode	weighted_fusion	混合检索策略。
     FTS TopN / Vector TopN	100 / 100	每路召回上限。

   • OpenSearch Tab

     参数	默认值	说明
     Host / Port	opensearch / 9201	OpenSearch实例地址。
     Username / Password	admin / 已保存留空	管理员凭据。

4. 单击测试连接验证连通性，然后单击保存配置。

5. 在引擎类型处单击切换并重启，系统将自动重启RAG引擎服务以切换到新引擎。

API调用

1. 保存PostgreSQL配置：

   POST /api/doc-engine/pg/config
   Content-Type: application/json
   
   {
     "host": "localhost",
     "port": 5432,
     "database": "_rag_doc_db",
     "username": "postgres",
     "password": "your_password"
   }

2. 测试PostgreSQL连通性（可传空body使用已保存配置）：

   POST /api/doc-engine/pg/test
   Content-Type: application/json
   
   {}

3. 切换引擎类型（触发重启）：

   POST /api/doc-engine/engine-type
   Content-Type: application/json
   
   { "engine_type": "postgresql" }

界面操作

1. 在左侧菜单中，选择RAG 引擎 > 模型配置。

2. 新增模型厂商：在从预设模型提供商添加区域找到目标厂商（如Tongyi-Qianwen、OpenAI、DeepSeek等），单击添加，填写API Key和Base URL（可选）。

3. 导入自定义模型（可选）：单击添加自定义模型，填写模型提供商（Factory）、模型名称、API Key、Base URL和模型类型（chat、embedding、rerank、image2text），单击验证确认可用后再添加。

4. 设置默认模型：在页面顶部租户默认模型区域，分别指定：

   • LLM：例如qwen-plus。

   • Embedding：例如text-embedding-v3。

   • VLM（可选）：用于PDF图片理解，例如qwen-vl-plus。

5. 单击保存。设置立即生效，无需重启。

API调用

1. 绑定模型厂商API Key。

   POST /api/ragflow/llm/set_api_key
   Content-Type: application/json
   
   {
     "llm_factory": "Tongyi-Qianwen",
     "api_key":     "sk-xxxxxxxxxxxxxxxxxxxxxx",
     "base_url":    "https://dashscope.aliyuncs.com/compatible-mode/v1"
   }

   查看可选厂商：GET /api/ragflow/llm/factories。

2. 设置租户默认模型。

   POST /api/ragflow/set_tenant_info
   Content-Type: application/json
   
   {
     "tenant_id":  "<从 GET /api/ragflow/tenant_info 获取>",
     "llm_id":     "qwen-plus@Tongyi-Qianwen",
     "embd_id":    "text-embedding-v3@Tongyi-Qianwen",
     "asr_id":     "",
     "img2txt_id": ""
   }

3. （可选）用户级覆盖。

   PUT /api/ragflow/defaults
   Content-Type: application/json
   
   { "llm_id": "gpt-4o@OpenAI" }

界面操作

1. 在知识库列表中，单击目标知识库的文件夹图标，进入文档管理页。

2. 单击页面右上角的上传，将文件拖拽到上传框或单击选择文件。支持PDF、Word、Excel、PPT、TXT、Markdown等格式。

3. 上传完成后，关闭上传弹窗。文档列表中新文档的解析状态为待解析。

API调用

curl -X POST "http://<host>/api/ragflow/datasets/<dataset_id>/documents" \
     -H "Authorization: Bearer <token>" \
     -F "file=@./产品手册.pdf" \
     -F "file=@./FAQ.md"

上传后文档状态为unprocessed。

界面操作

1. 在文档管理页中，勾选需要解析的文档（支持全选）。

2. 单击顶部的开始解析。

   说明

   未配置嵌入模型时，系统会弹出警告提示。单击去配置跳转到知识库配置页补充。

3. 解析过程中，文档列表会自动刷新显示进度。解析状态依次为：待解析 → 解析中 → 已完成（或失败）。

API调用

POST /api/ragflow/datasets/<dataset_id>/documents/parse
Content-Type: application/json

{ "ids": ["doc-xxx", "doc-yyy"] }

界面操作

1. 在文档管理页中，单击目标文档的文档图标（仅解析完成的文档可操作）。

2. 在右侧Chunk抽屉中，可对每条切片执行以下操作：

   • 单击编辑手工纠错（如OCR错字、段落合并）。

   • 切换启用或禁用开关，临时屏蔽低质切片。

   • 单击新增 chunk手工补录遗漏内容。

API调用

GET  /api/ragflow/datasets/<dataset_id>/documents/<doc_id>/chunks?page=1&size=20
POST /api/ragflow/datasets/<dataset_id>/documents/<doc_id>/chunks/switch

界面操作

1. 在左侧菜单中，选择RAG 引擎 > 对话助手。

2. 单击+ 新建助手，配置以下参数：

   基础信息

   参数	说明
   名称	助手显示名称。
   头像	上传自定义头像或保留默认。
   关联知识库	多选：勾选目标知识库。

   模型参数

   参数	建议值	说明
   模型	租户默认	跟随租户默认，或覆盖为指定模型。
   Temperature	0.1	越低越严格复现知识库内容。
   Top-P	0.3	与Temperature二选一调节。
   相似度阈值	0.2	同检索测试。
   向量权重	0.3	同检索测试。
   Top N	6	输入LLM的最多切片数。
   显示引用	开启	在回答中标注来源切片。
   空结果回复	自定义文本	检索无结果时的兜底回复，用于防止模型幻觉。

   系统提示词：配置系统级Prompt，使用{{knowledge}}变量引用检索结果。

3. 单击创建。

API调用

POST /api/ragflow/chats
Content-Type: application/json

{
  "name":        "产品客服助手",
  "dataset_ids": ["<dataset_id>"],
  "llm":  { "temperature": 0.1, "top_p": 0.3 },
  "prompt": {
    "similarity_threshold":     0.2,
    "vector_similarity_weight": 0.3,
    "top_n":            6,
    "show_quote":       true,
    "empty_response":   "抱歉，我没有在知识库中找到相关信息。",
    "prompt":           "你是产品客服。请只依据 {{knowledge}} 用简洁中文回答用户问题。"
  }
}

界面操作

1. 在助手列表中，单击目标助手卡片，进入对话视图。

2. 在左侧会话列表中，单击+ 新建会话，或选择一个历史会话继续。

3. 在输入框中键入问题，按Enter键发送（Shift+Enter换行）。回答以流式方式实时展示。

4. 每段回答末尾的引用标记可展开查看命中切片与原文链接。

API调用

1. 创建会话。

   POST /api/ragflow/chats/<chat_id>/sessions
   Content-Type: application/json
   
   { "name": "首次对话" }

2. 流式问答。

   POST /api/ragflow/chats/<chat_id>/completions
   Content-Type: application/json
   
   {
     "session_id": "<session_id>",
     "question":   "退货需要多久？",
     "stream":     true
   }

   流式响应每帧格式：

   data: {"code":0,"data":{"answer":"一般7个工作日内...","reference":{...},"finish":false}}