524 lines
18 KiB
Python
524 lines
18 KiB
Python
import operator
|
||
from abc import ABC, abstractmethod
|
||
|
||
import os
|
||
from pathlib import Path
|
||
import numpy as np
|
||
from langchain.embeddings.base import Embeddings
|
||
from langchain.docstore.document import Document
|
||
|
||
from server.db.repository.knowledge_base_repository import (
|
||
add_kb_to_db, delete_kb_from_db, list_kbs_from_db, kb_exists,
|
||
load_kb_from_db, get_kb_detail,
|
||
)
|
||
from server.db.repository.knowledge_file_repository import (
|
||
add_file_to_db, delete_file_from_db, delete_files_from_db, file_exists_in_db,
|
||
count_files_from_db, list_files_from_db, get_file_detail, delete_file_from_db,
|
||
list_docs_from_db,delete_docs_from_db_by_ids,update_file_to_db
|
||
)
|
||
|
||
from configs import (kbs_config, VECTOR_SEARCH_TOP_K, SCORE_THRESHOLD,
|
||
EMBEDDING_MODEL, KB_INFO)
|
||
from server.knowledge_base.utils import (
|
||
get_kb_path, get_doc_path, KnowledgeFile,
|
||
list_kbs_from_folder, list_files_from_folder,
|
||
)
|
||
|
||
from typing import List, Union, Dict, Optional, Tuple
|
||
|
||
from server.embeddings_api import embed_texts, aembed_texts, embed_documents
|
||
from server.knowledge_base.model.kb_document_model import DocumentWithVSId
|
||
from configs import logger
|
||
import time
|
||
|
||
|
||
def normalize(embeddings: List[List[float]]) -> np.ndarray:
|
||
'''
|
||
sklearn.preprocessing.normalize 的替代（使用 L2），避免安装 scipy, scikit-learn
|
||
'''
|
||
norm = np.linalg.norm(embeddings, axis=1)
|
||
norm = np.reshape(norm, (norm.shape[0], 1))
|
||
norm = np.tile(norm, (1, len(embeddings[0])))
|
||
return np.divide(embeddings, norm)
|
||
|
||
|
||
class SupportedVSType:
|
||
FAISS = 'faiss'
|
||
MILVUS = 'milvus'
|
||
DEFAULT = 'default'
|
||
ZILLIZ = 'zilliz'
|
||
PG = 'pg'
|
||
ES = 'es'
|
||
|
||
|
||
class KBService(ABC):
|
||
|
||
def __init__(self,
|
||
knowledge_base_name: str,
|
||
embed_model: str = EMBEDDING_MODEL,
|
||
):
|
||
self.kb_name = knowledge_base_name
|
||
self.kb_info = KB_INFO.get(knowledge_base_name, f"关于{knowledge_base_name}的知识库")
|
||
self.embed_model = embed_model
|
||
self.kb_path = get_kb_path(self.kb_name)
|
||
self.doc_path = get_doc_path(self.kb_name)
|
||
self.do_init()
|
||
|
||
def __repr__(self) -> str:
|
||
return f"{self.kb_name} @ {self.embed_model}"
|
||
|
||
def save_vector_store(self):
|
||
'''
|
||
保存向量库:FAISS保存到磁盘，milvus保存到数据库。PGVector暂未支持
|
||
'''
|
||
pass
|
||
|
||
def create_kb(self):
|
||
"""
|
||
创建知识库
|
||
"""
|
||
if not os.path.exists(self.doc_path):
|
||
os.makedirs(self.doc_path)
|
||
self.do_create_kb()
|
||
status = add_kb_to_db(self.kb_name, self.kb_info, self.vs_type(), self.embed_model)
|
||
return status
|
||
|
||
def clear_vs(self):
|
||
"""
|
||
删除向量库中所有内容
|
||
"""
|
||
self.do_clear_vs()
|
||
status = delete_files_from_db(self.kb_name)
|
||
return status
|
||
|
||
def drop_kb(self):
|
||
"""
|
||
删除知识库
|
||
"""
|
||
self.do_drop_kb()
|
||
status = delete_kb_from_db(self.kb_name)
|
||
return status
|
||
|
||
def _docs_to_embeddings(self, docs: List[Document]) -> Dict:
|
||
'''
|
||
将 List[Document] 转化为 VectorStore.add_embeddings 可以接受的参数
|
||
'''
|
||
return embed_documents(docs=docs, embed_model=self.embed_model, to_query=False)
|
||
|
||
def add_doc(self, kb_file: KnowledgeFile, docs: List[Document] = [], **kwargs):
|
||
"""
|
||
向知识库添加文件
|
||
如果指定了docs，则不再将文本向量化，并将数据库对应条目标为custom_docs=True
|
||
"""
|
||
start_time = time.time() # 记录开始时间
|
||
if docs:
|
||
custom_docs = True
|
||
for doc in docs:
|
||
doc.metadata.setdefault("source", kb_file.filename)
|
||
logger.info(f"kb_doc_api add_doc docs 不为空，len(docs)：{len(docs)},文件名称：{kb_file.filename}")
|
||
else:
|
||
docs = kb_file.file2text()
|
||
custom_docs = False
|
||
logger.info(f"kb_doc_api add_doc docs 为空，len(docs)：{len(docs)},文件名称：{kb_file.filename}")
|
||
|
||
end_time = time.time() # 记录结束时间
|
||
execution_time = end_time - start_time # 计算执行时间
|
||
logger.info(f"add_doc: 加载文件或分块耗时{execution_time}秒")
|
||
|
||
start_time = time.time() # 记录开始时间
|
||
if docs:
|
||
# 将 metadata["source"] 改为相对路径
|
||
for doc in docs:
|
||
#增加时间，added by weiweiwang 2024.3.6
|
||
from datetime import datetime
|
||
doc.metadata["updatetime"] = datetime.now().strftime("%Y-%m-%d %H:%M:%S")
|
||
try:
|
||
source = doc.metadata.get("source", "")
|
||
if os.path.isabs(source):
|
||
rel_path = Path(source).relative_to(self.doc_path)
|
||
doc.metadata["source"] = str(rel_path.as_posix().strip("/"))
|
||
except Exception as e:
|
||
logger.info(f"cannot convert absolute path ({source}) to relative path. error is : {e}")
|
||
self.delete_doc(kb_file)
|
||
#logger.info(f"add_doc filepath:{kb_file.filepath}，将要执行do_add_doc")
|
||
doc_infos = self.do_add_doc(docs, **kwargs)
|
||
#logger.info(f"add_doc filepath:{kb_file.filepath} 将要执行dd_file_to_db")
|
||
status = add_file_to_db(kb_file,
|
||
custom_docs=custom_docs,
|
||
docs_count=len(docs),
|
||
doc_infos=doc_infos)
|
||
|
||
end_time = time.time() # 记录结束时间
|
||
execution_time = end_time - start_time # 计算执行时间
|
||
logger.info(f"add_doc: 入库耗时：{execution_time}秒")
|
||
else:
|
||
status = False
|
||
return status
|
||
|
||
def delete_doc(self, kb_file: KnowledgeFile, delete_content: bool = False, **kwargs):
|
||
"""
|
||
从知识库删除文件
|
||
"""
|
||
print(f"delete_doc filepath:{kb_file.filepath}")
|
||
self.do_delete_doc(kb_file, **kwargs)
|
||
status = delete_file_from_db(kb_file)
|
||
if delete_content and os.path.exists(kb_file.filepath):
|
||
os.remove(kb_file.filepath)
|
||
return status
|
||
|
||
def update_info(self, kb_info: str):
|
||
"""
|
||
更新知识库介绍
|
||
"""
|
||
self.kb_info = kb_info
|
||
status = add_kb_to_db(self.kb_name, self.kb_info, self.vs_type(), self.embed_model)
|
||
return status
|
||
|
||
def update_doc(self, kb_file: KnowledgeFile, docs: List[Document] = [], **kwargs):
|
||
"""
|
||
使用content中的文件更新向量库
|
||
如果指定了docs，则使用自定义docs，并将数据库对应条目标为custom_docs=True
|
||
"""
|
||
if os.path.exists(kb_file.filepath) and docs is None:
|
||
self.delete_doc(kb_file, **kwargs)
|
||
|
||
return self.add_doc(kb_file, docs=docs, **kwargs)
|
||
|
||
def exist_doc(self, file_name: str):
|
||
return file_exists_in_db(KnowledgeFile(knowledge_base_name=self.kb_name,
|
||
filename=file_name))
|
||
|
||
def list_files(self):
|
||
return list_files_from_db(self.kb_name)
|
||
|
||
def count_files(self):
|
||
return count_files_from_db(self.kb_name)
|
||
|
||
def search_docs(self,
|
||
query: str,
|
||
top_k: int = VECTOR_SEARCH_TOP_K,
|
||
score_threshold: float = SCORE_THRESHOLD,
|
||
) ->List[Document]:
|
||
docs = self.do_search(query, top_k, score_threshold)
|
||
return docs
|
||
|
||
def search_content(self,
|
||
query: str,
|
||
top_k: int,
|
||
)->List[DocumentWithVSId]:
|
||
print("KBService search_content")
|
||
docs = self.searchbyContent(query,top_k)
|
||
return docs
|
||
|
||
def search_content_internal(self,
|
||
query: str,
|
||
top_k: int,
|
||
)->List[Tuple[Document, float]]:
|
||
docs = self.searchbyContentInternal(query,top_k)
|
||
return docs
|
||
|
||
def get_doc_by_ids(self, ids: List[str]) -> List[Document]:
|
||
return []
|
||
|
||
def del_doc_by_ids(self, ids: List[str]) -> bool:
|
||
raise NotImplementedError
|
||
|
||
def del_doc_by_ids_from_db(self, knowledge_base_name: str , file_name:str, ids: List[str]) -> bool:
|
||
delete_docs_from_db_by_ids(ids)
|
||
update_file_to_db(knowledge_base_name = knowledge_base_name,file_name = file_name)
|
||
#print(f"*******KBService del_doc_by_ids_from_db")
|
||
return True
|
||
|
||
|
||
def update_doc_by_ids(self, docs: Dict[str, Document]) -> bool:
|
||
'''
|
||
传入参数为： {doc_id: Document, ...}
|
||
如果对应 doc_id 的值为 None，或其 page_content 为空，则删除该文档
|
||
'''
|
||
self.del_doc_by_ids(list(docs.keys()))
|
||
docs = []
|
||
ids = []
|
||
for k, v in docs.items():
|
||
if not v or not v.page_content.strip():
|
||
continue
|
||
ids.append(k)
|
||
docs.append(v)
|
||
self.do_add_doc(docs=docs, ids=ids)
|
||
return True
|
||
|
||
def list_docs(self, file_name: str = None, metadata: Dict = {}) -> List[DocumentWithVSId]:
|
||
'''
|
||
通过file_name或metadata检索Document
|
||
'''
|
||
doc_infos = list_docs_from_db(kb_name=self.kb_name, file_name=file_name, metadata=metadata)
|
||
#logger.info(f"kb_doc_api list_docs_from_db: {doc_infos}")
|
||
docs = []
|
||
for x in doc_infos:
|
||
doc_info = self.get_doc_by_ids([x["id"]])
|
||
#print(f"kb_doc_api doc_info: {doc_info}")
|
||
#if doc_info is not None:
|
||
if doc_info is not None and isinstance(doc_info, list):
|
||
if doc_info:
|
||
# 处理非空的情况
|
||
#data = [DocumentWithVSId(**x[0].dict(), score=x[1], id=x[0].metadata.get("id")) for x in docs]
|
||
doc_with_id = DocumentWithVSId(**doc_info[0].dict(), id=x["id"])
|
||
docs.append(doc_with_id)
|
||
else:
|
||
# 处理 doc_info 为空列表的情况
|
||
pass
|
||
else:
|
||
# 处理 doc_info 是 NoneType 或者不是列表的情况
|
||
# 可以选择跳过当前循环迭代或执行其他操作
|
||
#print("base.py list_docs 返回为空")
|
||
pass
|
||
return docs
|
||
|
||
@abstractmethod
|
||
def do_create_kb(self):
|
||
"""
|
||
创建知识库子类实自己逻辑
|
||
"""
|
||
pass
|
||
|
||
@staticmethod
|
||
def list_kbs_type():
|
||
return list(kbs_config.keys())
|
||
|
||
@classmethod
|
||
def list_kbs(cls):
|
||
return list_kbs_from_db()
|
||
|
||
def exists(self, kb_name: str = None):
|
||
kb_name = kb_name or self.kb_name
|
||
return kb_exists(kb_name)
|
||
|
||
@abstractmethod
|
||
def vs_type(self) -> str:
|
||
pass
|
||
|
||
@abstractmethod
|
||
def do_init(self):
|
||
pass
|
||
|
||
@abstractmethod
|
||
def do_drop_kb(self):
|
||
"""
|
||
删除知识库子类实自己逻辑
|
||
"""
|
||
pass
|
||
|
||
@abstractmethod
|
||
def do_search(self,
|
||
query: str,
|
||
top_k: int,
|
||
score_threshold: float,
|
||
) -> List[Tuple[Document, float]]:
|
||
"""
|
||
搜索知识库子类实自己逻辑
|
||
"""
|
||
pass
|
||
|
||
@abstractmethod
|
||
def searchbyContent(self,
|
||
query: str,
|
||
top_k: int,
|
||
)->List[DocumentWithVSId]:
|
||
"""
|
||
搜索知识库子类实自己逻辑
|
||
"""
|
||
pass
|
||
|
||
@abstractmethod
|
||
def searchbyContentInternal(self,
|
||
query: str,
|
||
top_k: int,
|
||
)->List[Tuple[Document, float]]:
|
||
"""
|
||
搜索知识库子类实自己逻辑
|
||
"""
|
||
pass
|
||
|
||
@abstractmethod
|
||
def do_add_doc(self,
|
||
docs: List[Document],
|
||
**kwargs,
|
||
) -> List[Dict]:
|
||
"""
|
||
向知识库添加文档子类实自己逻辑
|
||
"""
|
||
pass
|
||
|
||
@abstractmethod
|
||
def do_delete_doc(self,
|
||
kb_file: KnowledgeFile):
|
||
"""
|
||
从知识库删除文档子类实自己逻辑
|
||
"""
|
||
pass
|
||
|
||
@abstractmethod
|
||
def do_clear_vs(self):
|
||
"""
|
||
从知识库删除全部向量子类实自己逻辑
|
||
"""
|
||
pass
|
||
|
||
|
||
class KBServiceFactory:
|
||
|
||
@staticmethod
|
||
def get_service(kb_name: str,
|
||
vector_store_type: Union[str, SupportedVSType],
|
||
embed_model: str = EMBEDDING_MODEL,
|
||
) -> KBService:
|
||
if isinstance(vector_store_type, str):
|
||
vector_store_type = getattr(SupportedVSType, vector_store_type.upper())
|
||
if SupportedVSType.FAISS == vector_store_type:
|
||
from server.knowledge_base.kb_service.faiss_kb_service import FaissKBService
|
||
return FaissKBService(kb_name, embed_model=embed_model)
|
||
elif SupportedVSType.PG == vector_store_type:
|
||
from server.knowledge_base.kb_service.pg_kb_service import PGKBService
|
||
return PGKBService(kb_name, embed_model=embed_model)
|
||
elif SupportedVSType.MILVUS == vector_store_type:
|
||
from server.knowledge_base.kb_service.milvus_kb_service import MilvusKBService
|
||
return MilvusKBService(kb_name,embed_model=embed_model)
|
||
elif SupportedVSType.ZILLIZ == vector_store_type:
|
||
from server.knowledge_base.kb_service.zilliz_kb_service import ZillizKBService
|
||
return ZillizKBService(kb_name, embed_model=embed_model)
|
||
elif SupportedVSType.DEFAULT == vector_store_type:
|
||
return MilvusKBService(kb_name,
|
||
embed_model=embed_model) # other milvus parameters are set in model_config.kbs_config
|
||
elif SupportedVSType.ES == vector_store_type:
|
||
from server.knowledge_base.kb_service.es_kb_service import ESKBService
|
||
return ESKBService(kb_name, embed_model=embed_model)
|
||
elif SupportedVSType.DEFAULT == vector_store_type: # kb_exists of default kbservice is False, to make validation easier.
|
||
from server.knowledge_base.kb_service.default_kb_service import DefaultKBService
|
||
return DefaultKBService(kb_name)
|
||
|
||
@staticmethod
|
||
def get_service_by_name(kb_name: str) -> KBService:
|
||
_, vs_type, embed_model = load_kb_from_db(kb_name)
|
||
if _ is None: # kb not in db, just return None
|
||
return None
|
||
return KBServiceFactory.get_service(kb_name, vs_type, embed_model)
|
||
|
||
@staticmethod
|
||
def get_default():
|
||
return KBServiceFactory.get_service("default", SupportedVSType.DEFAULT)
|
||
|
||
|
||
def get_kb_details() -> List[Dict]:
|
||
kbs_in_folder = list_kbs_from_folder()
|
||
kbs_in_db = KBService.list_kbs()
|
||
result = {}
|
||
|
||
for kb in kbs_in_folder:
|
||
result[kb] = {
|
||
"kb_name": kb,
|
||
"vs_type": "",
|
||
"kb_info": "",
|
||
"embed_model": "",
|
||
"file_count": 0,
|
||
"create_time": None,
|
||
"in_folder": True,
|
||
"in_db": False,
|
||
}
|
||
|
||
for kb in kbs_in_db:
|
||
kb_detail = get_kb_detail(kb)
|
||
if kb_detail:
|
||
kb_detail["in_db"] = True
|
||
if kb in result:
|
||
result[kb].update(kb_detail)
|
||
else:
|
||
kb_detail["in_folder"] = False
|
||
result[kb] = kb_detail
|
||
|
||
data = []
|
||
for i, v in enumerate(result.values()):
|
||
v['No'] = i + 1
|
||
data.append(v)
|
||
|
||
return data
|
||
|
||
|
||
def get_kb_file_details(kb_name: str) -> List[Dict]:
|
||
kb = KBServiceFactory.get_service_by_name(kb_name)
|
||
if kb is None:
|
||
return []
|
||
|
||
files_in_folder = list_files_from_folder(kb_name)
|
||
files_in_db = kb.list_files()
|
||
result = {}
|
||
|
||
for doc in files_in_folder:
|
||
result[doc] = {
|
||
"kb_name": kb_name,
|
||
"file_name": doc,
|
||
"file_ext": os.path.splitext(doc)[-1],
|
||
"file_version": 0,
|
||
"document_loader": "",
|
||
"docs_count": 0,
|
||
"text_splitter": "",
|
||
"create_time": None,
|
||
"in_folder": True,
|
||
"in_db": False,
|
||
}
|
||
lower_names = {x.lower(): x for x in result}
|
||
for doc in files_in_db:
|
||
doc_detail = get_file_detail(kb_name, doc)
|
||
if doc_detail:
|
||
doc_detail["in_db"] = True
|
||
if doc.lower() in lower_names:
|
||
result[lower_names[doc.lower()]].update(doc_detail)
|
||
else:
|
||
doc_detail["in_folder"] = False
|
||
result[doc] = doc_detail
|
||
|
||
data = []
|
||
for i, v in enumerate(result.values()):
|
||
v['No'] = i + 1
|
||
data.append(v)
|
||
|
||
return data
|
||
|
||
|
||
class EmbeddingsFunAdapter(Embeddings):
|
||
def __init__(self, embed_model: str = EMBEDDING_MODEL):
|
||
self.embed_model = embed_model
|
||
|
||
def embed_documents(self, texts: List[str]) -> List[List[float]]:
|
||
embeddings = embed_texts(texts=texts, embed_model=self.embed_model, to_query=False).data
|
||
return normalize(embeddings).tolist()
|
||
|
||
def embed_query(self, text: str) -> List[float]:
|
||
embeddings = embed_texts(texts=[text], embed_model=self.embed_model, to_query=True).data
|
||
query_embed = embeddings[0]
|
||
query_embed_2d = np.reshape(query_embed, (1, -1)) # 将一维数组转换为二维数组
|
||
normalized_query_embed = normalize(query_embed_2d)
|
||
return normalized_query_embed[0].tolist() # 将结果转换为一维数组并返回
|
||
|
||
async def aembed_documents(self, texts: List[str]) -> List[List[float]]:
|
||
embeddings = (await aembed_texts(texts=texts, embed_model=self.embed_model, to_query=False)).data
|
||
return normalize(embeddings).tolist()
|
||
|
||
async def aembed_query(self, text: str) -> List[float]:
|
||
embeddings = (await aembed_texts(texts=[text], embed_model=self.embed_model, to_query=True)).data
|
||
query_embed = embeddings[0]
|
||
query_embed_2d = np.reshape(query_embed, (1, -1)) # 将一维数组转换为二维数组
|
||
normalized_query_embed = normalize(query_embed_2d)
|
||
return normalized_query_embed[0].tolist() # 将结果转换为一维数组并返回
|
||
|
||
|
||
def score_threshold_process(score_threshold, k, docs):
|
||
if score_threshold is not None:
|
||
cmp = (
|
||
operator.le
|
||
)
|
||
docs = [
|
||
(doc, similarity)
|
||
for doc, similarity in docs
|
||
if cmp(similarity, score_threshold)
|
||
]
|
||
return docs[:k]
|