indexing_runner.py 37 KB

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