RAGFlow框架优化经验分享（附代码）：图文识别+动态分块 、API调优+源码修改

https://ragflow.io/docs/dev/python_api_reference
1.

RAGFlow.create_dataset(
    name: str,
    avatar: str = "",
    description: str = "",
    embedding_model: str = "BAAI/bge-large-zh-v1.5",
    language: str = "English",
    permission: str = "me", 
    chunk_method: str = "naive",
    parser_config: DataSet.ParserConfig = None
)
1.
2.
3.
4.
5.
6.
7.
8.
9.
10.

DataSet.update(update_message : dict)
1.

DataSet.upload_documents(document_list : list[dict])
1.

Document.update(update_message : dict)
1.

DataSet.async_parse_documents(document_ids : list[str])
1.

Document.add_chunk(content: str, important_keywords: list[str] = [])
1.

Chunk.update(update_message : dict)
1.

RAGFlow.retrieve(
    question: str = "",
    dataset_ids: list[str] = None,
    document_ids: list[str] = None,
    page: int = 1,
    page_size: int = 30,
    similarity_threshold: float = 0.2,
    vector_similarity_weight: float = 0.3,
    top_k: int = 1024,
    rerank_id: str = None,
    keyword: bool = False,
    highlight: bool = False
)
1.
2.
3.
4.
5.
6.
7.
8.
9.
10.
11.
12.
13.

RAGFlow.create_chat(
    name: str, 
    avatar: str = "", 
    dataset_ids: list[str] = [], 
    llm: Chat.LLM = None, 
    prompt: Chat.Prompt = None
)
1.
2.
3.
4.
5.
6.
7.

Chat.update(update_message : dict)
1.

Chat.create_session(name: str = "New session")
1.

Session.ask(question: str = "", stream: bool = False, **kwargs)
1.

Agent.create_session(id, rag, **kwargs)
1.

Session.ask(question: str = "", stream: bool = False)
1.

# 需要修改源码的示例逻辑
class CustomTerminologyProcessor:
    def __init__(self, terminology_mapping):
        self.terminology_mapping = terminology_mapping  # 同义词映射表


    def process_query(self, query):
        # 专业术语标准化
        # 车间俚语转换为标准术语
        processed_query = query
        for slang, standard_term in self.terminology_mapping.items():
            processed_query = processed_query.replace(slang, standard_term)
        return processed_query
1.
2.
3.
4.
5.
6.
7.
8.
9.
10.
11.
12.
13.

# 这部分需要修改源码，以下是概念性代码
class CustomHybridIndexBuilder:
    def __init__(self, vector_db_client):
        self.client = vector_db_client


    def create_scalar_indices(self, collection_name, fields):
        # 创建设备编号、故障代码等标量索引
        for field in fields:
            self.client.create_index(collection_name, field, "scalar")


    def create_vector_indices(self, collection_name, fields):
        # 创建向量索引
        for field in fields:
            self.client.create_index(collection_name, field, {"index_type": "HNSW", "params": {"M": 16, "efConstruction": 200}})
1.
2.
3.
4.
5.
6.
7.
8.
9.
10.
11.
12.
13.
14.
15.
16.

# 查询路由器 - 需要源码修改实现
class QueryRouter:
    def route_query(self, query_text):
        if self._is_equipment_code(query_text):
            return "exact_match", {"field": "equipment_code"}
        elif self._is_fault_code(query_text):
            return "exact_match", {"field": "fault_code"}
        elif self._is_parameter_query(query_text):
            return "parameter_lookup", {"field": "parameter_name"}
        else:
            return "semantic_search", {"model": "embedding_model"}
1.
2.
3.
4.
5.
6.
7.
8.
9.
10.
11.

# 上下文增强器 - 需要修改源码实现
class ContextEnhancer:
    def enhance_query(self, query, session_history, equipment_metadata=None):
        # 添加设备上下文信息
        if equipment_metadata:
            query_context = f"设备型号: {equipment_metadata['model']}, 生产年份: {equipment_metadata['year']}\n"
            query_context += query


        # 添加历史查询信息
        if session_history:
            relevant_history = self._extract_relevant_history(session_history, query)
            query_context = f"参考历史信息: {relevant_history}\n" + query_context


        return query_context
1.
2.
3.
4.
5.
6.
7.
8.
9.
10.
11.
12.
13.
14.
15.
16.

# 使用多模态模型生成图片描述
processor = MultimodalDocumentProcessor(api_key="YOUR_API_KEY")
enhanced_docs = processor.process_pdf("设备手册.pdf")
1.
2.
3.

# 配置保留图片的数据集
dataset = rag_object.create_dataset(
    name="图文设备手册",
    chunk_method="paper",
    parser_cnotallow={"layout_recognize": True}
)


# 上传原始PDF文档
with open("设备手册.pdf", "rb") as f:
    dataset.upload_documents([{"display_name": "设备手册.pdf", "blob": f.read()}])
1.
2.
3.
4.
5.
6.
7.
8.
9.
10.
11.

assistant = rag_object.create_chat(
    name="图文设备专家",
    dataset_ids=[dataset.id],
    prompt=Chat.Prompt(
        prompt="""你是设备维修专家。回答时，请同时提供:
        1. 文字描述解释故障和解决方案
        2. 引用相关图片，包括图片描述
        3. 告诉用户可以参考哪些图片获取更多信息
        {knowledge}"""
    )
)
1.
2.
3.
4.
5.
6.
7.
8.
9.
10.
11.

from ragflow_sdk import RAGFlow
import fitz  # PyMuPDF
import re
import pandas as pd
import io
import logging
from typing import List, Dict, Any, Tuple


logging.basicConfig(level=logging.INFO, format='%(asctime)s - %(name)s - %(levelname)s - %(message)s')
logger = logging.getLogger(__name__)


class DynamicChunker:
    """针对混合格式文档的自定义分块器"""


    def __init__(self, api_key: str, base_url: str):
        self.rag_object = RAGFlow(api_key=api_key, base_url=base_url)


    def process_document(self, pdf_path: str, dataset_name: str = None) -> str:
        """处理PDF文档并实现自定义分块"""
        # 1. 创建或获取数据集
        if dataset_name:
            datasets = self.rag_object.list_datasets(name=dataset_name)
            if datasets:
                dataset = datasets[0]
                logger.info(f"使用现有数据集: {dataset.name}, ID: {dataset.id}")
            else:
                dataset = self.rag_object.create_dataset(
                    name=dataset_name,
                    embedding_model="BAAI/bge-large-zh-v1.5",
                    language="Chinese",
                    chunk_method="one"  # 使用"one"方式，保持文档完整性
                )
                logger.info(f"创建新数据集: {dataset.name}, ID: {dataset.id}")
        else:
            dataset = self.rag_object.create_dataset(
                name="混合文档库",
                embedding_model="BAAI/bge-large-zh-v1.5",
                language="Chinese",
                chunk_method="one"
            )
            logger.info(f"创建新数据集: {dataset.name}, ID: {dataset.id}")


        # 2. 上传文档
        with open(pdf_path, "rb") as f:
            document_blob = f.read()


        docs = dataset.upload_documents([{
            "display_name": pdf_path.split("/")[-1],
            "blob": document_blob
        }])


        if not docs:
            logger.error("文档上传失败")
            return None


        doc = docs[0]
        logger.info(f"文档上传成功, ID: {doc.id}")


        # 3. 分析文档结构并创建自定义分块
        chunks = self._create_custom_chunks(pdf_path)
        logger.info(f"创建了 {len(chunks)} 个自定义分块")


        # 4. 手动添加分块到文档
        chunk_ids = []
        for chunk in chunks:
            content = chunk["content"]
            keywords = chunk["keywords"]
            chunk_type = chunk["type"]


            # 添加分块类型标记以便未来检索
            content_with_marker = f"[{chunk_type}]\n{content}"


            # 添加分块
            new_chunk = doc.add_chunk(
                cnotallow=content_with_marker,
                important_keywords=keywords
            )


            chunk_ids.append(new_chunk.id)
            logger.info(f"添加分块: 类型={chunk_type}, ID={new_chunk.id}, 关键词数量={len(keywords)}")


        return doc.id


    def _create_custom_chunks(self, pdf_path: str) -> List[Dict[str, Any]]:
        """分析PDF并创建自定义分块"""
        pdf_doc = fitz.open(pdf_path)
        chunks = []


        # 用于存储当前上下文
        current_section = ""
        current_text_chunk = ""
        current_table_data = []
        current_keywords = []


        for page_idx, page in enumerate(pdf_doc):
            # 提取页面文本
            text = page.get_text()


            # 检测章节标题
            section_headers = self._detect_section_headers(text)
            if section_headers:
                # 如果有积累的文本块，先保存
                if current_text_chunk:
                    chunks.append({
                        "content": current_text_chunk,
                        "keywords": list(set(current_keywords)),
                        "type": "text",
                        "section": current_section
                    })
                    current_text_chunk = ""
                    current_keywords = []


                # 更新当前章节
                current_section = section_headers[0]
                current_keywords.append(current_section)


            # 检测表格
            tables = self._detect_tables(page)
            if tables:
                # 如果有积累的文本块，先保存
                if current_text_chunk:
                    chunks.append({
                        "content": current_text_chunk,
                        "keywords": list(set(current_keywords)),
                        "type": "text",
                        "section": current_section
                    })
                    current_text_chunk = ""
                    current_keywords = []


                # 处理表格
                for table in tables:
                    table_content = self._format_table(table)
                    table_keywords = self._extract_keywords_from_table(table)


                    chunks.append({
                        "content": table_content,
                        "keywords": list(set(table_keywords + current_keywords)),
                        "type": "table",
                        "section": current_section
                    })


            # 检测图片
            images = self._detect_images(page)
            for img_idx, img in enumerate(images):
                # 提取图片周围的文本作为上下文
                img_context = self._extract_image_context(text, img["bbox"])


                # 如果找到图片相关文本
                if img_context:
                    # 如果有积累的文本块，先保存
                    if current_text_chunk:
                        chunks.append({
                            "content": current_text_chunk,
                            "keywords": list(set(current_keywords)),
                            "type": "text",
                            "section": current_section
                        })
                        current_text_chunk = ""
                        current_keywords = []


                    # 创建图文块
                    image_text_content = f"图片描述: {img_context}\n图片位置: 第{page_idx+1}页"
                    image_keywords = self._extract_keywords(img_context)


                    chunks.append({
                        "content": image_text_content,
                        "keywords": list(set(image_keywords + current_keywords)),
                        "type": "image",
                        "section": current_section
                    })


                    # 防止重复处理同一段文本
                    text = text.replace(img_context, "", 1)


            # 处理剩余文本
            if text.strip():
                # 按段落拆分
                paragraphs = self._split_into_paragraphs(text)


                for para in paragraphs:
                    if len(para.strip()) < 10:  # 忽略太短的段落
                        continue


                    # 累积文本直到达到合适的大小
                    current_text_chunk += para + "\n\n"
                    current_keywords.extend(self._extract_keywords(para))


                    # 检查是否应该创建新的文本块
                    if len(current_text_chunk) > 1500:  # 大约300-500个词
                        chunks.append({
                            "content": current_text_chunk,
                            "keywords": list(set(current_keywords)),
                            "type": "text",
                            "section": current_section
                        })
                        current_text_chunk = ""
                        current_keywords = []


        # 处理最后一个文本块
        if current_text_chunk:
            chunks.append({
                "content": current_text_chunk,
                "keywords": list(set(current_keywords)),
                "type": "text",
                "section": current_section
            })


        return chunks


    def _detect_section_headers(self, text: str) -> List[str]:
        """检测章节标题"""
        # 这是一个简化的实现，可以根据实际文档格式调整
        header_patterns = [
            r"^第[一二三四五六七八九十\d]+章\s*(.+)$",
            r"^\d+\.\d*\s+(.+)$",
            r"^[一二三四五六七八九十]+[、.．]\s*(.+)$"
        ]


        headers = []
        for line in text.split("\n"):
            line = line.strip()
            for pattern in header_patterns:
                match = re.match(pattern, line)
                if match:
                    headers.append(line)
                    break


        return headers


    def _detect_tables(self, page) -> List[Any]:
        """检测页面中的表格"""
        # 这里使用简化的检测逻辑，实际应用中可能需要更复杂的表格检测算法
        # 例如，可以寻找包含多个垂直和水平线的区域
        tables = []


        # 简单表格检测：查找水平线和垂直线的集中区域
        # 这里仅作为占位示例，实际实现会更复杂
        horizontal_lines = []
        vertical_lines = []


        for drawing in page.get_drawings():
            for item in drawing["items"]:
                if item["type"] == "l":  # 线段
                    x0, y0, x1, y1 = item["rect"]
                    if abs(y1 - y0) < 2:  # 水平线
                        horizontal_lines.append((x0, y0, x1, y1))
                    elif abs(x1 - x0) < 2:  # 垂直线
                        vertical_lines.append((x0, y0, x1, y1))


        # 简单的表格判定：有足够多的水平线和垂直线
        if len(horizontal_lines) >= 3 and len(vertical_lines) >= 2:
            # 找出所有线的边界，作为表格边界
            min_x = min([min(l[0], l[2]) for l in horizontal_lines + vertical_lines])
            max_x = max([max(l[0], l[2]) for l in horizontal_lines + vertical_lines])
            min_y = min([min(l[1], l[3]) for l in horizontal_lines + vertical_lines])
            max_y = max([max(l[1], l[3]) for l in horizontal_lines + vertical_lines])


            # 提取表格区域的文本
            table_rect = fitz.Rect(min_x, min_y, max_x, max_y)
            table_text = page.get_text("text", clip=table_rect)


            # 简化的表格结构化（实际应用中需要更复杂的逻辑）
            table_rows = table_text.split("\n")
            table = []
            for row in table_rows:
                if row.strip():
                    cells = row.split()
                    if len(cells) >= 2:  # 至少有2个单元格才视为有效行
                        table.append(cells)


            if table:
                tables.append(table)


        return tables


    def _detect_images(self, page) -> List[Dict[str, Any]]:
        """检测页面中的图片"""
        images = []


        # 获取页面上的图片对象
        img_list = page.get_images(full=True)


        for img_idx, img_info in enumerate(img_list):
            xref = img_info[0]
            base_image = page.parent.extract_image(xref)


            if base_image:
                # 寻找图片在页面上的位置
                img_rects = []
                for rect in page.get_image_rects(xref):
                    img_rects.append(rect)


                if img_rects:
                    # 使用第一个找到的位置
                    bbox = img_rects[0]


                    images.append({
                        "bbox": [bbox.x0, bbox.y0, bbox.x1, bbox.y1]
                    })


        return images


    def _extract_image_context(self, text: str, bbox: List[float], context_size: int = 200) -> str:
        """提取图片周围的文本作为上下文"""
        # 在文本中查找可能的图片标题，如"图1"，"Figure 1"等
        caption_patterns = [
            r"图\s*\d+[\.．:]?\s*(.+?)(?:\n|$)",
            r"Figure\s*\d+[\.:]?\s*(.+?)(?:\n|$)",
            r"图表\s*\d+[\.．:]?\s*(.+?)(?:\n|$)"
        ]


        for pattern in caption_patterns:
            matches = re.finditer(pattern, text, re.IGNORECASE)
            for match in matches:
                return match.group(0)


        # 如果找不到明确的图片标题，则尝试提取图片周围的文本
        # 这是一个简化实现，实际应用中可能需要更复杂的逻辑
        lines = text.split("\n")
        total_length = 0
        start_line = 0


        # 估计图片在文本中的位置
        # 这是一个非常粗略的估计，实际应用中需要更精确的方法
        relative_position = bbox[1] / 1000  # 假设页面高度为1000
        target_position = int(len(text) * relative_position)


        # 找到大致对应的行
        for i, line in enumerate(lines):
            total_length += len(line) + 1  # +1 for newline
            if total_length > target_position:
                start_line = max(0, i - 2)  # 从前两行开始
                break


        # 提取上下文（当前行及其前后几行）
        context_lines = lines[max(0, start_line):min(len(lines), start_line + 5)]
        return "\n".join(line for line in context_lines if len(line.strip()) > 5)


    def _format_table(self, table: List[List[str]]) -> str:
        """格式化表格为文本格式"""
        if not table:
            return ""


        # 创建pandas DataFrame
        df = pd.DataFrame(table[1:], columns=table[0] if len(table) > 1 else None)


        # 转换为字符串形式
        result = io.StringIO()
        df.to_csv(result, sep="|", index=False)
        return result.getvalue()


    def _extract_keywords_from_table(self, table: List[List[str]]) -> List[str]:
        """从表格中提取关键词"""
        keywords = []


        # 表头作为关键词
        if table and len(table) > 0:
            keywords.extend(table[0])


        # 第一列可能是行标题，也加入关键词
        for row in table[1:] if len(table) > 1 else []:
            if row and len(row) > 0:
                keywords.append(row[0])


        return keywords


    def _split_into_paragraphs(self, text: str) -> List[str]:
        """将文本拆分为段落"""
        # 按照多个换行符拆分
        paragraphs = re.split(r"\n\s*\n", text)
        return [p.strip() for p in paragraphs if p.strip()]


    def _extract_keywords(self, text: str) -> List[str]:
        """从文本中提取关键词"""
        # 这是一个简化的关键词提取方法
        # 实际应用中可以使用更复杂的NLP技术，如TF-IDF、TextRank等


        # 1. 移除停用词和标点
        stop_words = {"的", "了", "和", "与", "或", "在", "是", "有", "被", "将", "把"}
        cleaned_text = re.sub(r'[^\w\s]', ' ', text)
        words = cleaned_text.split()
        filtered_words = [w for w in words if w not in stop_words and len(w) > 1]


        # 2. 简单词频统计
        word_count = {}
        for word in filtered_words:
            if word in word_count:
                word_count[word] += 1
            else:
                word_count[word] = 1


        # 3. 选择频率最高的几个词作为关键词
        sorted_words = sorted(word_count.items(), key=lambda x: x[1], reverse=True)
        return [word for word, count in sorted_words[:10] if count > 1]


# 使用示例
if __name__ == "__main__":
    chunker = DynamicChunker(
        api_key="YOUR_API_KEY",
        base_url="http://YOUR_BASE_URL:9380"
    )


    doc_id = chunker.process_document("设备维修手册.pdf", "动态分块测试")
    print(f"处理完成，文档ID: {doc_id}")
1.
2.
3.
4.
5.
6.
7.
8.
9.
10.
11.
12.
13.
14.
15.
16.
17.
18.
19.
20.
21.
22.
23.
24.
25.
26.
27.
28.
29.
30.
31.
32.
33.
34.
35.
36.
37.
38.
39.
40.
41.
42.
43.
44.
45.
46.
47.
48.
49.
50.
51.
52.
53.
54.
55.
56.
57.
58.
59.
60.
61.
62.
63.
64.
65.
66.
67.
68.
69.
70.
71.
72.
73.
74.
75.
76.
77.
78.
79.
80.
81.
82.
83.
84.
85.
86.
87.
88.
89.
90.
91.
92.
93.
94.
95.
96.
97.
98.
99.
100.
101.
102.
103.
104.
105.
106.
107.
108.
109.
110.
111.
112.
113.
114.
115.
116.
117.
118.
119.
120.
121.
122.
123.
124.
125.
126.
127.
128.
129.
130.
131.
132.
133.
134.
135.
136.
137.
138.
139.
140.
141.
142.
143.
144.
145.
146.
147.
148.
149.
150.
151.
152.
153.
154.
155.
156.
157.
158.
159.
160.
161.
162.
163.
164.
165.
166.
167.
168.
169.
170.
171.
172.
173.
174.
175.
176.
177.
178.
179.
180.
181.
182.
183.
184.
185.
186.
187.
188.
189.
190.
191.
192.
193.
194.
195.
196.
197.
198.
199.
200.
201.
202.
203.
204.
205.
206.
207.
208.
209.
210.
211.
212.
213.
214.
215.
216.
217.
218.
219.
220.
221.
222.
223.
224.
225.
226.
227.
228.
229.
230.
231.
232.
233.
234.
235.
236.
237.
238.
239.
240.
241.
242.
243.
244.
245.
246.
247.
248.
249.
250.
251.
252.
253.
254.
255.
256.
257.
258.
259.
260.
261.
262.
263.
264.
265.
266.
267.
268.
269.
270.
271.
272.
273.
274.
275.
276.
277.
278.
279.
280.
281.
282.
283.
284.
285.
286.
287.
288.
289.
290.
291.
292.
293.
294.
295.
296.
297.
298.
299.
300.
301.
302.
303.
304.
305.
306.
307.
308.
309.
310.
311.
312.
313.
314.
315.
316.
317.
318.
319.
320.
321.
322.
323.
324.
325.
326.
327.
328.
329.
330.
331.
332.
333.
334.
335.
336.
337.
338.
339.
340.
341.
342.
343.
344.
345.
346.
347.
348.
349.
350.
351.
352.
353.
354.
355.
356.
357.
358.
359.
360.
361.
362.
363.
364.
365.
366.
367.
368.
369.
370.
371.
372.
373.
374.
375.
376.
377.
378.
379.
380.
381.
382.
383.
384.
385.
386.
387.
388.
389.
390.
391.
392.
393.
394.
395.
396.
397.
398.
399.
400.
401.
402.
403.
404.
405.
406.
407.
408.
409.
410.
411.
412.
413.
414.
415.
416.
417.
418.
419.
420.
421.
422.
423.
424.
425.
426.
427.
428.
429.
430.
431.
432.
433.
434.
435.
436.
437.
438.
439.
440.
441.
442.
443.
444.
445.
446.
447.
448.
449.
450.
451.
452.
453.
454.
455.
456.
457.
458.
459.
460.
461.
462.
463.
464.
465.
466.
467.
468.
469.
470.
471.
472.
473.
474.
475.
476.