Repository navigation
Expand file tree
/
Copy path09_rse_core.py
More file actions
478 lines (373 loc) · 15.9 KB
/
Copy path09_rse_core.py
File metadata and controls
478 lines (373 loc) · 15.9 KB
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
477
478
"""
关联段落提取(RSE) 核心函数
"""
import os
import fitz
import numpy as np
from openai import OpenAI
from dotenv import load_dotenv
load_dotenv()
client = OpenAI(
base_url=os.getenv("LLM_BASE_URL"),
api_key=os.getenv("LLM_API_KEY")
)
llm_model = os.getenv("LLM_MODEL_ID")
embedding_model = os.getenv("EMBEDDING_MODEL_ID")
####################################
# 关联段落提取(RSE)的完整流程
####################################
def rag_with_rse(pdf_path, query, chunk_size=800, irrelevant_chunk_penalty=0.2):
"""
完整的RAG管道,包含相关段落提取(Relevant Segment Extraction)。
Args:
pdf_path (str): 文档路径
query (str): 用户查询
chunk_size (int): 每个块的大小
irrelevant_chunk_penalty (float): 对不相关块的惩罚值
Returns:
Dict: 包含查询、段落和响应的结果字典
"""
print("\n=== 开始带有相关段落提取的RAG ===")
print(f"查询: {query}")
# 处理文档以提取文本、分块并创建嵌入
chunks, vector_store, doc_info = process_document(pdf_path, chunk_size)
# 根据查询计算相关性分数和块值
print("\n计算相关性分数和块值...")
chunk_values = calculate_chunk_values(query, chunks, vector_store, irrelevant_chunk_penalty)
# 根据块值找到最佳文本段落
best_segments, scores = find_best_segments(
chunk_values,
max_segment_length=20, # 最大段落长度
total_max_length=30, # 所有段落的最大总长度
min_segment_value=0.2 # 考虑段落的最小值
)
# 从最佳块中重建文本段落
print("\n从块中重建文本段落...")
segments = reconstruct_segments(chunks, best_segments)
# 将段落格式化为语言模型的上下文字符串
context = format_segments_for_context(segments)
# 使用上下文从语言模型生成响应
response = generate_response(query, context)
# 将结果编译成字典
result = {
"query": query, # 用户查询
"segments": segments, # 提取的段落
"response": response # 模型生成的响应
}
print("\n=== 最终响应 ===")
print(response)
return result
####################################
# 根据查询计算相关性分数和块值
# 先获取所有带有相似度分数的块
# 获取相关性分数,如果不在结果中则默认为0,同时应用惩罚以将不相关的块转换为负值
####################################
def calculate_chunk_values(query, chunks, vector_store, irrelevant_chunk_penalty=0.2):
"""
通过结合相关性和位置计算块的值。
Args:
query (str): 查询文本
chunks (List[str]): 文档块列表
vector_store (SimpleVectorStore): 包含块的向量存储
irrelevant_chunk_penalty (float): 不相关块的惩罚值
Returns:
List[float]: 块值列表
"""
# 创建查询嵌入
query_embedding = create_embeddings([query])[0]
# 获取所有带有相似度分数的块
num_chunks = len(chunks)
results = vector_store.search(query_embedding, top_k=num_chunks)
# 创建从块索引到相关性分数的映射
relevance_scores = {result["metadata"]["chunk_index"]: result["score"] for result in results}
# 计算块值(相关性分数减去惩罚)
chunk_values = []
for i in range(num_chunks):
# 获取相关性分数,如果不在结果中则默认为0
score = relevance_scores.get(i, 0.0)
# 应用惩罚以将不相关的块转换为负值
value = score - irrelevant_chunk_penalty
chunk_values.append(value)
return chunk_values
####################################
# 根据块值找到最佳文本块
####################################
def find_best_segments(chunk_values, max_segment_length=20, total_max_length=30, min_segment_value=0.2):
"""
使用最大子数组和算法的变体找到最佳段落。
Args:
chunk_values (List[float]): 每个块的值
max_segment_length (int): 单个段落的最大长度
total_max_length (int): 所有段落的最大总长度
min_segment_value (float): 被考虑的段落的最小值
Returns:
List[Tuple[int, int]]: 最佳段落的(开始,结束)索引列表
"""
print("寻找最佳连续文本段落...")
best_segments = []
segment_scores = []
total_included_chunks = 0
# 继续寻找段落直到达到限制
while total_included_chunks < total_max_length:
best_score = min_segment_value # 段落的最低阈值
best_segment = None
# 尝试每个可能的起始位置
for start in range(len(chunk_values)):
# 如果该起始位置已经在选定的段落中,则跳过(重叠内容部分)
if any(start >= s[0] and start < s[1] for s in best_segments):
continue
# 尝试每个可能的段落长度
for length in range(1, min(max_segment_length, len(chunk_values) - start) + 1):
end = start + length
# 如果结束位置已经在选定的段落中,则跳过
if any(end > s[0] and end <= s[1] for s in best_segments):
continue
# 计算段落值为块值的总和
segment_value = sum(chunk_values[start:end])
# 如果这个段落更好,则更新最佳段落
if segment_value > best_score:
best_score = segment_value
best_segment = (start, end)
# 如果找到了一个好的段落,则添加它
if best_segment:
best_segments.append(best_segment)
segment_scores.append(best_score)
total_included_chunks += best_segment[1] - best_segment[0]
print(f"找到段落 {best_segment},得分 {best_score:.4f}")
else:
# 没有更多的好段落可找
break
# 按段落的起始位置排序以便于阅读
best_segments = sorted(best_segments, key=lambda x: x[0])
return best_segments, segment_scores
####################################
# 从最佳块中重建文本段落
####################################
def reconstruct_segments(chunks, best_segments):
"""
基于块索引重建文本段落。
Args:
chunks (List[str]): 所有文档块的列表
best_segments (List[Tuple[int, int]]): 段落的(开始,结束)索引列表
Returns:
List[Dict]: 重建的文本段落列表,每个段落包含文本和其范围
"""
reconstructed_segments = [] # 初始化一个空列表以存储重建的段落
for start, end in best_segments:
# 将此段落中的块连接起来以形成完整的段落文本
segment_text = " ".join(chunks[start:end])
# 将段落文本及其范围追加到重建的段落列表中
reconstructed_segments.append({
"text": segment_text, # 段落文本
"segment_range": (start, end), # 段落范围
})
return reconstructed_segments # 返回重建的文本段落列表
####################################
# 将段落进行格式化
####################################
def format_segments_for_context(segments):
"""
将段落格式化为适用于LLM的上下文字符串。
Args:
segments (List[Dict]): 段落字典列表
Returns:
str: 格式化后的上下文文本
"""
context = [] # 初始化一个空列表以存储格式化后的上下文
for i, segment in enumerate(segments):
# 为每个段落创建一个包含索引和块范围的标题
# segment_header = f"SEGMENT {i+1} (Chunks {segment['segment_range'][0]}-{segment['segment_range'][1]-1}):"
segment_header = f"分段{i + 1}(包含文本块{segment['segment_range'][0]}至{segment['segment_range'][1] - 1}):"
context.append(segment_header) # 将段落标题添加到上下文列表中
context.append(segment['text']) # 将段落文本添加到上下文列表中
context.append("-" * 80) # 添加分隔线以提高可读性
# 将上下文列表中的所有元素用双换行符连接并返回结果
return "\n\n".join(context)
def generate_response(query, context):
"""
根据查询和上下文生成响应。
Args:
query (str): 用户查询
context (str): 来自相关段落的上下文文本
Returns:
str: 生成的响应
"""
print("正在使用相关段落作为上下文生成响应...")
# 定义系统提示以引导AI的行为
system_prompt = """
您是基于上下文智能应答的AI助手,需根据提供的文档段落回答用户问题。
这些文档段落是通过相关性检索匹配到当前问题的上下文内容。
请严格依据以下要求执行:
1. 整合分析所有相关段落信息
2. 生成全面准确的综合回答
3. 当上下文不包含有效信息时,必须明确告知无法回答
"""
# 通过组合上下文和查询创建用户提示
user_prompt = f"""
上下文内容:
{context}
问题:{query}
请基于上述上下文内容提供专业可靠的回答。
"""
# 使用指定的模型生成响应
response = client.chat.completions.create(
model=llm_model,
messages=[
{"role": "system", "content": system_prompt},
{"role": "user", "content": user_prompt}
],
temperature=0
)
# 返回生成的响应内容
return response.choices[0].message.content
def process_document(pdf_path, chunk_size=800):
"""
处理文档以供 RSE 使用。
Args:
pdf_path (str): PDF 文档的路径
chunk_size (int): 每个块的字符大小
Returns:
Tuple[List[str], SimpleVectorStore, Dict]: 块列表、向量存储和文档信息
"""
print("从文档中提取文本...")
# 从 PDF 文件中提取文本
text = extract_text_from_pdf(pdf_path)
print("将文本切分为非重叠段落...")
# 将提取的文本切分为非重叠段落
chunks = chunk_text(text, n=chunk_size, overlap=0)
print(f"创建了 {len(chunks)} 个块")
print("为块生成嵌入向量...")
# 为文本块生成嵌入向量
chunk_embeddings = create_embeddings(chunks)
# 创建 SimpleVectorStore 的实例
vector_store = SimpleVectorStore()
# 添加带有元数据的文档(包括块索引以便后续重建)
metadata = [{"chunk_index": i, "source": pdf_path} for i in range(len(chunks))]
vector_store.add_documents(chunks, chunk_embeddings, metadata)
# 跟踪原始文档结构以便段落重建
doc_info = {
"chunks": chunks,
"source": pdf_path,
}
return chunks, vector_store, doc_info
def extract_text_from_pdf(pdf_path):
"""
从 PDF 文件中提取文本,并打印前 `num_chars` 个字符。
Args:
pdf_path (str): Path to the PDF file.
Returns:
str: Extracted text from the PDF.
"""
# 打开 PDF 文件
mypdf = fitz.open(pdf_path)
all_text = "" # 初始化一个空字符串以存储提取的文本
# Iterate through each page in the PDF
for page_num in range(mypdf.page_count):
page = mypdf[page_num]
text = page.get_text("text") # 从页面中提取文本
all_text += text # 将提取的文本追加到 all_text 字符串中
return all_text # 返回提取的文本
def chunk_text(text, n, overlap):
"""
将文本分割为重叠的块
Args:
text (str): 要分割的文本
n (int): 每个块的字符数
overlap (int): 块之间的重叠字符数
Returns:
List[str]: 文本块列表
"""
chunks = [] #
for i in range(0, len(text), n - overlap):
# 添加从当前索引到索引 + 块大小的文本块
chunk = text[i:i + n]
if chunk:
chunks.append(chunk)
return chunks # Return the list of text chunks
class SimpleVectorStore:
"""
使用 NumPy 实现的轻量级向量存储。
"""
def __init__(self, dimension=1536):
"""
初始化向量存储。
Args:
dimension (int): 嵌入向量的维度
"""
self.dimension = dimension # 嵌入向量的维度
self.vectors = [] # 存储嵌入向量的列表
self.documents = [] # 存储文档片段的列表
self.metadata = [] # 存储元数据的列表
def add_documents(self, documents, vectors=None, metadata=None):
"""
向向量存储中添加文档。
Args:
documents (List[str]): 文档片段列表
vectors (List[List[float]], 可选): 嵌入向量列表
metadata (List[Dict], 可选): 元数据字典列表
"""
if vectors is None: # 如果未提供向量,则生成一个空列表
vectors = [None] * len(documents)
if metadata is None: # 如果未提供元数据,则生成一个空字典列表
metadata = [{} for _ in range(len(documents))]
for doc, vec, meta in zip(documents, vectors, metadata): # 遍历文档、向量和元数据
self.documents.append(doc) # 将文档片段添加到列表中
self.vectors.append(vec) # 将嵌入向量添加到列表中
self.metadata.append(meta) # 将元数据添加到列表中
def search(self, query_vector, top_k=5):
"""
搜索最相似的文档。
Args:
query_vector (List[float]): 查询嵌入向量
top_k (int): 返回的结果数量
Returns:
List[Dict]: 包含文档、分数和元数据的结果列表
"""
if not self.vectors or not self.documents: # 如果向量或文档为空,返回空列表
return []
# 将查询向量转换为 NumPy 数组
query_array = np.array(query_vector)
# 计算相似度
similarities = []
for i, vector in enumerate(self.vectors): # 遍历存储中的向量
if vector is not None: # 如果向量不为空
# 计算余弦相似度
similarity = np.dot(query_array, vector) / (
np.linalg.norm(query_array) * np.linalg.norm(vector)
)
similarities.append((i, similarity)) # 将索引和相似度添加到列表中
# 按相似度降序排序
similarities.sort(key=lambda x: x[1], reverse=True)
# 获取前 top-k 结果
results = []
for i, score in similarities[:top_k]: # 遍历前 top-k 的结果
results.append({
"document": self.documents[i], # 文档片段
"score": float(score), # 相似度分数
"metadata": self.metadata[i] # 元数据
})
return results # 返回结果列表
def create_embeddings(texts):
"""
为文本生成嵌入向量。
Args:
texts (List[str]): 要嵌入的文本列表
Returns:
List[List[float]]: 嵌入向量列表
"""
if not texts: # 如果没有提供文本,返回空列表
return []
# 如果列表很长,则按批次处理
batch_size = 100 # 根据API限制进行调整
all_embeddings = [] # 初始化一个列表来存储所有嵌入向量
for i in range(0, len(texts), batch_size): # 按批次处理文本
batch = texts[i:i + batch_size] # 获取当前批次的文本
# 使用指定的模型为当前批次生成嵌入向量
response = client.embeddings.create(
input=batch, # 输入文本批次
model=embedding_model # 使用的模型
)
# 从响应中提取嵌入向量
batch_embeddings = [item.embedding for item in response.data]
all_embeddings.extend(batch_embeddings) # 将批次嵌入向量添加到总列表中
return all_embeddings # 返回所有嵌入向量的列表