indexing_runner.py 36 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853
  1. import datetime
  2. import json
  3. import logging
  4. import re
  5. import threading
  6. import time
  7. import uuid
  8. from typing import Optional, List, cast, Type, Union, Literal, AbstractSet, Collection, Any
  9. from flask import current_app, Flask
  10. from flask_login import current_user
  11. from langchain.schema import Document
  12. from langchain.text_splitter import TextSplitter, TS, TokenTextSplitter
  13. from sqlalchemy.orm.exc import ObjectDeletedError
  14. from core.data_loader.file_extractor import FileExtractor
  15. from core.data_loader.loader.notion import NotionLoader
  16. from core.docstore.dataset_docstore import DatasetDocumentStore
  17. from core.generator.llm_generator import LLMGenerator
  18. from core.index.index import IndexBuilder
  19. from core.model_manager import ModelManager
  20. from core.errors.error import ProviderTokenNotInitError
  21. from core.model_runtime.entities.model_entities import ModelType, PriceType
  22. from core.model_runtime.model_providers.__base.large_language_model import LargeLanguageModel
  23. from core.model_runtime.model_providers.__base.text_embedding_model import TextEmbeddingModel
  24. from core.model_runtime.model_providers.__base.tokenizers.gpt2_tokenzier import GPT2Tokenizer
  25. from core.spiltter.fixed_text_splitter import FixedRecursiveCharacterTextSplitter, EnhanceRecursiveCharacterTextSplitter
  26. from extensions.ext_database import db
  27. from extensions.ext_redis import redis_client
  28. from extensions.ext_storage import storage
  29. from libs import helper
  30. from models.dataset import Document as DatasetDocument
  31. from models.dataset import Dataset, DocumentSegment, DatasetProcessRule
  32. from models.model import UploadFile
  33. from models.source import DataSourceBinding
  34. class IndexingRunner:
  35. def __init__(self):
  36. self.storage = storage
  37. self.model_manager = ModelManager()
  38. def run(self, dataset_documents: List[DatasetDocument]):
  39. """Run the indexing process."""
  40. for dataset_document in dataset_documents:
  41. try:
  42. # get dataset
  43. dataset = Dataset.query.filter_by(
  44. id=dataset_document.dataset_id
  45. ).first()
  46. if not dataset:
  47. raise ValueError("no dataset found")
  48. # get the process rule
  49. processing_rule = db.session.query(DatasetProcessRule). \
  50. filter(DatasetProcessRule.id == dataset_document.dataset_process_rule_id). \
  51. first()
  52. # load file
  53. text_docs = self._load_data(dataset_document)
  54. # get splitter
  55. splitter = self._get_splitter(processing_rule)
  56. # split to documents
  57. documents = self._step_split(
  58. text_docs=text_docs,
  59. splitter=splitter,
  60. dataset=dataset,
  61. dataset_document=dataset_document,
  62. processing_rule=processing_rule
  63. )
  64. self._build_index(
  65. dataset=dataset,
  66. dataset_document=dataset_document,
  67. documents=documents
  68. )
  69. except DocumentIsPausedException:
  70. raise DocumentIsPausedException('Document paused, document id: {}'.format(dataset_document.id))
  71. except ProviderTokenNotInitError as e:
  72. dataset_document.indexing_status = 'error'
  73. dataset_document.error = str(e.description)
  74. dataset_document.stopped_at = datetime.datetime.utcnow()
  75. db.session.commit()
  76. except ObjectDeletedError:
  77. logging.warning('Document deleted, document id: {}'.format(dataset_document.id))
  78. except Exception as e:
  79. logging.exception("consume document failed")
  80. dataset_document.indexing_status = 'error'
  81. dataset_document.error = str(e)
  82. dataset_document.stopped_at = datetime.datetime.utcnow()
  83. db.session.commit()
  84. def run_in_splitting_status(self, dataset_document: DatasetDocument):
  85. """Run the indexing process when the index_status is splitting."""
  86. try:
  87. # get dataset
  88. dataset = Dataset.query.filter_by(
  89. id=dataset_document.dataset_id
  90. ).first()
  91. if not dataset:
  92. raise ValueError("no dataset found")
  93. # get exist document_segment list and delete
  94. document_segments = DocumentSegment.query.filter_by(
  95. dataset_id=dataset.id,
  96. document_id=dataset_document.id
  97. ).all()
  98. for document_segment in document_segments:
  99. db.session.delete(document_segment)
  100. db.session.commit()
  101. # load file
  102. text_docs = self._load_data(dataset_document)
  103. # get the process rule
  104. processing_rule = db.session.query(DatasetProcessRule). \
  105. filter(DatasetProcessRule.id == dataset_document.dataset_process_rule_id). \
  106. first()
  107. # get splitter
  108. splitter = self._get_splitter(processing_rule)
  109. # split to documents
  110. documents = self._step_split(
  111. text_docs=text_docs,
  112. splitter=splitter,
  113. dataset=dataset,
  114. dataset_document=dataset_document,
  115. processing_rule=processing_rule
  116. )
  117. # build index
  118. self._build_index(
  119. dataset=dataset,
  120. dataset_document=dataset_document,
  121. documents=documents
  122. )
  123. except DocumentIsPausedException:
  124. raise DocumentIsPausedException('Document paused, document id: {}'.format(dataset_document.id))
  125. except ProviderTokenNotInitError as e:
  126. dataset_document.indexing_status = 'error'
  127. dataset_document.error = str(e.description)
  128. dataset_document.stopped_at = datetime.datetime.utcnow()
  129. db.session.commit()
  130. except Exception as e:
  131. logging.exception("consume document failed")
  132. dataset_document.indexing_status = 'error'
  133. dataset_document.error = str(e)
  134. dataset_document.stopped_at = datetime.datetime.utcnow()
  135. db.session.commit()
  136. def run_in_indexing_status(self, dataset_document: DatasetDocument):
  137. """Run the indexing process when the index_status is indexing."""
  138. try:
  139. # get dataset
  140. dataset = Dataset.query.filter_by(
  141. id=dataset_document.dataset_id
  142. ).first()
  143. if not dataset:
  144. raise ValueError("no dataset found")
  145. # get exist document_segment list and delete
  146. document_segments = DocumentSegment.query.filter_by(
  147. dataset_id=dataset.id,
  148. document_id=dataset_document.id
  149. ).all()
  150. documents = []
  151. if document_segments:
  152. for document_segment in document_segments:
  153. # transform segment to node
  154. if document_segment.status != "completed":
  155. document = Document(
  156. page_content=document_segment.content,
  157. metadata={
  158. "doc_id": document_segment.index_node_id,
  159. "doc_hash": document_segment.index_node_hash,
  160. "document_id": document_segment.document_id,
  161. "dataset_id": document_segment.dataset_id,
  162. }
  163. )
  164. documents.append(document)
  165. # build index
  166. self._build_index(
  167. dataset=dataset,
  168. dataset_document=dataset_document,
  169. documents=documents
  170. )
  171. except DocumentIsPausedException:
  172. raise DocumentIsPausedException('Document paused, document id: {}'.format(dataset_document.id))
  173. except ProviderTokenNotInitError as e:
  174. dataset_document.indexing_status = 'error'
  175. dataset_document.error = str(e.description)
  176. dataset_document.stopped_at = datetime.datetime.utcnow()
  177. db.session.commit()
  178. except Exception as e:
  179. logging.exception("consume document failed")
  180. dataset_document.indexing_status = 'error'
  181. dataset_document.error = str(e)
  182. dataset_document.stopped_at = datetime.datetime.utcnow()
  183. db.session.commit()
  184. def file_indexing_estimate(self, tenant_id: str, file_details: List[UploadFile], tmp_processing_rule: dict,
  185. doc_form: str = None, doc_language: str = 'English', dataset_id: str = None,
  186. indexing_technique: str = 'economy') -> dict:
  187. """
  188. Estimate the indexing for the document.
  189. """
  190. embedding_model_instance = None
  191. if dataset_id:
  192. dataset = Dataset.query.filter_by(
  193. id=dataset_id
  194. ).first()
  195. if not dataset:
  196. raise ValueError('Dataset not found.')
  197. if dataset.indexing_technique == 'high_quality' or indexing_technique == 'high_quality':
  198. embedding_model_instance = self.model_manager.get_model_instance(
  199. tenant_id=tenant_id,
  200. provider=dataset.embedding_model_provider,
  201. model_type=ModelType.TEXT_EMBEDDING,
  202. model=dataset.embedding_model
  203. )
  204. else:
  205. if indexing_technique == 'high_quality':
  206. embedding_model_instance = self.model_manager.get_default_model_instance(
  207. tenant_id=tenant_id,
  208. model_type=ModelType.TEXT_EMBEDDING,
  209. )
  210. tokens = 0
  211. preview_texts = []
  212. total_segments = 0
  213. for file_detail in file_details:
  214. # load data from file
  215. text_docs = FileExtractor.load(file_detail)
  216. processing_rule = DatasetProcessRule(
  217. mode=tmp_processing_rule["mode"],
  218. rules=json.dumps(tmp_processing_rule["rules"])
  219. )
  220. # get splitter
  221. splitter = self._get_splitter(processing_rule)
  222. # split to documents
  223. documents = self._split_to_documents_for_estimate(
  224. text_docs=text_docs,
  225. splitter=splitter,
  226. processing_rule=processing_rule
  227. )
  228. total_segments += len(documents)
  229. for document in documents:
  230. if len(preview_texts) < 5:
  231. preview_texts.append(document.page_content)
  232. if indexing_technique == 'high_quality' or embedding_model_instance:
  233. embedding_model_type_instance = embedding_model_instance.model_type_instance
  234. embedding_model_type_instance = cast(TextEmbeddingModel, embedding_model_type_instance)
  235. tokens += embedding_model_type_instance.get_num_tokens(
  236. model=embedding_model_instance.model,
  237. credentials=embedding_model_instance.credentials,
  238. texts=[self.filter_string(document.page_content)]
  239. )
  240. if doc_form and doc_form == 'qa_model':
  241. model_instance = self.model_manager.get_default_model_instance(
  242. tenant_id=tenant_id,
  243. model_type=ModelType.LLM
  244. )
  245. model_type_instance = model_instance.model_type_instance
  246. model_type_instance = cast(LargeLanguageModel, model_type_instance)
  247. if len(preview_texts) > 0:
  248. # qa model document
  249. response = LLMGenerator.generate_qa_document(current_user.current_tenant_id, preview_texts[0],
  250. doc_language)
  251. document_qa_list = self.format_split_text(response)
  252. price_info = model_type_instance.get_price(
  253. model=model_instance.model,
  254. credentials=model_instance.credentials,
  255. price_type=PriceType.INPUT,
  256. tokens=total_segments * 2000,
  257. )
  258. return {
  259. "total_segments": total_segments * 20,
  260. "tokens": total_segments * 2000,
  261. "total_price": '{:f}'.format(price_info.total_amount),
  262. "currency": price_info.currency,
  263. "qa_preview": document_qa_list,
  264. "preview": preview_texts
  265. }
  266. if embedding_model_instance:
  267. embedding_model_type_instance = cast(TextEmbeddingModel, embedding_model_instance.model_type_instance)
  268. embedding_price_info = embedding_model_type_instance.get_price(
  269. model=embedding_model_instance.model,
  270. credentials=embedding_model_instance.credentials,
  271. price_type=PriceType.INPUT,
  272. tokens=tokens
  273. )
  274. return {
  275. "total_segments": total_segments,
  276. "tokens": tokens,
  277. "total_price": '{:f}'.format(embedding_price_info.total_amount) if embedding_model_instance else 0,
  278. "currency": embedding_price_info.currency if embedding_model_instance else 'USD',
  279. "preview": preview_texts
  280. }
  281. def notion_indexing_estimate(self, tenant_id: str, notion_info_list: list, tmp_processing_rule: dict,
  282. doc_form: str = None, doc_language: str = 'English', dataset_id: str = None,
  283. indexing_technique: str = 'economy') -> dict:
  284. """
  285. Estimate the indexing for the document.
  286. """
  287. embedding_model_instance = None
  288. if dataset_id:
  289. dataset = Dataset.query.filter_by(
  290. id=dataset_id
  291. ).first()
  292. if not dataset:
  293. raise ValueError('Dataset not found.')
  294. if dataset.indexing_technique == 'high_quality' or indexing_technique == 'high_quality':
  295. embedding_model_instance = self.model_manager.get_model_instance(
  296. tenant_id=tenant_id,
  297. provider=dataset.embedding_model_provider,
  298. model_type=ModelType.TEXT_EMBEDDING,
  299. model=dataset.embedding_model
  300. )
  301. else:
  302. if indexing_technique == 'high_quality':
  303. embedding_model_instance = self.model_manager.get_default_model_instance(
  304. tenant_id=tenant_id,
  305. model_type=ModelType.TEXT_EMBEDDING
  306. )
  307. # load data from notion
  308. tokens = 0
  309. preview_texts = []
  310. total_segments = 0
  311. for notion_info in notion_info_list:
  312. workspace_id = notion_info['workspace_id']
  313. data_source_binding = DataSourceBinding.query.filter(
  314. db.and_(
  315. DataSourceBinding.tenant_id == current_user.current_tenant_id,
  316. DataSourceBinding.provider == 'notion',
  317. DataSourceBinding.disabled == False,
  318. DataSourceBinding.source_info['workspace_id'] == f'"{workspace_id}"'
  319. )
  320. ).first()
  321. if not data_source_binding:
  322. raise ValueError('Data source binding not found.')
  323. for page in notion_info['pages']:
  324. loader = NotionLoader(
  325. notion_access_token=data_source_binding.access_token,
  326. notion_workspace_id=workspace_id,
  327. notion_obj_id=page['page_id'],
  328. notion_page_type=page['type']
  329. )
  330. documents = loader.load()
  331. processing_rule = DatasetProcessRule(
  332. mode=tmp_processing_rule["mode"],
  333. rules=json.dumps(tmp_processing_rule["rules"])
  334. )
  335. # get splitter
  336. splitter = self._get_splitter(processing_rule)
  337. # split to documents
  338. documents = self._split_to_documents_for_estimate(
  339. text_docs=documents,
  340. splitter=splitter,
  341. processing_rule=processing_rule
  342. )
  343. total_segments += len(documents)
  344. embedding_model_type_instance = embedding_model_instance.model_type_instance
  345. embedding_model_type_instance = cast(TextEmbeddingModel, embedding_model_type_instance)
  346. for document in documents:
  347. if len(preview_texts) < 5:
  348. preview_texts.append(document.page_content)
  349. if indexing_technique == 'high_quality' or embedding_model_instance:
  350. tokens += embedding_model_type_instance.get_num_tokens(
  351. model=embedding_model_instance.model,
  352. credentials=embedding_model_instance.credentials,
  353. texts=[document.page_content]
  354. )
  355. if doc_form and doc_form == 'qa_model':
  356. model_instance = self.model_manager.get_default_model_instance(
  357. tenant_id=tenant_id,
  358. model_type=ModelType.LLM
  359. )
  360. model_type_instance = model_instance.model_type_instance
  361. model_type_instance = cast(LargeLanguageModel, model_type_instance)
  362. if len(preview_texts) > 0:
  363. # qa model document
  364. response = LLMGenerator.generate_qa_document(current_user.current_tenant_id, preview_texts[0],
  365. doc_language)
  366. document_qa_list = self.format_split_text(response)
  367. price_info = model_type_instance.get_price(
  368. model=model_instance.model,
  369. credentials=model_instance.credentials,
  370. price_type=PriceType.INPUT,
  371. tokens=total_segments * 2000,
  372. )
  373. return {
  374. "total_segments": total_segments * 20,
  375. "tokens": total_segments * 2000,
  376. "total_price": '{:f}'.format(price_info.total_amount),
  377. "currency": price_info.currency,
  378. "qa_preview": document_qa_list,
  379. "preview": preview_texts
  380. }
  381. embedding_model_type_instance = embedding_model_instance.model_type_instance
  382. embedding_model_type_instance = cast(TextEmbeddingModel, embedding_model_type_instance)
  383. embedding_price_info = embedding_model_type_instance.get_price(
  384. model=embedding_model_instance.model,
  385. credentials=embedding_model_instance.credentials,
  386. price_type=PriceType.INPUT,
  387. tokens=tokens
  388. )
  389. return {
  390. "total_segments": total_segments,
  391. "tokens": tokens,
  392. "total_price": '{:f}'.format(embedding_price_info.total_amount) if embedding_model_instance else 0,
  393. "currency": embedding_price_info.currency if embedding_model_instance else 'USD',
  394. "preview": preview_texts
  395. }
  396. def _load_data(self, dataset_document: DatasetDocument, automatic: bool = False) -> List[Document]:
  397. # load file
  398. if dataset_document.data_source_type not in ["upload_file", "notion_import"]:
  399. return []
  400. data_source_info = dataset_document.data_source_info_dict
  401. text_docs = []
  402. if dataset_document.data_source_type == 'upload_file':
  403. if not data_source_info or 'upload_file_id' not in data_source_info:
  404. raise ValueError("no upload file found")
  405. file_detail = db.session.query(UploadFile). \
  406. filter(UploadFile.id == data_source_info['upload_file_id']). \
  407. one_or_none()
  408. if file_detail:
  409. text_docs = FileExtractor.load(file_detail, is_automatic=True)
  410. elif dataset_document.data_source_type == 'notion_import':
  411. loader = NotionLoader.from_document(dataset_document)
  412. text_docs = loader.load()
  413. # update document status to splitting
  414. self._update_document_index_status(
  415. document_id=dataset_document.id,
  416. after_indexing_status="splitting",
  417. extra_update_params={
  418. DatasetDocument.word_count: sum([len(text_doc.page_content) for text_doc in text_docs]),
  419. DatasetDocument.parsing_completed_at: datetime.datetime.utcnow()
  420. }
  421. )
  422. # replace doc id to document model id
  423. text_docs = cast(List[Document], text_docs)
  424. for text_doc in text_docs:
  425. # remove invalid symbol
  426. text_doc.page_content = self.filter_string(text_doc.page_content)
  427. text_doc.metadata['document_id'] = dataset_document.id
  428. text_doc.metadata['dataset_id'] = dataset_document.dataset_id
  429. return text_docs
  430. def filter_string(self, text):
  431. text = re.sub(r'<\|', '<', text)
  432. text = re.sub(r'\|>', '>', text)
  433. text = re.sub(r'[\x00-\x08\x0B\x0C\x0E-\x1F\x7F\x80-\xFF]', '', text)
  434. return text
  435. def _get_splitter(self, processing_rule: DatasetProcessRule) -> TextSplitter:
  436. """
  437. Get the NodeParser object according to the processing rule.
  438. """
  439. if processing_rule.mode == "custom":
  440. # The user-defined segmentation rule
  441. rules = json.loads(processing_rule.rules)
  442. segmentation = rules["segmentation"]
  443. if segmentation["max_tokens"] < 50 or segmentation["max_tokens"] > 1000:
  444. raise ValueError("Custom segment length should be between 50 and 1000.")
  445. separator = segmentation["separator"]
  446. if separator:
  447. separator = separator.replace('\\n', '\n')
  448. character_splitter = FixedRecursiveCharacterTextSplitter.from_gpt2_encoder(
  449. chunk_size=segmentation["max_tokens"],
  450. chunk_overlap=0,
  451. fixed_separator=separator,
  452. separators=["\n\n", "。", ".", " ", ""]
  453. )
  454. else:
  455. # Automatic segmentation
  456. character_splitter = EnhanceRecursiveCharacterTextSplitter.from_gpt2_encoder(
  457. chunk_size=DatasetProcessRule.AUTOMATIC_RULES['segmentation']['max_tokens'],
  458. chunk_overlap=0,
  459. separators=["\n\n", "。", ".", " ", ""]
  460. )
  461. return character_splitter
  462. def _step_split(self, text_docs: List[Document], splitter: TextSplitter,
  463. dataset: Dataset, dataset_document: DatasetDocument, processing_rule: DatasetProcessRule) \
  464. -> List[Document]:
  465. """
  466. Split the text documents into documents and save them to the document segment.
  467. """
  468. documents = self._split_to_documents(
  469. text_docs=text_docs,
  470. splitter=splitter,
  471. processing_rule=processing_rule,
  472. tenant_id=dataset.tenant_id,
  473. document_form=dataset_document.doc_form,
  474. document_language=dataset_document.doc_language
  475. )
  476. # save node to document segment
  477. doc_store = DatasetDocumentStore(
  478. dataset=dataset,
  479. user_id=dataset_document.created_by,
  480. document_id=dataset_document.id
  481. )
  482. # add document segments
  483. doc_store.add_documents(documents)
  484. # update document status to indexing
  485. cur_time = datetime.datetime.utcnow()
  486. self._update_document_index_status(
  487. document_id=dataset_document.id,
  488. after_indexing_status="indexing",
  489. extra_update_params={
  490. DatasetDocument.cleaning_completed_at: cur_time,
  491. DatasetDocument.splitting_completed_at: cur_time,
  492. }
  493. )
  494. # update segment status to indexing
  495. self._update_segments_by_document(
  496. dataset_document_id=dataset_document.id,
  497. update_params={
  498. DocumentSegment.status: "indexing",
  499. DocumentSegment.indexing_at: datetime.datetime.utcnow()
  500. }
  501. )
  502. return documents
  503. def _split_to_documents(self, text_docs: List[Document], splitter: TextSplitter,
  504. processing_rule: DatasetProcessRule, tenant_id: str,
  505. document_form: str, document_language: str) -> List[Document]:
  506. """
  507. Split the text documents into nodes.
  508. """
  509. all_documents = []
  510. all_qa_documents = []
  511. for text_doc in text_docs:
  512. # document clean
  513. document_text = self._document_clean(text_doc.page_content, processing_rule)
  514. text_doc.page_content = document_text
  515. # parse document to nodes
  516. documents = splitter.split_documents([text_doc])
  517. split_documents = []
  518. for document_node in documents:
  519. if document_node.page_content.strip():
  520. doc_id = str(uuid.uuid4())
  521. hash = helper.generate_text_hash(document_node.page_content)
  522. document_node.metadata['doc_id'] = doc_id
  523. document_node.metadata['doc_hash'] = hash
  524. # delete Spliter character
  525. page_content = document_node.page_content
  526. if page_content.startswith(".") or page_content.startswith("。"):
  527. page_content = page_content[1:]
  528. else:
  529. page_content = page_content
  530. document_node.page_content = page_content
  531. split_documents.append(document_node)
  532. all_documents.extend(split_documents)
  533. # processing qa document
  534. if document_form == 'qa_model':
  535. for i in range(0, len(all_documents), 10):
  536. threads = []
  537. sub_documents = all_documents[i:i + 10]
  538. for doc in sub_documents:
  539. document_format_thread = threading.Thread(target=self.format_qa_document, kwargs={
  540. 'flask_app': current_app._get_current_object(),
  541. 'tenant_id': tenant_id, 'document_node': doc, 'all_qa_documents': all_qa_documents,
  542. 'document_language': document_language})
  543. threads.append(document_format_thread)
  544. document_format_thread.start()
  545. for thread in threads:
  546. thread.join()
  547. return all_qa_documents
  548. return all_documents
  549. def format_qa_document(self, flask_app: Flask, tenant_id: str, document_node, all_qa_documents, document_language):
  550. format_documents = []
  551. if document_node.page_content is None or not document_node.page_content.strip():
  552. return
  553. with flask_app.app_context():
  554. try:
  555. # qa model document
  556. response = LLMGenerator.generate_qa_document(tenant_id, document_node.page_content, document_language)
  557. document_qa_list = self.format_split_text(response)
  558. qa_documents = []
  559. for result in document_qa_list:
  560. qa_document = Document(page_content=result['question'], metadata=document_node.metadata.copy())
  561. doc_id = str(uuid.uuid4())
  562. hash = helper.generate_text_hash(result['question'])
  563. qa_document.metadata['answer'] = result['answer']
  564. qa_document.metadata['doc_id'] = doc_id
  565. qa_document.metadata['doc_hash'] = hash
  566. qa_documents.append(qa_document)
  567. format_documents.extend(qa_documents)
  568. except Exception as e:
  569. logging.exception(e)
  570. all_qa_documents.extend(format_documents)
  571. def _split_to_documents_for_estimate(self, text_docs: List[Document], splitter: TextSplitter,
  572. processing_rule: DatasetProcessRule) -> List[Document]:
  573. """
  574. Split the text documents into nodes.
  575. """
  576. all_documents = []
  577. for text_doc in text_docs:
  578. # document clean
  579. document_text = self._document_clean(text_doc.page_content, processing_rule)
  580. text_doc.page_content = document_text
  581. # parse document to nodes
  582. documents = splitter.split_documents([text_doc])
  583. split_documents = []
  584. for document in documents:
  585. if document.page_content is None or not document.page_content.strip():
  586. continue
  587. doc_id = str(uuid.uuid4())
  588. hash = helper.generate_text_hash(document.page_content)
  589. document.metadata['doc_id'] = doc_id
  590. document.metadata['doc_hash'] = hash
  591. split_documents.append(document)
  592. all_documents.extend(split_documents)
  593. return all_documents
  594. def _document_clean(self, text: str, processing_rule: DatasetProcessRule) -> str:
  595. """
  596. Clean the document text according to the processing rules.
  597. """
  598. if processing_rule.mode == "automatic":
  599. rules = DatasetProcessRule.AUTOMATIC_RULES
  600. else:
  601. rules = json.loads(processing_rule.rules) if processing_rule.rules else {}
  602. if 'pre_processing_rules' in rules:
  603. pre_processing_rules = rules["pre_processing_rules"]
  604. for pre_processing_rule in pre_processing_rules:
  605. if pre_processing_rule["id"] == "remove_extra_spaces" and pre_processing_rule["enabled"] is True:
  606. # Remove extra spaces
  607. pattern = r'\n{3,}'
  608. text = re.sub(pattern, '\n\n', text)
  609. pattern = r'[\t\f\r\x20\u00a0\u1680\u180e\u2000-\u200a\u202f\u205f\u3000]{2,}'
  610. text = re.sub(pattern, ' ', text)
  611. elif pre_processing_rule["id"] == "remove_urls_emails" and pre_processing_rule["enabled"] is True:
  612. # Remove email
  613. pattern = r'([a-zA-Z0-9_.+-]+@[a-zA-Z0-9-]+\.[a-zA-Z0-9-.]+)'
  614. text = re.sub(pattern, '', text)
  615. # Remove URL
  616. pattern = r'https?://[^\s]+'
  617. text = re.sub(pattern, '', text)
  618. return text
  619. def format_split_text(self, text):
  620. regex = r"Q\d+:\s*(.*?)\s*A\d+:\s*([\s\S]*?)(?=Q\d+:|$)"
  621. matches = re.findall(regex, text, re.UNICODE)
  622. return [
  623. {
  624. "question": q,
  625. "answer": re.sub(r"\n\s*", "\n", a.strip())
  626. }
  627. for q, a in matches if q and a
  628. ]
  629. def _build_index(self, dataset: Dataset, dataset_document: DatasetDocument, documents: List[Document]) -> None:
  630. """
  631. Build the index for the document.
  632. """
  633. vector_index = IndexBuilder.get_index(dataset, 'high_quality')
  634. keyword_table_index = IndexBuilder.get_index(dataset, 'economy')
  635. embedding_model_instance = None
  636. if dataset.indexing_technique == 'high_quality':
  637. embedding_model_instance = self.model_manager.get_model_instance(
  638. tenant_id=dataset.tenant_id,
  639. provider=dataset.embedding_model_provider,
  640. model_type=ModelType.TEXT_EMBEDDING,
  641. model=dataset.embedding_model
  642. )
  643. # chunk nodes by chunk size
  644. indexing_start_at = time.perf_counter()
  645. tokens = 0
  646. chunk_size = 100
  647. embedding_model_type_instance = None
  648. if embedding_model_instance:
  649. embedding_model_type_instance = embedding_model_instance.model_type_instance
  650. embedding_model_type_instance = cast(TextEmbeddingModel, embedding_model_type_instance)
  651. for i in range(0, len(documents), chunk_size):
  652. # check document is paused
  653. self._check_document_paused_status(dataset_document.id)
  654. chunk_documents = documents[i:i + chunk_size]
  655. if dataset.indexing_technique == 'high_quality' or embedding_model_type_instance:
  656. tokens += sum(
  657. embedding_model_type_instance.get_num_tokens(
  658. embedding_model_instance.model,
  659. embedding_model_instance.credentials,
  660. [document.page_content]
  661. )
  662. for document in chunk_documents
  663. )
  664. # save vector index
  665. if vector_index:
  666. vector_index.add_texts(chunk_documents)
  667. # save keyword index
  668. keyword_table_index.add_texts(chunk_documents)
  669. document_ids = [document.metadata['doc_id'] for document in chunk_documents]
  670. db.session.query(DocumentSegment).filter(
  671. DocumentSegment.document_id == dataset_document.id,
  672. DocumentSegment.index_node_id.in_(document_ids),
  673. DocumentSegment.status == "indexing"
  674. ).update({
  675. DocumentSegment.status: "completed",
  676. DocumentSegment.enabled: True,
  677. DocumentSegment.completed_at: datetime.datetime.utcnow()
  678. })
  679. db.session.commit()
  680. indexing_end_at = time.perf_counter()
  681. # update document status to completed
  682. self._update_document_index_status(
  683. document_id=dataset_document.id,
  684. after_indexing_status="completed",
  685. extra_update_params={
  686. DatasetDocument.tokens: tokens,
  687. DatasetDocument.completed_at: datetime.datetime.utcnow(),
  688. DatasetDocument.indexing_latency: indexing_end_at - indexing_start_at,
  689. }
  690. )
  691. def _check_document_paused_status(self, document_id: str):
  692. indexing_cache_key = 'document_{}_is_paused'.format(document_id)
  693. result = redis_client.get(indexing_cache_key)
  694. if result:
  695. raise DocumentIsPausedException()
  696. def _update_document_index_status(self, document_id: str, after_indexing_status: str,
  697. extra_update_params: Optional[dict] = None) -> None:
  698. """
  699. Update the document indexing status.
  700. """
  701. count = DatasetDocument.query.filter_by(id=document_id, is_paused=True).count()
  702. if count > 0:
  703. raise DocumentIsPausedException()
  704. document = DatasetDocument.query.filter_by(id=document_id).first()
  705. if not document:
  706. raise DocumentIsDeletedPausedException()
  707. update_params = {
  708. DatasetDocument.indexing_status: after_indexing_status
  709. }
  710. if extra_update_params:
  711. update_params.update(extra_update_params)
  712. DatasetDocument.query.filter_by(id=document_id).update(update_params)
  713. db.session.commit()
  714. def _update_segments_by_document(self, dataset_document_id: str, update_params: dict) -> None:
  715. """
  716. Update the document segment by document id.
  717. """
  718. DocumentSegment.query.filter_by(document_id=dataset_document_id).update(update_params)
  719. db.session.commit()
  720. def batch_add_segments(self, segments: List[DocumentSegment], dataset: Dataset):
  721. """
  722. Batch add segments index processing
  723. """
  724. documents = []
  725. for segment in segments:
  726. document = Document(
  727. page_content=segment.content,
  728. metadata={
  729. "doc_id": segment.index_node_id,
  730. "doc_hash": segment.index_node_hash,
  731. "document_id": segment.document_id,
  732. "dataset_id": segment.dataset_id,
  733. }
  734. )
  735. documents.append(document)
  736. # save vector index
  737. index = IndexBuilder.get_index(dataset, 'high_quality')
  738. if index:
  739. index.add_texts(documents, duplicate_check=True)
  740. # save keyword index
  741. index = IndexBuilder.get_index(dataset, 'economy')
  742. if index:
  743. index.add_texts(documents)
  744. class DocumentIsPausedException(Exception):
  745. pass
  746. class DocumentIsDeletedPausedException(Exception):
  747. pass