dataset_retrieval.py 31 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717
  1. import math
  2. import threading
  3. from collections import Counter
  4. from typing import Optional, cast
  5. from flask import Flask, current_app
  6. from core.app.app_config.entities import DatasetEntity, DatasetRetrieveConfigEntity
  7. from core.app.entities.app_invoke_entities import InvokeFrom, ModelConfigWithCredentialsEntity
  8. from core.callback_handler.index_tool_callback_handler import DatasetIndexToolCallbackHandler
  9. from core.entities.agent_entities import PlanningStrategy
  10. from core.memory.token_buffer_memory import TokenBufferMemory
  11. from core.model_manager import ModelInstance, ModelManager
  12. from core.model_runtime.entities.message_entities import PromptMessageTool
  13. from core.model_runtime.entities.model_entities import ModelFeature, ModelType
  14. from core.model_runtime.model_providers.__base.large_language_model import LargeLanguageModel
  15. from core.ops.entities.trace_entity import TraceTaskName
  16. from core.ops.ops_trace_manager import TraceQueueManager, TraceTask
  17. from core.ops.utils import measure_time
  18. from core.rag.data_post_processor.data_post_processor import DataPostProcessor
  19. from core.rag.datasource.keyword.jieba.jieba_keyword_table_handler import JiebaKeywordTableHandler
  20. from core.rag.datasource.retrieval_service import RetrievalService
  21. from core.rag.entities.context_entities import DocumentContext
  22. from core.rag.models.document import Document
  23. from core.rag.rerank.rerank_type import RerankMode
  24. from core.rag.retrieval.retrieval_methods import RetrievalMethod
  25. from core.rag.retrieval.router.multi_dataset_function_call_router import FunctionCallMultiDatasetRouter
  26. from core.rag.retrieval.router.multi_dataset_react_route import ReactMultiDatasetRouter
  27. from core.tools.utils.dataset_retriever.dataset_retriever_base_tool import DatasetRetrieverBaseTool
  28. from extensions.ext_database import db
  29. from models.dataset import Dataset, DatasetQuery, DocumentSegment
  30. from models.dataset import Document as DatasetDocument
  31. from services.external_knowledge_service import ExternalDatasetService
  32. default_retrieval_model = {
  33. "search_method": RetrievalMethod.SEMANTIC_SEARCH.value,
  34. "reranking_enable": False,
  35. "reranking_model": {"reranking_provider_name": "", "reranking_model_name": ""},
  36. "top_k": 2,
  37. "score_threshold_enabled": False,
  38. }
  39. class DatasetRetrieval:
  40. def __init__(self, application_generate_entity=None):
  41. self.application_generate_entity = application_generate_entity
  42. def retrieve(
  43. self,
  44. app_id: str,
  45. user_id: str,
  46. tenant_id: str,
  47. model_config: ModelConfigWithCredentialsEntity,
  48. config: DatasetEntity,
  49. query: str,
  50. invoke_from: InvokeFrom,
  51. show_retrieve_source: bool,
  52. hit_callback: DatasetIndexToolCallbackHandler,
  53. message_id: str,
  54. memory: Optional[TokenBufferMemory] = None,
  55. ) -> Optional[str]:
  56. """
  57. Retrieve dataset.
  58. :param app_id: app_id
  59. :param user_id: user_id
  60. :param tenant_id: tenant id
  61. :param model_config: model config
  62. :param config: dataset config
  63. :param query: query
  64. :param invoke_from: invoke from
  65. :param show_retrieve_source: show retrieve source
  66. :param hit_callback: hit callback
  67. :param message_id: message id
  68. :param memory: memory
  69. :return:
  70. """
  71. dataset_ids = config.dataset_ids
  72. if len(dataset_ids) == 0:
  73. return None
  74. retrieve_config = config.retrieve_config
  75. # check model is support tool calling
  76. model_type_instance = model_config.provider_model_bundle.model_type_instance
  77. model_type_instance = cast(LargeLanguageModel, model_type_instance)
  78. model_manager = ModelManager()
  79. model_instance = model_manager.get_model_instance(
  80. tenant_id=tenant_id, model_type=ModelType.LLM, provider=model_config.provider, model=model_config.model
  81. )
  82. # get model schema
  83. model_schema = model_type_instance.get_model_schema(
  84. model=model_config.model, credentials=model_config.credentials
  85. )
  86. if not model_schema:
  87. return None
  88. planning_strategy = PlanningStrategy.REACT_ROUTER
  89. features = model_schema.features
  90. if features:
  91. if ModelFeature.TOOL_CALL in features or ModelFeature.MULTI_TOOL_CALL in features:
  92. planning_strategy = PlanningStrategy.ROUTER
  93. available_datasets = []
  94. for dataset_id in dataset_ids:
  95. # get dataset from dataset id
  96. dataset = db.session.query(Dataset).filter(Dataset.tenant_id == tenant_id, Dataset.id == dataset_id).first()
  97. # pass if dataset is not available
  98. if not dataset:
  99. continue
  100. # pass if dataset is not available
  101. if dataset and dataset.available_document_count == 0 and dataset.provider != "external":
  102. continue
  103. available_datasets.append(dataset)
  104. all_documents = []
  105. user_from = "account" if invoke_from in {InvokeFrom.EXPLORE, InvokeFrom.DEBUGGER} else "end_user"
  106. if retrieve_config.retrieve_strategy == DatasetRetrieveConfigEntity.RetrieveStrategy.SINGLE:
  107. all_documents = self.single_retrieve(
  108. app_id,
  109. tenant_id,
  110. user_id,
  111. user_from,
  112. available_datasets,
  113. query,
  114. model_instance,
  115. model_config,
  116. planning_strategy,
  117. message_id,
  118. )
  119. elif retrieve_config.retrieve_strategy == DatasetRetrieveConfigEntity.RetrieveStrategy.MULTIPLE:
  120. all_documents = self.multiple_retrieve(
  121. app_id,
  122. tenant_id,
  123. user_id,
  124. user_from,
  125. available_datasets,
  126. query,
  127. retrieve_config.top_k,
  128. retrieve_config.score_threshold,
  129. retrieve_config.rerank_mode,
  130. retrieve_config.reranking_model,
  131. retrieve_config.weights,
  132. retrieve_config.reranking_enabled,
  133. message_id,
  134. )
  135. dify_documents = [item for item in all_documents if item.provider == "dify"]
  136. external_documents = [item for item in all_documents if item.provider == "external"]
  137. document_context_list = []
  138. retrieval_resource_list = []
  139. # deal with external documents
  140. for item in external_documents:
  141. document_context_list.append(DocumentContext(content=item.page_content, score=item.metadata.get("score")))
  142. source = {
  143. "dataset_id": item.metadata.get("dataset_id"),
  144. "dataset_name": item.metadata.get("dataset_name"),
  145. "document_name": item.metadata.get("title"),
  146. "data_source_type": "external",
  147. "retriever_from": invoke_from.to_source(),
  148. "score": item.metadata.get("score"),
  149. "content": item.page_content,
  150. }
  151. retrieval_resource_list.append(source)
  152. document_score_list = {}
  153. # deal with dify documents
  154. if dify_documents:
  155. for item in dify_documents:
  156. if item.metadata.get("score"):
  157. document_score_list[item.metadata["doc_id"]] = item.metadata["score"]
  158. index_node_ids = [document.metadata["doc_id"] for document in dify_documents]
  159. segments = DocumentSegment.query.filter(
  160. DocumentSegment.dataset_id.in_(dataset_ids),
  161. DocumentSegment.status == "completed",
  162. DocumentSegment.enabled == True,
  163. DocumentSegment.index_node_id.in_(index_node_ids),
  164. ).all()
  165. if segments:
  166. index_node_id_to_position = {id: position for position, id in enumerate(index_node_ids)}
  167. sorted_segments = sorted(
  168. segments, key=lambda segment: index_node_id_to_position.get(segment.index_node_id, float("inf"))
  169. )
  170. for segment in sorted_segments:
  171. if segment.answer:
  172. document_context_list.append(
  173. DocumentContext(
  174. content=f"question:{segment.get_sign_content()} answer:{segment.answer}",
  175. score=document_score_list.get(segment.index_node_id, None),
  176. )
  177. )
  178. else:
  179. document_context_list.append(
  180. DocumentContext(
  181. content=segment.get_sign_content(),
  182. score=document_score_list.get(segment.index_node_id, None),
  183. )
  184. )
  185. if show_retrieve_source:
  186. for segment in sorted_segments:
  187. dataset = Dataset.query.filter_by(id=segment.dataset_id).first()
  188. document = DatasetDocument.query.filter(
  189. DatasetDocument.id == segment.document_id,
  190. DatasetDocument.enabled == True,
  191. DatasetDocument.archived == False,
  192. ).first()
  193. if dataset and document:
  194. source = {
  195. "dataset_id": dataset.id,
  196. "dataset_name": dataset.name,
  197. "document_id": document.id,
  198. "document_name": document.name,
  199. "data_source_type": document.data_source_type,
  200. "segment_id": segment.id,
  201. "retriever_from": invoke_from.to_source(),
  202. "score": document_score_list.get(segment.index_node_id, 0.0),
  203. }
  204. if invoke_from.to_source() == "dev":
  205. source["hit_count"] = segment.hit_count
  206. source["word_count"] = segment.word_count
  207. source["segment_position"] = segment.position
  208. source["index_node_hash"] = segment.index_node_hash
  209. if segment.answer:
  210. source["content"] = f"question:{segment.content} \nanswer:{segment.answer}"
  211. else:
  212. source["content"] = segment.content
  213. retrieval_resource_list.append(source)
  214. if hit_callback and retrieval_resource_list:
  215. retrieval_resource_list = sorted(retrieval_resource_list, key=lambda x: x.get("score") or 0.0, reverse=True)
  216. for position, item in enumerate(retrieval_resource_list, start=1):
  217. item["position"] = position
  218. hit_callback.return_retriever_resource_info(retrieval_resource_list)
  219. if document_context_list:
  220. document_context_list = sorted(document_context_list, key=lambda x: x.score or 0.0, reverse=True)
  221. return str("\n".join([document_context.content for document_context in document_context_list]))
  222. return ""
  223. def single_retrieve(
  224. self,
  225. app_id: str,
  226. tenant_id: str,
  227. user_id: str,
  228. user_from: str,
  229. available_datasets: list,
  230. query: str,
  231. model_instance: ModelInstance,
  232. model_config: ModelConfigWithCredentialsEntity,
  233. planning_strategy: PlanningStrategy,
  234. message_id: Optional[str] = None,
  235. ):
  236. tools = []
  237. for dataset in available_datasets:
  238. description = dataset.description
  239. if not description:
  240. description = "useful for when you want to answer queries about the " + dataset.name
  241. description = description.replace("\n", "").replace("\r", "")
  242. message_tool = PromptMessageTool(
  243. name=dataset.id,
  244. description=description,
  245. parameters={
  246. "type": "object",
  247. "properties": {},
  248. "required": [],
  249. },
  250. )
  251. tools.append(message_tool)
  252. dataset_id = None
  253. if planning_strategy == PlanningStrategy.REACT_ROUTER:
  254. react_multi_dataset_router = ReactMultiDatasetRouter()
  255. dataset_id = react_multi_dataset_router.invoke(
  256. query, tools, model_config, model_instance, user_id, tenant_id
  257. )
  258. elif planning_strategy == PlanningStrategy.ROUTER:
  259. function_call_router = FunctionCallMultiDatasetRouter()
  260. dataset_id = function_call_router.invoke(query, tools, model_config, model_instance)
  261. if dataset_id:
  262. # get retrieval model config
  263. dataset = db.session.query(Dataset).filter(Dataset.id == dataset_id).first()
  264. if dataset:
  265. results = []
  266. if dataset.provider == "external":
  267. external_documents = ExternalDatasetService.fetch_external_knowledge_retrieval(
  268. tenant_id=dataset.tenant_id,
  269. dataset_id=dataset_id,
  270. query=query,
  271. external_retrieval_parameters=dataset.retrieval_model,
  272. )
  273. for external_document in external_documents:
  274. document = Document(
  275. page_content=external_document.get("content"),
  276. metadata=external_document.get("metadata"),
  277. provider="external",
  278. )
  279. document.metadata["score"] = external_document.get("score")
  280. document.metadata["title"] = external_document.get("title")
  281. document.metadata["dataset_id"] = dataset_id
  282. document.metadata["dataset_name"] = dataset.name
  283. results.append(document)
  284. else:
  285. retrieval_model_config = dataset.retrieval_model or default_retrieval_model
  286. # get top k
  287. top_k = retrieval_model_config["top_k"]
  288. # get retrieval method
  289. if dataset.indexing_technique == "economy":
  290. retrieval_method = "keyword_search"
  291. else:
  292. retrieval_method = retrieval_model_config["search_method"]
  293. # get reranking model
  294. reranking_model = (
  295. retrieval_model_config["reranking_model"]
  296. if retrieval_model_config["reranking_enable"]
  297. else None
  298. )
  299. # get score threshold
  300. score_threshold = 0.0
  301. score_threshold_enabled = retrieval_model_config.get("score_threshold_enabled")
  302. if score_threshold_enabled:
  303. score_threshold = retrieval_model_config.get("score_threshold")
  304. with measure_time() as timer:
  305. results = RetrievalService.retrieve(
  306. retrieval_method=retrieval_method,
  307. dataset_id=dataset.id,
  308. query=query,
  309. top_k=top_k,
  310. score_threshold=score_threshold,
  311. reranking_model=reranking_model,
  312. reranking_mode=retrieval_model_config.get("reranking_mode", "reranking_model"),
  313. weights=retrieval_model_config.get("weights", None),
  314. )
  315. self._on_query(query, [dataset_id], app_id, user_from, user_id)
  316. if results:
  317. self._on_retrieval_end(results, message_id, timer)
  318. return results
  319. return []
  320. def multiple_retrieve(
  321. self,
  322. app_id: str,
  323. tenant_id: str,
  324. user_id: str,
  325. user_from: str,
  326. available_datasets: list,
  327. query: str,
  328. top_k: int,
  329. score_threshold: float,
  330. reranking_mode: str,
  331. reranking_model: Optional[dict] = None,
  332. weights: Optional[dict] = None,
  333. reranking_enable: bool = True,
  334. message_id: Optional[str] = None,
  335. ):
  336. if not available_datasets:
  337. return []
  338. threads = []
  339. all_documents = []
  340. dataset_ids = [dataset.id for dataset in available_datasets]
  341. index_type_check = all(
  342. item.indexing_technique == available_datasets[0].indexing_technique for item in available_datasets
  343. )
  344. if not index_type_check and (not reranking_enable or reranking_mode != RerankMode.RERANKING_MODEL):
  345. raise ValueError(
  346. "The configured knowledge base list have different indexing technique, please set reranking model."
  347. )
  348. index_type = available_datasets[0].indexing_technique
  349. if index_type == "high_quality":
  350. embedding_model_check = all(
  351. item.embedding_model == available_datasets[0].embedding_model for item in available_datasets
  352. )
  353. embedding_model_provider_check = all(
  354. item.embedding_model_provider == available_datasets[0].embedding_model_provider
  355. for item in available_datasets
  356. )
  357. if (
  358. reranking_enable
  359. and reranking_mode == "weighted_score"
  360. and (not embedding_model_check or not embedding_model_provider_check)
  361. ):
  362. raise ValueError(
  363. "The configured knowledge base list have different embedding model, please set reranking model."
  364. )
  365. if reranking_enable and reranking_mode == RerankMode.WEIGHTED_SCORE:
  366. weights["vector_setting"]["embedding_provider_name"] = available_datasets[0].embedding_model_provider
  367. weights["vector_setting"]["embedding_model_name"] = available_datasets[0].embedding_model
  368. for dataset in available_datasets:
  369. index_type = dataset.indexing_technique
  370. retrieval_thread = threading.Thread(
  371. target=self._retriever,
  372. kwargs={
  373. "flask_app": current_app._get_current_object(),
  374. "dataset_id": dataset.id,
  375. "query": query,
  376. "top_k": top_k,
  377. "all_documents": all_documents,
  378. },
  379. )
  380. threads.append(retrieval_thread)
  381. retrieval_thread.start()
  382. for thread in threads:
  383. thread.join()
  384. with measure_time() as timer:
  385. if reranking_enable:
  386. # do rerank for searched documents
  387. data_post_processor = DataPostProcessor(tenant_id, reranking_mode, reranking_model, weights, False)
  388. all_documents = data_post_processor.invoke(
  389. query=query, documents=all_documents, score_threshold=score_threshold, top_n=top_k
  390. )
  391. else:
  392. if index_type == "economy":
  393. all_documents = self.calculate_keyword_score(query, all_documents, top_k)
  394. elif index_type == "high_quality":
  395. all_documents = self.calculate_vector_score(all_documents, top_k, score_threshold)
  396. self._on_query(query, dataset_ids, app_id, user_from, user_id)
  397. if all_documents:
  398. self._on_retrieval_end(all_documents, message_id, timer)
  399. return all_documents
  400. def _on_retrieval_end(
  401. self, documents: list[Document], message_id: Optional[str] = None, timer: Optional[dict] = None
  402. ) -> None:
  403. """Handle retrieval end."""
  404. dify_documents = [document for document in documents if document.provider == "dify"]
  405. for document in dify_documents:
  406. query = db.session.query(DocumentSegment).filter(
  407. DocumentSegment.index_node_id == document.metadata["doc_id"]
  408. )
  409. # if 'dataset_id' in document.metadata:
  410. if "dataset_id" in document.metadata:
  411. query = query.filter(DocumentSegment.dataset_id == document.metadata["dataset_id"])
  412. # add hit count to document segment
  413. query.update({DocumentSegment.hit_count: DocumentSegment.hit_count + 1}, synchronize_session=False)
  414. db.session.commit()
  415. # get tracing instance
  416. trace_manager: TraceQueueManager | None = (
  417. self.application_generate_entity.trace_manager if self.application_generate_entity else None
  418. )
  419. if trace_manager:
  420. trace_manager.add_trace_task(
  421. TraceTask(
  422. TraceTaskName.DATASET_RETRIEVAL_TRACE, message_id=message_id, documents=documents, timer=timer
  423. )
  424. )
  425. def _on_query(self, query: str, dataset_ids: list[str], app_id: str, user_from: str, user_id: str) -> None:
  426. """
  427. Handle query.
  428. """
  429. if not query:
  430. return
  431. dataset_queries = []
  432. for dataset_id in dataset_ids:
  433. dataset_query = DatasetQuery(
  434. dataset_id=dataset_id,
  435. content=query,
  436. source="app",
  437. source_app_id=app_id,
  438. created_by_role=user_from,
  439. created_by=user_id,
  440. )
  441. dataset_queries.append(dataset_query)
  442. if dataset_queries:
  443. db.session.add_all(dataset_queries)
  444. db.session.commit()
  445. def _retriever(self, flask_app: Flask, dataset_id: str, query: str, top_k: int, all_documents: list):
  446. with flask_app.app_context():
  447. dataset = db.session.query(Dataset).filter(Dataset.id == dataset_id).first()
  448. if not dataset:
  449. return []
  450. if dataset.provider == "external":
  451. external_documents = ExternalDatasetService.fetch_external_knowledge_retrieval(
  452. tenant_id=dataset.tenant_id,
  453. dataset_id=dataset_id,
  454. query=query,
  455. external_retrieval_parameters=dataset.retrieval_model,
  456. )
  457. for external_document in external_documents:
  458. document = Document(
  459. page_content=external_document.get("content"),
  460. metadata=external_document.get("metadata"),
  461. provider="external",
  462. )
  463. document.metadata["score"] = external_document.get("score")
  464. document.metadata["title"] = external_document.get("title")
  465. document.metadata["dataset_id"] = dataset_id
  466. document.metadata["dataset_name"] = dataset.name
  467. all_documents.append(document)
  468. else:
  469. # get retrieval model , if the model is not setting , using default
  470. retrieval_model = dataset.retrieval_model or default_retrieval_model
  471. if dataset.indexing_technique == "economy":
  472. # use keyword table query
  473. documents = RetrievalService.retrieve(
  474. retrieval_method="keyword_search", dataset_id=dataset.id, query=query, top_k=top_k
  475. )
  476. if documents:
  477. all_documents.extend(documents)
  478. else:
  479. if top_k > 0:
  480. # retrieval source
  481. documents = RetrievalService.retrieve(
  482. retrieval_method=retrieval_model["search_method"],
  483. dataset_id=dataset.id,
  484. query=query,
  485. top_k=retrieval_model.get("top_k") or 2,
  486. score_threshold=retrieval_model.get("score_threshold", 0.0)
  487. if retrieval_model["score_threshold_enabled"]
  488. else 0.0,
  489. reranking_model=retrieval_model.get("reranking_model", None)
  490. if retrieval_model["reranking_enable"]
  491. else None,
  492. reranking_mode=retrieval_model.get("reranking_mode") or "reranking_model",
  493. weights=retrieval_model.get("weights", None),
  494. )
  495. all_documents.extend(documents)
  496. def to_dataset_retriever_tool(
  497. self,
  498. tenant_id: str,
  499. dataset_ids: list[str],
  500. retrieve_config: DatasetRetrieveConfigEntity,
  501. return_resource: bool,
  502. invoke_from: InvokeFrom,
  503. hit_callback: DatasetIndexToolCallbackHandler,
  504. ) -> Optional[list[DatasetRetrieverBaseTool]]:
  505. """
  506. A dataset tool is a tool that can be used to retrieve information from a dataset
  507. :param tenant_id: tenant id
  508. :param dataset_ids: dataset ids
  509. :param retrieve_config: retrieve config
  510. :param return_resource: return resource
  511. :param invoke_from: invoke from
  512. :param hit_callback: hit callback
  513. """
  514. tools = []
  515. available_datasets = []
  516. for dataset_id in dataset_ids:
  517. # get dataset from dataset id
  518. dataset = db.session.query(Dataset).filter(Dataset.tenant_id == tenant_id, Dataset.id == dataset_id).first()
  519. # pass if dataset is not available
  520. if not dataset:
  521. continue
  522. # pass if dataset is not available
  523. if dataset and dataset.provider != "external" and dataset.available_document_count == 0:
  524. continue
  525. available_datasets.append(dataset)
  526. if retrieve_config.retrieve_strategy == DatasetRetrieveConfigEntity.RetrieveStrategy.SINGLE:
  527. # get retrieval model config
  528. default_retrieval_model = {
  529. "search_method": RetrievalMethod.SEMANTIC_SEARCH.value,
  530. "reranking_enable": False,
  531. "reranking_model": {"reranking_provider_name": "", "reranking_model_name": ""},
  532. "top_k": 2,
  533. "score_threshold_enabled": False,
  534. }
  535. for dataset in available_datasets:
  536. retrieval_model_config = dataset.retrieval_model or default_retrieval_model
  537. # get top k
  538. top_k = retrieval_model_config["top_k"]
  539. # get score threshold
  540. score_threshold = None
  541. score_threshold_enabled = retrieval_model_config.get("score_threshold_enabled")
  542. if score_threshold_enabled:
  543. score_threshold = retrieval_model_config.get("score_threshold")
  544. from core.tools.utils.dataset_retriever.dataset_retriever_tool import DatasetRetrieverTool
  545. tool = DatasetRetrieverTool.from_dataset(
  546. dataset=dataset,
  547. top_k=top_k,
  548. score_threshold=score_threshold,
  549. hit_callbacks=[hit_callback],
  550. return_resource=return_resource,
  551. retriever_from=invoke_from.to_source(),
  552. )
  553. tools.append(tool)
  554. elif retrieve_config.retrieve_strategy == DatasetRetrieveConfigEntity.RetrieveStrategy.MULTIPLE:
  555. from core.tools.utils.dataset_retriever.dataset_multi_retriever_tool import DatasetMultiRetrieverTool
  556. tool = DatasetMultiRetrieverTool.from_dataset(
  557. dataset_ids=[dataset.id for dataset in available_datasets],
  558. tenant_id=tenant_id,
  559. top_k=retrieve_config.top_k or 2,
  560. score_threshold=retrieve_config.score_threshold,
  561. hit_callbacks=[hit_callback],
  562. return_resource=return_resource,
  563. retriever_from=invoke_from.to_source(),
  564. reranking_provider_name=retrieve_config.reranking_model.get("reranking_provider_name"),
  565. reranking_model_name=retrieve_config.reranking_model.get("reranking_model_name"),
  566. )
  567. tools.append(tool)
  568. return tools
  569. def calculate_keyword_score(self, query: str, documents: list[Document], top_k: int) -> list[Document]:
  570. """
  571. Calculate keywords scores
  572. :param query: search query
  573. :param documents: documents for reranking
  574. :return:
  575. """
  576. keyword_table_handler = JiebaKeywordTableHandler()
  577. query_keywords = keyword_table_handler.extract_keywords(query, None)
  578. documents_keywords = []
  579. for document in documents:
  580. # get the document keywords
  581. document_keywords = keyword_table_handler.extract_keywords(document.page_content, None)
  582. document.metadata["keywords"] = document_keywords
  583. documents_keywords.append(document_keywords)
  584. # Counter query keywords(TF)
  585. query_keyword_counts = Counter(query_keywords)
  586. # total documents
  587. total_documents = len(documents)
  588. # calculate all documents' keywords IDF
  589. all_keywords = set()
  590. for document_keywords in documents_keywords:
  591. all_keywords.update(document_keywords)
  592. keyword_idf = {}
  593. for keyword in all_keywords:
  594. # calculate include query keywords' documents
  595. doc_count_containing_keyword = sum(1 for doc_keywords in documents_keywords if keyword in doc_keywords)
  596. # IDF
  597. keyword_idf[keyword] = math.log((1 + total_documents) / (1 + doc_count_containing_keyword)) + 1
  598. query_tfidf = {}
  599. for keyword, count in query_keyword_counts.items():
  600. tf = count
  601. idf = keyword_idf.get(keyword, 0)
  602. query_tfidf[keyword] = tf * idf
  603. # calculate all documents' TF-IDF
  604. documents_tfidf = []
  605. for document_keywords in documents_keywords:
  606. document_keyword_counts = Counter(document_keywords)
  607. document_tfidf = {}
  608. for keyword, count in document_keyword_counts.items():
  609. tf = count
  610. idf = keyword_idf.get(keyword, 0)
  611. document_tfidf[keyword] = tf * idf
  612. documents_tfidf.append(document_tfidf)
  613. def cosine_similarity(vec1, vec2):
  614. intersection = set(vec1.keys()) & set(vec2.keys())
  615. numerator = sum(vec1[x] * vec2[x] for x in intersection)
  616. sum1 = sum(vec1[x] ** 2 for x in vec1)
  617. sum2 = sum(vec2[x] ** 2 for x in vec2)
  618. denominator = math.sqrt(sum1) * math.sqrt(sum2)
  619. if not denominator:
  620. return 0.0
  621. else:
  622. return float(numerator) / denominator
  623. similarities = []
  624. for document_tfidf in documents_tfidf:
  625. similarity = cosine_similarity(query_tfidf, document_tfidf)
  626. similarities.append(similarity)
  627. for document, score in zip(documents, similarities):
  628. # format document
  629. document.metadata["score"] = score
  630. documents = sorted(documents, key=lambda x: x.metadata["score"], reverse=True)
  631. return documents[:top_k] if top_k else documents
  632. def calculate_vector_score(
  633. self, all_documents: list[Document], top_k: int, score_threshold: float
  634. ) -> list[Document]:
  635. filter_documents = []
  636. for document in all_documents:
  637. if score_threshold is None or document.metadata["score"] >= score_threshold:
  638. filter_documents.append(document)
  639. if not filter_documents:
  640. return []
  641. filter_documents = sorted(filter_documents, key=lambda x: x.metadata["score"], reverse=True)
  642. return filter_documents[:top_k] if top_k else filter_documents