dataset_service.py 67 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466
  1. import datetime
  2. import json
  3. import logging
  4. import random
  5. import time
  6. import uuid
  7. from typing import Optional
  8. from flask import current_app
  9. from flask_login import current_user
  10. from sqlalchemy import func
  11. from core.errors.error import LLMBadRequestError, ProviderTokenNotInitError
  12. from core.model_manager import ModelManager
  13. from core.model_runtime.entities.model_entities import ModelType
  14. from core.rag.datasource.keyword.keyword_factory import Keyword
  15. from core.rag.models.document import Document as RAGDocument
  16. from core.rag.retrieval.retrival_methods import RetrievalMethod
  17. from events.dataset_event import dataset_was_deleted
  18. from events.document_event import document_was_deleted
  19. from extensions.ext_database import db
  20. from extensions.ext_redis import redis_client
  21. from libs import helper
  22. from models.account import Account
  23. from models.dataset import (
  24. AppDatasetJoin,
  25. Dataset,
  26. DatasetCollectionBinding,
  27. DatasetProcessRule,
  28. DatasetQuery,
  29. Document,
  30. DocumentSegment,
  31. )
  32. from models.model import UploadFile
  33. from models.source import DataSourceOauthBinding
  34. from services.errors.account import NoPermissionError
  35. from services.errors.dataset import DatasetInUseError, DatasetNameDuplicateError
  36. from services.errors.document import DocumentIndexingError
  37. from services.errors.file import FileNotExistsError
  38. from services.feature_service import FeatureModel, FeatureService
  39. from services.tag_service import TagService
  40. from services.vector_service import VectorService
  41. from tasks.clean_notion_document_task import clean_notion_document_task
  42. from tasks.deal_dataset_vector_index_task import deal_dataset_vector_index_task
  43. from tasks.delete_segment_from_index_task import delete_segment_from_index_task
  44. from tasks.disable_segment_from_index_task import disable_segment_from_index_task
  45. from tasks.document_indexing_task import document_indexing_task
  46. from tasks.document_indexing_update_task import document_indexing_update_task
  47. from tasks.duplicate_document_indexing_task import duplicate_document_indexing_task
  48. from tasks.recover_document_indexing_task import recover_document_indexing_task
  49. from tasks.retry_document_indexing_task import retry_document_indexing_task
  50. from tasks.sync_website_document_indexing_task import sync_website_document_indexing_task
  51. class DatasetService:
  52. @staticmethod
  53. def get_datasets(page, per_page, provider="vendor", tenant_id=None, user=None, search=None, tag_ids=None):
  54. if user:
  55. permission_filter = db.or_(Dataset.created_by == user.id,
  56. Dataset.permission == 'all_team_members')
  57. else:
  58. permission_filter = Dataset.permission == 'all_team_members'
  59. query = Dataset.query.filter(
  60. db.and_(Dataset.provider == provider, Dataset.tenant_id == tenant_id, permission_filter)) \
  61. .order_by(Dataset.created_at.desc())
  62. if search:
  63. query = query.filter(db.and_(Dataset.name.ilike(f'%{search}%')))
  64. if tag_ids:
  65. target_ids = TagService.get_target_ids_by_tag_ids('knowledge', tenant_id, tag_ids)
  66. if target_ids:
  67. query = query.filter(db.and_(Dataset.id.in_(target_ids)))
  68. else:
  69. return [], 0
  70. datasets = query.paginate(
  71. page=page,
  72. per_page=per_page,
  73. max_per_page=100,
  74. error_out=False
  75. )
  76. return datasets.items, datasets.total
  77. @staticmethod
  78. def get_process_rules(dataset_id):
  79. # get the latest process rule
  80. dataset_process_rule = db.session.query(DatasetProcessRule). \
  81. filter(DatasetProcessRule.dataset_id == dataset_id). \
  82. order_by(DatasetProcessRule.created_at.desc()). \
  83. limit(1). \
  84. one_or_none()
  85. if dataset_process_rule:
  86. mode = dataset_process_rule.mode
  87. rules = dataset_process_rule.rules_dict
  88. else:
  89. mode = DocumentService.DEFAULT_RULES['mode']
  90. rules = DocumentService.DEFAULT_RULES['rules']
  91. return {
  92. 'mode': mode,
  93. 'rules': rules
  94. }
  95. @staticmethod
  96. def get_datasets_by_ids(ids, tenant_id):
  97. datasets = Dataset.query.filter(Dataset.id.in_(ids),
  98. Dataset.tenant_id == tenant_id).paginate(
  99. page=1, per_page=len(ids), max_per_page=len(ids), error_out=False)
  100. return datasets.items, datasets.total
  101. @staticmethod
  102. def create_empty_dataset(tenant_id: str, name: str, indexing_technique: Optional[str], account: Account):
  103. # check if dataset name already exists
  104. if Dataset.query.filter_by(name=name, tenant_id=tenant_id).first():
  105. raise DatasetNameDuplicateError(
  106. f'Dataset with name {name} already exists.')
  107. embedding_model = None
  108. if indexing_technique == 'high_quality':
  109. model_manager = ModelManager()
  110. embedding_model = model_manager.get_default_model_instance(
  111. tenant_id=tenant_id,
  112. model_type=ModelType.TEXT_EMBEDDING
  113. )
  114. dataset = Dataset(name=name, indexing_technique=indexing_technique)
  115. # dataset = Dataset(name=name, provider=provider, config=config)
  116. dataset.created_by = account.id
  117. dataset.updated_by = account.id
  118. dataset.tenant_id = tenant_id
  119. dataset.embedding_model_provider = embedding_model.provider if embedding_model else None
  120. dataset.embedding_model = embedding_model.model if embedding_model else None
  121. db.session.add(dataset)
  122. db.session.commit()
  123. return dataset
  124. @staticmethod
  125. def get_dataset(dataset_id):
  126. return Dataset.query.filter_by(
  127. id=dataset_id
  128. ).first()
  129. @staticmethod
  130. def check_dataset_model_setting(dataset):
  131. if dataset.indexing_technique == 'high_quality':
  132. try:
  133. model_manager = ModelManager()
  134. model_manager.get_model_instance(
  135. tenant_id=dataset.tenant_id,
  136. provider=dataset.embedding_model_provider,
  137. model_type=ModelType.TEXT_EMBEDDING,
  138. model=dataset.embedding_model
  139. )
  140. except LLMBadRequestError:
  141. raise ValueError(
  142. "No Embedding Model available. Please configure a valid provider "
  143. "in the Settings -> Model Provider.")
  144. except ProviderTokenNotInitError as ex:
  145. raise ValueError(f"The dataset in unavailable, due to: "
  146. f"{ex.description}")
  147. @staticmethod
  148. def update_dataset(dataset_id, data, user):
  149. filtered_data = {k: v for k, v in data.items() if v is not None or k == 'description'}
  150. dataset = DatasetService.get_dataset(dataset_id)
  151. DatasetService.check_dataset_permission(dataset, user)
  152. action = None
  153. if dataset.indexing_technique != data['indexing_technique']:
  154. # if update indexing_technique
  155. if data['indexing_technique'] == 'economy':
  156. action = 'remove'
  157. filtered_data['embedding_model'] = None
  158. filtered_data['embedding_model_provider'] = None
  159. filtered_data['collection_binding_id'] = None
  160. elif data['indexing_technique'] == 'high_quality':
  161. action = 'add'
  162. # get embedding model setting
  163. try:
  164. model_manager = ModelManager()
  165. embedding_model = model_manager.get_model_instance(
  166. tenant_id=current_user.current_tenant_id,
  167. provider=data['embedding_model_provider'],
  168. model_type=ModelType.TEXT_EMBEDDING,
  169. model=data['embedding_model']
  170. )
  171. filtered_data['embedding_model'] = embedding_model.model
  172. filtered_data['embedding_model_provider'] = embedding_model.provider
  173. dataset_collection_binding = DatasetCollectionBindingService.get_dataset_collection_binding(
  174. embedding_model.provider,
  175. embedding_model.model
  176. )
  177. filtered_data['collection_binding_id'] = dataset_collection_binding.id
  178. except LLMBadRequestError:
  179. raise ValueError(
  180. "No Embedding Model available. Please configure a valid provider "
  181. "in the Settings -> Model Provider.")
  182. except ProviderTokenNotInitError as ex:
  183. raise ValueError(ex.description)
  184. else:
  185. if data['embedding_model_provider'] != dataset.embedding_model_provider or \
  186. data['embedding_model'] != dataset.embedding_model:
  187. action = 'update'
  188. try:
  189. model_manager = ModelManager()
  190. embedding_model = model_manager.get_model_instance(
  191. tenant_id=current_user.current_tenant_id,
  192. provider=data['embedding_model_provider'],
  193. model_type=ModelType.TEXT_EMBEDDING,
  194. model=data['embedding_model']
  195. )
  196. filtered_data['embedding_model'] = embedding_model.model
  197. filtered_data['embedding_model_provider'] = embedding_model.provider
  198. dataset_collection_binding = DatasetCollectionBindingService.get_dataset_collection_binding(
  199. embedding_model.provider,
  200. embedding_model.model
  201. )
  202. filtered_data['collection_binding_id'] = dataset_collection_binding.id
  203. except LLMBadRequestError:
  204. raise ValueError(
  205. "No Embedding Model available. Please configure a valid provider "
  206. "in the Settings -> Model Provider.")
  207. except ProviderTokenNotInitError as ex:
  208. raise ValueError(ex.description)
  209. filtered_data['updated_by'] = user.id
  210. filtered_data['updated_at'] = datetime.datetime.now()
  211. # update Retrieval model
  212. filtered_data['retrieval_model'] = data['retrieval_model']
  213. dataset.query.filter_by(id=dataset_id).update(filtered_data)
  214. db.session.commit()
  215. if action:
  216. deal_dataset_vector_index_task.delay(dataset_id, action)
  217. return dataset
  218. @staticmethod
  219. def delete_dataset(dataset_id, user):
  220. count = AppDatasetJoin.query.filter_by(dataset_id=dataset_id).count()
  221. if count > 0:
  222. raise DatasetInUseError()
  223. dataset = DatasetService.get_dataset(dataset_id)
  224. if dataset is None:
  225. return False
  226. DatasetService.check_dataset_permission(dataset, user)
  227. dataset_was_deleted.send(dataset)
  228. db.session.delete(dataset)
  229. db.session.commit()
  230. return True
  231. @staticmethod
  232. def check_dataset_permission(dataset, user):
  233. if dataset.tenant_id != user.current_tenant_id:
  234. logging.debug(
  235. f'User {user.id} does not have permission to access dataset {dataset.id}')
  236. raise NoPermissionError(
  237. 'You do not have permission to access this dataset.')
  238. if dataset.permission == 'only_me' and dataset.created_by != user.id:
  239. logging.debug(
  240. f'User {user.id} does not have permission to access dataset {dataset.id}')
  241. raise NoPermissionError(
  242. 'You do not have permission to access this dataset.')
  243. @staticmethod
  244. def get_dataset_queries(dataset_id: str, page: int, per_page: int):
  245. dataset_queries = DatasetQuery.query.filter_by(dataset_id=dataset_id) \
  246. .order_by(db.desc(DatasetQuery.created_at)) \
  247. .paginate(
  248. page=page, per_page=per_page, max_per_page=100, error_out=False
  249. )
  250. return dataset_queries.items, dataset_queries.total
  251. @staticmethod
  252. def get_related_apps(dataset_id: str):
  253. return AppDatasetJoin.query.filter(AppDatasetJoin.dataset_id == dataset_id) \
  254. .order_by(db.desc(AppDatasetJoin.created_at)).all()
  255. class DocumentService:
  256. DEFAULT_RULES = {
  257. 'mode': 'custom',
  258. 'rules': {
  259. 'pre_processing_rules': [
  260. {'id': 'remove_extra_spaces', 'enabled': True},
  261. {'id': 'remove_urls_emails', 'enabled': False}
  262. ],
  263. 'segmentation': {
  264. 'delimiter': '\n',
  265. 'max_tokens': 500,
  266. 'chunk_overlap': 50
  267. }
  268. }
  269. }
  270. DOCUMENT_METADATA_SCHEMA = {
  271. "book": {
  272. "title": str,
  273. "language": str,
  274. "author": str,
  275. "publisher": str,
  276. "publication_date": str,
  277. "isbn": str,
  278. "category": str,
  279. },
  280. "web_page": {
  281. "title": str,
  282. "url": str,
  283. "language": str,
  284. "publish_date": str,
  285. "author/publisher": str,
  286. "topic/keywords": str,
  287. "description": str,
  288. },
  289. "paper": {
  290. "title": str,
  291. "language": str,
  292. "author": str,
  293. "publish_date": str,
  294. "journal/conference_name": str,
  295. "volume/issue/page_numbers": str,
  296. "doi": str,
  297. "topic/keywords": str,
  298. "abstract": str,
  299. },
  300. "social_media_post": {
  301. "platform": str,
  302. "author/username": str,
  303. "publish_date": str,
  304. "post_url": str,
  305. "topic/tags": str,
  306. },
  307. "wikipedia_entry": {
  308. "title": str,
  309. "language": str,
  310. "web_page_url": str,
  311. "last_edit_date": str,
  312. "editor/contributor": str,
  313. "summary/introduction": str,
  314. },
  315. "personal_document": {
  316. "title": str,
  317. "author": str,
  318. "creation_date": str,
  319. "last_modified_date": str,
  320. "document_type": str,
  321. "tags/category": str,
  322. },
  323. "business_document": {
  324. "title": str,
  325. "author": str,
  326. "creation_date": str,
  327. "last_modified_date": str,
  328. "document_type": str,
  329. "department/team": str,
  330. },
  331. "im_chat_log": {
  332. "chat_platform": str,
  333. "chat_participants/group_name": str,
  334. "start_date": str,
  335. "end_date": str,
  336. "summary": str,
  337. },
  338. "synced_from_notion": {
  339. "title": str,
  340. "language": str,
  341. "author/creator": str,
  342. "creation_date": str,
  343. "last_modified_date": str,
  344. "notion_page_link": str,
  345. "category/tags": str,
  346. "description": str,
  347. },
  348. "synced_from_github": {
  349. "repository_name": str,
  350. "repository_description": str,
  351. "repository_owner/organization": str,
  352. "code_filename": str,
  353. "code_file_path": str,
  354. "programming_language": str,
  355. "github_link": str,
  356. "open_source_license": str,
  357. "commit_date": str,
  358. "commit_author": str,
  359. },
  360. "others": dict
  361. }
  362. @staticmethod
  363. def get_document(dataset_id: str, document_id: str) -> Optional[Document]:
  364. document = db.session.query(Document).filter(
  365. Document.id == document_id,
  366. Document.dataset_id == dataset_id
  367. ).first()
  368. return document
  369. @staticmethod
  370. def get_document_by_id(document_id: str) -> Optional[Document]:
  371. document = db.session.query(Document).filter(
  372. Document.id == document_id
  373. ).first()
  374. return document
  375. @staticmethod
  376. def get_document_by_dataset_id(dataset_id: str) -> list[Document]:
  377. documents = db.session.query(Document).filter(
  378. Document.dataset_id == dataset_id,
  379. Document.enabled == True
  380. ).all()
  381. return documents
  382. @staticmethod
  383. def get_error_documents_by_dataset_id(dataset_id: str) -> list[Document]:
  384. documents = db.session.query(Document).filter(
  385. Document.dataset_id == dataset_id,
  386. Document.indexing_status.in_(['error', 'paused'])
  387. ).all()
  388. return documents
  389. @staticmethod
  390. def get_batch_documents(dataset_id: str, batch: str) -> list[Document]:
  391. documents = db.session.query(Document).filter(
  392. Document.batch == batch,
  393. Document.dataset_id == dataset_id,
  394. Document.tenant_id == current_user.current_tenant_id
  395. ).all()
  396. return documents
  397. @staticmethod
  398. def get_document_file_detail(file_id: str):
  399. file_detail = db.session.query(UploadFile). \
  400. filter(UploadFile.id == file_id). \
  401. one_or_none()
  402. return file_detail
  403. @staticmethod
  404. def check_archived(document):
  405. if document.archived:
  406. return True
  407. else:
  408. return False
  409. @staticmethod
  410. def delete_document(document):
  411. # trigger document_was_deleted signal
  412. document_was_deleted.send(document.id, dataset_id=document.dataset_id, doc_form=document.doc_form)
  413. db.session.delete(document)
  414. db.session.commit()
  415. @staticmethod
  416. def rename_document(dataset_id: str, document_id: str, name: str) -> Document:
  417. dataset = DatasetService.get_dataset(dataset_id)
  418. if not dataset:
  419. raise ValueError('Dataset not found.')
  420. document = DocumentService.get_document(dataset_id, document_id)
  421. if not document:
  422. raise ValueError('Document not found.')
  423. if document.tenant_id != current_user.current_tenant_id:
  424. raise ValueError('No permission.')
  425. document.name = name
  426. db.session.add(document)
  427. db.session.commit()
  428. return document
  429. @staticmethod
  430. def pause_document(document):
  431. if document.indexing_status not in ["waiting", "parsing", "cleaning", "splitting", "indexing"]:
  432. raise DocumentIndexingError()
  433. # update document to be paused
  434. document.is_paused = True
  435. document.paused_by = current_user.id
  436. document.paused_at = datetime.datetime.now(datetime.timezone.utc).replace(tzinfo=None)
  437. db.session.add(document)
  438. db.session.commit()
  439. # set document paused flag
  440. indexing_cache_key = 'document_{}_is_paused'.format(document.id)
  441. redis_client.setnx(indexing_cache_key, "True")
  442. @staticmethod
  443. def recover_document(document):
  444. if not document.is_paused:
  445. raise DocumentIndexingError()
  446. # update document to be recover
  447. document.is_paused = False
  448. document.paused_by = None
  449. document.paused_at = None
  450. db.session.add(document)
  451. db.session.commit()
  452. # delete paused flag
  453. indexing_cache_key = 'document_{}_is_paused'.format(document.id)
  454. redis_client.delete(indexing_cache_key)
  455. # trigger async task
  456. recover_document_indexing_task.delay(document.dataset_id, document.id)
  457. @staticmethod
  458. def retry_document(dataset_id: str, documents: list[Document]):
  459. for document in documents:
  460. # add retry flag
  461. retry_indexing_cache_key = 'document_{}_is_retried'.format(document.id)
  462. cache_result = redis_client.get(retry_indexing_cache_key)
  463. if cache_result is not None:
  464. raise ValueError("Document is being retried, please try again later")
  465. # retry document indexing
  466. document.indexing_status = 'waiting'
  467. db.session.add(document)
  468. db.session.commit()
  469. redis_client.setex(retry_indexing_cache_key, 600, 1)
  470. # trigger async task
  471. document_ids = [document.id for document in documents]
  472. retry_document_indexing_task.delay(dataset_id, document_ids)
  473. @staticmethod
  474. def sync_website_document(dataset_id: str, document: Document):
  475. # add sync flag
  476. sync_indexing_cache_key = 'document_{}_is_sync'.format(document.id)
  477. cache_result = redis_client.get(sync_indexing_cache_key)
  478. if cache_result is not None:
  479. raise ValueError("Document is being synced, please try again later")
  480. # sync document indexing
  481. document.indexing_status = 'waiting'
  482. data_source_info = document.data_source_info_dict
  483. data_source_info['mode'] = 'scrape'
  484. document.data_source_info = json.dumps(data_source_info, ensure_ascii=False)
  485. db.session.add(document)
  486. db.session.commit()
  487. redis_client.setex(sync_indexing_cache_key, 600, 1)
  488. sync_website_document_indexing_task.delay(dataset_id, document.id)
  489. @staticmethod
  490. def get_documents_position(dataset_id):
  491. document = Document.query.filter_by(dataset_id=dataset_id).order_by(Document.position.desc()).first()
  492. if document:
  493. return document.position + 1
  494. else:
  495. return 1
  496. @staticmethod
  497. def save_document_with_dataset_id(dataset: Dataset, document_data: dict,
  498. account: Account, dataset_process_rule: Optional[DatasetProcessRule] = None,
  499. created_from: str = 'web'):
  500. # check document limit
  501. features = FeatureService.get_features(current_user.current_tenant_id)
  502. if features.billing.enabled:
  503. if 'original_document_id' not in document_data or not document_data['original_document_id']:
  504. count = 0
  505. if document_data["data_source"]["type"] == "upload_file":
  506. upload_file_list = document_data["data_source"]["info_list"]['file_info_list']['file_ids']
  507. count = len(upload_file_list)
  508. elif document_data["data_source"]["type"] == "notion_import":
  509. notion_info_list = document_data["data_source"]['info_list']['notion_info_list']
  510. for notion_info in notion_info_list:
  511. count = count + len(notion_info['pages'])
  512. elif document_data["data_source"]["type"] == "website_crawl":
  513. website_info = document_data["data_source"]['info_list']['website_info_list']
  514. count = len(website_info['urls'])
  515. batch_upload_limit = int(current_app.config['BATCH_UPLOAD_LIMIT'])
  516. if count > batch_upload_limit:
  517. raise ValueError(f"You have reached the batch upload limit of {batch_upload_limit}.")
  518. DocumentService.check_documents_upload_quota(count, features)
  519. # if dataset is empty, update dataset data_source_type
  520. if not dataset.data_source_type:
  521. dataset.data_source_type = document_data["data_source"]["type"]
  522. if not dataset.indexing_technique:
  523. if 'indexing_technique' not in document_data \
  524. or document_data['indexing_technique'] not in Dataset.INDEXING_TECHNIQUE_LIST:
  525. raise ValueError("Indexing technique is required")
  526. dataset.indexing_technique = document_data["indexing_technique"]
  527. if document_data["indexing_technique"] == 'high_quality':
  528. model_manager = ModelManager()
  529. embedding_model = model_manager.get_default_model_instance(
  530. tenant_id=current_user.current_tenant_id,
  531. model_type=ModelType.TEXT_EMBEDDING
  532. )
  533. dataset.embedding_model = embedding_model.model
  534. dataset.embedding_model_provider = embedding_model.provider
  535. dataset_collection_binding = DatasetCollectionBindingService.get_dataset_collection_binding(
  536. embedding_model.provider,
  537. embedding_model.model
  538. )
  539. dataset.collection_binding_id = dataset_collection_binding.id
  540. if not dataset.retrieval_model:
  541. default_retrieval_model = {
  542. 'search_method': RetrievalMethod.SEMANTIC_SEARCH,
  543. 'reranking_enable': False,
  544. 'reranking_model': {
  545. 'reranking_provider_name': '',
  546. 'reranking_model_name': ''
  547. },
  548. 'top_k': 2,
  549. 'score_threshold_enabled': False
  550. }
  551. dataset.retrieval_model = document_data.get('retrieval_model') if document_data.get(
  552. 'retrieval_model') else default_retrieval_model
  553. documents = []
  554. batch = time.strftime('%Y%m%d%H%M%S') + str(random.randint(100000, 999999))
  555. if document_data.get("original_document_id"):
  556. document = DocumentService.update_document_with_dataset_id(dataset, document_data, account)
  557. documents.append(document)
  558. else:
  559. # save process rule
  560. if not dataset_process_rule:
  561. process_rule = document_data["process_rule"]
  562. if process_rule["mode"] == "custom":
  563. dataset_process_rule = DatasetProcessRule(
  564. dataset_id=dataset.id,
  565. mode=process_rule["mode"],
  566. rules=json.dumps(process_rule["rules"]),
  567. created_by=account.id
  568. )
  569. elif process_rule["mode"] == "automatic":
  570. dataset_process_rule = DatasetProcessRule(
  571. dataset_id=dataset.id,
  572. mode=process_rule["mode"],
  573. rules=json.dumps(DatasetProcessRule.AUTOMATIC_RULES),
  574. created_by=account.id
  575. )
  576. db.session.add(dataset_process_rule)
  577. db.session.commit()
  578. position = DocumentService.get_documents_position(dataset.id)
  579. document_ids = []
  580. duplicate_document_ids = []
  581. if document_data["data_source"]["type"] == "upload_file":
  582. upload_file_list = document_data["data_source"]["info_list"]['file_info_list']['file_ids']
  583. for file_id in upload_file_list:
  584. file = db.session.query(UploadFile).filter(
  585. UploadFile.tenant_id == dataset.tenant_id,
  586. UploadFile.id == file_id
  587. ).first()
  588. # raise error if file not found
  589. if not file:
  590. raise FileNotExistsError()
  591. file_name = file.name
  592. data_source_info = {
  593. "upload_file_id": file_id,
  594. }
  595. # check duplicate
  596. if document_data.get('duplicate', False):
  597. document = Document.query.filter_by(
  598. dataset_id=dataset.id,
  599. tenant_id=current_user.current_tenant_id,
  600. data_source_type='upload_file',
  601. enabled=True,
  602. name=file_name
  603. ).first()
  604. if document:
  605. document.dataset_process_rule_id = dataset_process_rule.id
  606. document.updated_at = datetime.datetime.utcnow()
  607. document.created_from = created_from
  608. document.doc_form = document_data['doc_form']
  609. document.doc_language = document_data['doc_language']
  610. document.data_source_info = json.dumps(data_source_info)
  611. document.batch = batch
  612. document.indexing_status = 'waiting'
  613. db.session.add(document)
  614. documents.append(document)
  615. duplicate_document_ids.append(document.id)
  616. continue
  617. document = DocumentService.build_document(dataset, dataset_process_rule.id,
  618. document_data["data_source"]["type"],
  619. document_data["doc_form"],
  620. document_data["doc_language"],
  621. data_source_info, created_from, position,
  622. account, file_name, batch)
  623. db.session.add(document)
  624. db.session.flush()
  625. document_ids.append(document.id)
  626. documents.append(document)
  627. position += 1
  628. elif document_data["data_source"]["type"] == "notion_import":
  629. notion_info_list = document_data["data_source"]['info_list']['notion_info_list']
  630. exist_page_ids = []
  631. exist_document = {}
  632. documents = Document.query.filter_by(
  633. dataset_id=dataset.id,
  634. tenant_id=current_user.current_tenant_id,
  635. data_source_type='notion_import',
  636. enabled=True
  637. ).all()
  638. if documents:
  639. for document in documents:
  640. data_source_info = json.loads(document.data_source_info)
  641. exist_page_ids.append(data_source_info['notion_page_id'])
  642. exist_document[data_source_info['notion_page_id']] = document.id
  643. for notion_info in notion_info_list:
  644. workspace_id = notion_info['workspace_id']
  645. data_source_binding = DataSourceOauthBinding.query.filter(
  646. db.and_(
  647. DataSourceOauthBinding.tenant_id == current_user.current_tenant_id,
  648. DataSourceOauthBinding.provider == 'notion',
  649. DataSourceOauthBinding.disabled == False,
  650. DataSourceOauthBinding.source_info['workspace_id'] == f'"{workspace_id}"'
  651. )
  652. ).first()
  653. if not data_source_binding:
  654. raise ValueError('Data source binding not found.')
  655. for page in notion_info['pages']:
  656. if page['page_id'] not in exist_page_ids:
  657. data_source_info = {
  658. "notion_workspace_id": workspace_id,
  659. "notion_page_id": page['page_id'],
  660. "notion_page_icon": page['page_icon'],
  661. "type": page['type']
  662. }
  663. document = DocumentService.build_document(dataset, dataset_process_rule.id,
  664. document_data["data_source"]["type"],
  665. document_data["doc_form"],
  666. document_data["doc_language"],
  667. data_source_info, created_from, position,
  668. account, page['page_name'], batch)
  669. db.session.add(document)
  670. db.session.flush()
  671. document_ids.append(document.id)
  672. documents.append(document)
  673. position += 1
  674. else:
  675. exist_document.pop(page['page_id'])
  676. # delete not selected documents
  677. if len(exist_document) > 0:
  678. clean_notion_document_task.delay(list(exist_document.values()), dataset.id)
  679. elif document_data["data_source"]["type"] == "website_crawl":
  680. website_info = document_data["data_source"]['info_list']['website_info_list']
  681. urls = website_info['urls']
  682. for url in urls:
  683. data_source_info = {
  684. 'url': url,
  685. 'provider': website_info['provider'],
  686. 'job_id': website_info['job_id'],
  687. 'only_main_content': website_info.get('only_main_content', False),
  688. 'mode': 'crawl',
  689. }
  690. document = DocumentService.build_document(dataset, dataset_process_rule.id,
  691. document_data["data_source"]["type"],
  692. document_data["doc_form"],
  693. document_data["doc_language"],
  694. data_source_info, created_from, position,
  695. account, url, batch)
  696. db.session.add(document)
  697. db.session.flush()
  698. document_ids.append(document.id)
  699. documents.append(document)
  700. position += 1
  701. db.session.commit()
  702. # trigger async task
  703. if document_ids:
  704. document_indexing_task.delay(dataset.id, document_ids)
  705. if duplicate_document_ids:
  706. duplicate_document_indexing_task.delay(dataset.id, duplicate_document_ids)
  707. return documents, batch
  708. @staticmethod
  709. def check_documents_upload_quota(count: int, features: FeatureModel):
  710. can_upload_size = features.documents_upload_quota.limit - features.documents_upload_quota.size
  711. if count > can_upload_size:
  712. raise ValueError(
  713. f'You have reached the limit of your subscription. Only {can_upload_size} documents can be uploaded.')
  714. @staticmethod
  715. def build_document(dataset: Dataset, process_rule_id: str, data_source_type: str, document_form: str,
  716. document_language: str, data_source_info: dict, created_from: str, position: int,
  717. account: Account,
  718. name: str, batch: str):
  719. document = Document(
  720. tenant_id=dataset.tenant_id,
  721. dataset_id=dataset.id,
  722. position=position,
  723. data_source_type=data_source_type,
  724. data_source_info=json.dumps(data_source_info),
  725. dataset_process_rule_id=process_rule_id,
  726. batch=batch,
  727. name=name,
  728. created_from=created_from,
  729. created_by=account.id,
  730. doc_form=document_form,
  731. doc_language=document_language
  732. )
  733. return document
  734. @staticmethod
  735. def get_tenant_documents_count():
  736. documents_count = Document.query.filter(Document.completed_at.isnot(None),
  737. Document.enabled == True,
  738. Document.archived == False,
  739. Document.tenant_id == current_user.current_tenant_id).count()
  740. return documents_count
  741. @staticmethod
  742. def update_document_with_dataset_id(dataset: Dataset, document_data: dict,
  743. account: Account, dataset_process_rule: Optional[DatasetProcessRule] = None,
  744. created_from: str = 'web'):
  745. DatasetService.check_dataset_model_setting(dataset)
  746. document = DocumentService.get_document(dataset.id, document_data["original_document_id"])
  747. if document.display_status != 'available':
  748. raise ValueError("Document is not available")
  749. # update document name
  750. if document_data.get('name'):
  751. document.name = document_data['name']
  752. # save process rule
  753. if document_data.get('process_rule'):
  754. process_rule = document_data["process_rule"]
  755. if process_rule["mode"] == "custom":
  756. dataset_process_rule = DatasetProcessRule(
  757. dataset_id=dataset.id,
  758. mode=process_rule["mode"],
  759. rules=json.dumps(process_rule["rules"]),
  760. created_by=account.id
  761. )
  762. elif process_rule["mode"] == "automatic":
  763. dataset_process_rule = DatasetProcessRule(
  764. dataset_id=dataset.id,
  765. mode=process_rule["mode"],
  766. rules=json.dumps(DatasetProcessRule.AUTOMATIC_RULES),
  767. created_by=account.id
  768. )
  769. db.session.add(dataset_process_rule)
  770. db.session.commit()
  771. document.dataset_process_rule_id = dataset_process_rule.id
  772. # update document data source
  773. if document_data.get('data_source'):
  774. file_name = ''
  775. data_source_info = {}
  776. if document_data["data_source"]["type"] == "upload_file":
  777. upload_file_list = document_data["data_source"]["info_list"]['file_info_list']['file_ids']
  778. for file_id in upload_file_list:
  779. file = db.session.query(UploadFile).filter(
  780. UploadFile.tenant_id == dataset.tenant_id,
  781. UploadFile.id == file_id
  782. ).first()
  783. # raise error if file not found
  784. if not file:
  785. raise FileNotExistsError()
  786. file_name = file.name
  787. data_source_info = {
  788. "upload_file_id": file_id,
  789. }
  790. elif document_data["data_source"]["type"] == "notion_import":
  791. notion_info_list = document_data["data_source"]['info_list']['notion_info_list']
  792. for notion_info in notion_info_list:
  793. workspace_id = notion_info['workspace_id']
  794. data_source_binding = DataSourceOauthBinding.query.filter(
  795. db.and_(
  796. DataSourceOauthBinding.tenant_id == current_user.current_tenant_id,
  797. DataSourceOauthBinding.provider == 'notion',
  798. DataSourceOauthBinding.disabled == False,
  799. DataSourceOauthBinding.source_info['workspace_id'] == f'"{workspace_id}"'
  800. )
  801. ).first()
  802. if not data_source_binding:
  803. raise ValueError('Data source binding not found.')
  804. for page in notion_info['pages']:
  805. data_source_info = {
  806. "notion_workspace_id": workspace_id,
  807. "notion_page_id": page['page_id'],
  808. "notion_page_icon": page['page_icon'],
  809. "type": page['type']
  810. }
  811. elif document_data["data_source"]["type"] == "website_crawl":
  812. website_info = document_data["data_source"]['info_list']['website_info_list']
  813. urls = website_info['urls']
  814. for url in urls:
  815. data_source_info = {
  816. 'url': url,
  817. 'provider': website_info['provider'],
  818. 'job_id': website_info['job_id'],
  819. 'only_main_content': website_info.get('only_main_content', False),
  820. 'mode': 'crawl',
  821. }
  822. document.data_source_type = document_data["data_source"]["type"]
  823. document.data_source_info = json.dumps(data_source_info)
  824. document.name = file_name
  825. # update document to be waiting
  826. document.indexing_status = 'waiting'
  827. document.completed_at = None
  828. document.processing_started_at = None
  829. document.parsing_completed_at = None
  830. document.cleaning_completed_at = None
  831. document.splitting_completed_at = None
  832. document.updated_at = datetime.datetime.now(datetime.timezone.utc).replace(tzinfo=None)
  833. document.created_from = created_from
  834. document.doc_form = document_data['doc_form']
  835. db.session.add(document)
  836. db.session.commit()
  837. # update document segment
  838. update_params = {
  839. DocumentSegment.status: 're_segment'
  840. }
  841. DocumentSegment.query.filter_by(document_id=document.id).update(update_params)
  842. db.session.commit()
  843. # trigger async task
  844. document_indexing_update_task.delay(document.dataset_id, document.id)
  845. return document
  846. @staticmethod
  847. def save_document_without_dataset_id(tenant_id: str, document_data: dict, account: Account):
  848. features = FeatureService.get_features(current_user.current_tenant_id)
  849. if features.billing.enabled:
  850. count = 0
  851. if document_data["data_source"]["type"] == "upload_file":
  852. upload_file_list = document_data["data_source"]["info_list"]['file_info_list']['file_ids']
  853. count = len(upload_file_list)
  854. elif document_data["data_source"]["type"] == "notion_import":
  855. notion_info_list = document_data["data_source"]['info_list']['notion_info_list']
  856. for notion_info in notion_info_list:
  857. count = count + len(notion_info['pages'])
  858. elif document_data["data_source"]["type"] == "website_crawl":
  859. website_info = document_data["data_source"]['info_list']['website_info_list']
  860. count = len(website_info['urls'])
  861. batch_upload_limit = int(current_app.config['BATCH_UPLOAD_LIMIT'])
  862. if count > batch_upload_limit:
  863. raise ValueError(f"You have reached the batch upload limit of {batch_upload_limit}.")
  864. DocumentService.check_documents_upload_quota(count, features)
  865. embedding_model = None
  866. dataset_collection_binding_id = None
  867. retrieval_model = None
  868. if document_data['indexing_technique'] == 'high_quality':
  869. model_manager = ModelManager()
  870. embedding_model = model_manager.get_default_model_instance(
  871. tenant_id=current_user.current_tenant_id,
  872. model_type=ModelType.TEXT_EMBEDDING
  873. )
  874. dataset_collection_binding = DatasetCollectionBindingService.get_dataset_collection_binding(
  875. embedding_model.provider,
  876. embedding_model.model
  877. )
  878. dataset_collection_binding_id = dataset_collection_binding.id
  879. if document_data.get('retrieval_model'):
  880. retrieval_model = document_data['retrieval_model']
  881. else:
  882. default_retrieval_model = {
  883. 'search_method': RetrievalMethod.SEMANTIC_SEARCH,
  884. 'reranking_enable': False,
  885. 'reranking_model': {
  886. 'reranking_provider_name': '',
  887. 'reranking_model_name': ''
  888. },
  889. 'top_k': 2,
  890. 'score_threshold_enabled': False
  891. }
  892. retrieval_model = default_retrieval_model
  893. # save dataset
  894. dataset = Dataset(
  895. tenant_id=tenant_id,
  896. name='',
  897. data_source_type=document_data["data_source"]["type"],
  898. indexing_technique=document_data["indexing_technique"],
  899. created_by=account.id,
  900. embedding_model=embedding_model.model if embedding_model else None,
  901. embedding_model_provider=embedding_model.provider if embedding_model else None,
  902. collection_binding_id=dataset_collection_binding_id,
  903. retrieval_model=retrieval_model
  904. )
  905. db.session.add(dataset)
  906. db.session.flush()
  907. documents, batch = DocumentService.save_document_with_dataset_id(dataset, document_data, account)
  908. cut_length = 18
  909. cut_name = documents[0].name[:cut_length]
  910. dataset.name = cut_name + '...'
  911. dataset.description = 'useful for when you want to answer queries about the ' + documents[0].name
  912. db.session.commit()
  913. return dataset, documents, batch
  914. @classmethod
  915. def document_create_args_validate(cls, args: dict):
  916. if 'original_document_id' not in args or not args['original_document_id']:
  917. DocumentService.data_source_args_validate(args)
  918. DocumentService.process_rule_args_validate(args)
  919. else:
  920. if ('data_source' not in args and not args['data_source']) \
  921. and ('process_rule' not in args and not args['process_rule']):
  922. raise ValueError("Data source or Process rule is required")
  923. else:
  924. if args.get('data_source'):
  925. DocumentService.data_source_args_validate(args)
  926. if args.get('process_rule'):
  927. DocumentService.process_rule_args_validate(args)
  928. @classmethod
  929. def data_source_args_validate(cls, args: dict):
  930. if 'data_source' not in args or not args['data_source']:
  931. raise ValueError("Data source is required")
  932. if not isinstance(args['data_source'], dict):
  933. raise ValueError("Data source is invalid")
  934. if 'type' not in args['data_source'] or not args['data_source']['type']:
  935. raise ValueError("Data source type is required")
  936. if args['data_source']['type'] not in Document.DATA_SOURCES:
  937. raise ValueError("Data source type is invalid")
  938. if 'info_list' not in args['data_source'] or not args['data_source']['info_list']:
  939. raise ValueError("Data source info is required")
  940. if args['data_source']['type'] == 'upload_file':
  941. if 'file_info_list' not in args['data_source']['info_list'] or not args['data_source']['info_list'][
  942. 'file_info_list']:
  943. raise ValueError("File source info is required")
  944. if args['data_source']['type'] == 'notion_import':
  945. if 'notion_info_list' not in args['data_source']['info_list'] or not args['data_source']['info_list'][
  946. 'notion_info_list']:
  947. raise ValueError("Notion source info is required")
  948. if args['data_source']['type'] == 'website_crawl':
  949. if 'website_info_list' not in args['data_source']['info_list'] or not args['data_source']['info_list'][
  950. 'website_info_list']:
  951. raise ValueError("Website source info is required")
  952. @classmethod
  953. def process_rule_args_validate(cls, args: dict):
  954. if 'process_rule' not in args or not args['process_rule']:
  955. raise ValueError("Process rule is required")
  956. if not isinstance(args['process_rule'], dict):
  957. raise ValueError("Process rule is invalid")
  958. if 'mode' not in args['process_rule'] or not args['process_rule']['mode']:
  959. raise ValueError("Process rule mode is required")
  960. if args['process_rule']['mode'] not in DatasetProcessRule.MODES:
  961. raise ValueError("Process rule mode is invalid")
  962. if args['process_rule']['mode'] == 'automatic':
  963. args['process_rule']['rules'] = {}
  964. else:
  965. if 'rules' not in args['process_rule'] or not args['process_rule']['rules']:
  966. raise ValueError("Process rule rules is required")
  967. if not isinstance(args['process_rule']['rules'], dict):
  968. raise ValueError("Process rule rules is invalid")
  969. if 'pre_processing_rules' not in args['process_rule']['rules'] \
  970. or args['process_rule']['rules']['pre_processing_rules'] is None:
  971. raise ValueError("Process rule pre_processing_rules is required")
  972. if not isinstance(args['process_rule']['rules']['pre_processing_rules'], list):
  973. raise ValueError("Process rule pre_processing_rules is invalid")
  974. unique_pre_processing_rule_dicts = {}
  975. for pre_processing_rule in args['process_rule']['rules']['pre_processing_rules']:
  976. if 'id' not in pre_processing_rule or not pre_processing_rule['id']:
  977. raise ValueError("Process rule pre_processing_rules id is required")
  978. if pre_processing_rule['id'] not in DatasetProcessRule.PRE_PROCESSING_RULES:
  979. raise ValueError("Process rule pre_processing_rules id is invalid")
  980. if 'enabled' not in pre_processing_rule or pre_processing_rule['enabled'] is None:
  981. raise ValueError("Process rule pre_processing_rules enabled is required")
  982. if not isinstance(pre_processing_rule['enabled'], bool):
  983. raise ValueError("Process rule pre_processing_rules enabled is invalid")
  984. unique_pre_processing_rule_dicts[pre_processing_rule['id']] = pre_processing_rule
  985. args['process_rule']['rules']['pre_processing_rules'] = list(unique_pre_processing_rule_dicts.values())
  986. if 'segmentation' not in args['process_rule']['rules'] \
  987. or args['process_rule']['rules']['segmentation'] is None:
  988. raise ValueError("Process rule segmentation is required")
  989. if not isinstance(args['process_rule']['rules']['segmentation'], dict):
  990. raise ValueError("Process rule segmentation is invalid")
  991. if 'separator' not in args['process_rule']['rules']['segmentation'] \
  992. or not args['process_rule']['rules']['segmentation']['separator']:
  993. raise ValueError("Process rule segmentation separator is required")
  994. if not isinstance(args['process_rule']['rules']['segmentation']['separator'], str):
  995. raise ValueError("Process rule segmentation separator is invalid")
  996. if 'max_tokens' not in args['process_rule']['rules']['segmentation'] \
  997. or not args['process_rule']['rules']['segmentation']['max_tokens']:
  998. raise ValueError("Process rule segmentation max_tokens is required")
  999. if not isinstance(args['process_rule']['rules']['segmentation']['max_tokens'], int):
  1000. raise ValueError("Process rule segmentation max_tokens is invalid")
  1001. @classmethod
  1002. def estimate_args_validate(cls, args: dict):
  1003. if 'info_list' not in args or not args['info_list']:
  1004. raise ValueError("Data source info is required")
  1005. if not isinstance(args['info_list'], dict):
  1006. raise ValueError("Data info is invalid")
  1007. if 'process_rule' not in args or not args['process_rule']:
  1008. raise ValueError("Process rule is required")
  1009. if not isinstance(args['process_rule'], dict):
  1010. raise ValueError("Process rule is invalid")
  1011. if 'mode' not in args['process_rule'] or not args['process_rule']['mode']:
  1012. raise ValueError("Process rule mode is required")
  1013. if args['process_rule']['mode'] not in DatasetProcessRule.MODES:
  1014. raise ValueError("Process rule mode is invalid")
  1015. if args['process_rule']['mode'] == 'automatic':
  1016. args['process_rule']['rules'] = {}
  1017. else:
  1018. if 'rules' not in args['process_rule'] or not args['process_rule']['rules']:
  1019. raise ValueError("Process rule rules is required")
  1020. if not isinstance(args['process_rule']['rules'], dict):
  1021. raise ValueError("Process rule rules is invalid")
  1022. if 'pre_processing_rules' not in args['process_rule']['rules'] \
  1023. or args['process_rule']['rules']['pre_processing_rules'] is None:
  1024. raise ValueError("Process rule pre_processing_rules is required")
  1025. if not isinstance(args['process_rule']['rules']['pre_processing_rules'], list):
  1026. raise ValueError("Process rule pre_processing_rules is invalid")
  1027. unique_pre_processing_rule_dicts = {}
  1028. for pre_processing_rule in args['process_rule']['rules']['pre_processing_rules']:
  1029. if 'id' not in pre_processing_rule or not pre_processing_rule['id']:
  1030. raise ValueError("Process rule pre_processing_rules id is required")
  1031. if pre_processing_rule['id'] not in DatasetProcessRule.PRE_PROCESSING_RULES:
  1032. raise ValueError("Process rule pre_processing_rules id is invalid")
  1033. if 'enabled' not in pre_processing_rule or pre_processing_rule['enabled'] is None:
  1034. raise ValueError("Process rule pre_processing_rules enabled is required")
  1035. if not isinstance(pre_processing_rule['enabled'], bool):
  1036. raise ValueError("Process rule pre_processing_rules enabled is invalid")
  1037. unique_pre_processing_rule_dicts[pre_processing_rule['id']] = pre_processing_rule
  1038. args['process_rule']['rules']['pre_processing_rules'] = list(unique_pre_processing_rule_dicts.values())
  1039. if 'segmentation' not in args['process_rule']['rules'] \
  1040. or args['process_rule']['rules']['segmentation'] is None:
  1041. raise ValueError("Process rule segmentation is required")
  1042. if not isinstance(args['process_rule']['rules']['segmentation'], dict):
  1043. raise ValueError("Process rule segmentation is invalid")
  1044. if 'separator' not in args['process_rule']['rules']['segmentation'] \
  1045. or not args['process_rule']['rules']['segmentation']['separator']:
  1046. raise ValueError("Process rule segmentation separator is required")
  1047. if not isinstance(args['process_rule']['rules']['segmentation']['separator'], str):
  1048. raise ValueError("Process rule segmentation separator is invalid")
  1049. if 'max_tokens' not in args['process_rule']['rules']['segmentation'] \
  1050. or not args['process_rule']['rules']['segmentation']['max_tokens']:
  1051. raise ValueError("Process rule segmentation max_tokens is required")
  1052. if not isinstance(args['process_rule']['rules']['segmentation']['max_tokens'], int):
  1053. raise ValueError("Process rule segmentation max_tokens is invalid")
  1054. class SegmentService:
  1055. @classmethod
  1056. def segment_create_args_validate(cls, args: dict, document: Document):
  1057. if document.doc_form == 'qa_model':
  1058. if 'answer' not in args or not args['answer']:
  1059. raise ValueError("Answer is required")
  1060. if not args['answer'].strip():
  1061. raise ValueError("Answer is empty")
  1062. if 'content' not in args or not args['content'] or not args['content'].strip():
  1063. raise ValueError("Content is empty")
  1064. @classmethod
  1065. def create_segment(cls, args: dict, document: Document, dataset: Dataset):
  1066. content = args['content']
  1067. doc_id = str(uuid.uuid4())
  1068. segment_hash = helper.generate_text_hash(content)
  1069. tokens = 0
  1070. if dataset.indexing_technique == 'high_quality':
  1071. model_manager = ModelManager()
  1072. embedding_model = model_manager.get_model_instance(
  1073. tenant_id=current_user.current_tenant_id,
  1074. provider=dataset.embedding_model_provider,
  1075. model_type=ModelType.TEXT_EMBEDDING,
  1076. model=dataset.embedding_model
  1077. )
  1078. # calc embedding use tokens
  1079. tokens = embedding_model.get_text_embedding_num_tokens(
  1080. texts=[content]
  1081. )
  1082. lock_name = 'add_segment_lock_document_id_{}'.format(document.id)
  1083. with redis_client.lock(lock_name, timeout=600):
  1084. max_position = db.session.query(func.max(DocumentSegment.position)).filter(
  1085. DocumentSegment.document_id == document.id
  1086. ).scalar()
  1087. segment_document = DocumentSegment(
  1088. tenant_id=current_user.current_tenant_id,
  1089. dataset_id=document.dataset_id,
  1090. document_id=document.id,
  1091. index_node_id=doc_id,
  1092. index_node_hash=segment_hash,
  1093. position=max_position + 1 if max_position else 1,
  1094. content=content,
  1095. word_count=len(content),
  1096. tokens=tokens,
  1097. status='completed',
  1098. indexing_at=datetime.datetime.now(datetime.timezone.utc).replace(tzinfo=None),
  1099. completed_at=datetime.datetime.now(datetime.timezone.utc).replace(tzinfo=None),
  1100. created_by=current_user.id
  1101. )
  1102. if document.doc_form == 'qa_model':
  1103. segment_document.answer = args['answer']
  1104. db.session.add(segment_document)
  1105. db.session.commit()
  1106. # save vector index
  1107. try:
  1108. VectorService.create_segments_vector([args['keywords']], [segment_document], dataset)
  1109. except Exception as e:
  1110. logging.exception("create segment index failed")
  1111. segment_document.enabled = False
  1112. segment_document.disabled_at = datetime.datetime.now(datetime.timezone.utc).replace(tzinfo=None)
  1113. segment_document.status = 'error'
  1114. segment_document.error = str(e)
  1115. db.session.commit()
  1116. segment = db.session.query(DocumentSegment).filter(DocumentSegment.id == segment_document.id).first()
  1117. return segment
  1118. @classmethod
  1119. def multi_create_segment(cls, segments: list, document: Document, dataset: Dataset):
  1120. lock_name = 'multi_add_segment_lock_document_id_{}'.format(document.id)
  1121. with redis_client.lock(lock_name, timeout=600):
  1122. embedding_model = None
  1123. if dataset.indexing_technique == 'high_quality':
  1124. model_manager = ModelManager()
  1125. embedding_model = model_manager.get_model_instance(
  1126. tenant_id=current_user.current_tenant_id,
  1127. provider=dataset.embedding_model_provider,
  1128. model_type=ModelType.TEXT_EMBEDDING,
  1129. model=dataset.embedding_model
  1130. )
  1131. max_position = db.session.query(func.max(DocumentSegment.position)).filter(
  1132. DocumentSegment.document_id == document.id
  1133. ).scalar()
  1134. pre_segment_data_list = []
  1135. segment_data_list = []
  1136. keywords_list = []
  1137. for segment_item in segments:
  1138. content = segment_item['content']
  1139. doc_id = str(uuid.uuid4())
  1140. segment_hash = helper.generate_text_hash(content)
  1141. tokens = 0
  1142. if dataset.indexing_technique == 'high_quality' and embedding_model:
  1143. # calc embedding use tokens
  1144. tokens = embedding_model.get_text_embedding_num_tokens(
  1145. texts=[content]
  1146. )
  1147. segment_document = DocumentSegment(
  1148. tenant_id=current_user.current_tenant_id,
  1149. dataset_id=document.dataset_id,
  1150. document_id=document.id,
  1151. index_node_id=doc_id,
  1152. index_node_hash=segment_hash,
  1153. position=max_position + 1 if max_position else 1,
  1154. content=content,
  1155. word_count=len(content),
  1156. tokens=tokens,
  1157. status='completed',
  1158. indexing_at=datetime.datetime.now(datetime.timezone.utc).replace(tzinfo=None),
  1159. completed_at=datetime.datetime.now(datetime.timezone.utc).replace(tzinfo=None),
  1160. created_by=current_user.id
  1161. )
  1162. if document.doc_form == 'qa_model':
  1163. segment_document.answer = segment_item['answer']
  1164. db.session.add(segment_document)
  1165. segment_data_list.append(segment_document)
  1166. pre_segment_data_list.append(segment_document)
  1167. keywords_list.append(segment_item['keywords'])
  1168. try:
  1169. # save vector index
  1170. VectorService.create_segments_vector(keywords_list, pre_segment_data_list, dataset)
  1171. except Exception as e:
  1172. logging.exception("create segment index failed")
  1173. for segment_document in segment_data_list:
  1174. segment_document.enabled = False
  1175. segment_document.disabled_at = datetime.datetime.now(datetime.timezone.utc).replace(tzinfo=None)
  1176. segment_document.status = 'error'
  1177. segment_document.error = str(e)
  1178. db.session.commit()
  1179. return segment_data_list
  1180. @classmethod
  1181. def update_segment(cls, args: dict, segment: DocumentSegment, document: Document, dataset: Dataset):
  1182. indexing_cache_key = 'segment_{}_indexing'.format(segment.id)
  1183. cache_result = redis_client.get(indexing_cache_key)
  1184. if cache_result is not None:
  1185. raise ValueError("Segment is indexing, please try again later")
  1186. if 'enabled' in args and args['enabled'] is not None:
  1187. action = args['enabled']
  1188. if segment.enabled != action:
  1189. if not action:
  1190. segment.enabled = action
  1191. segment.disabled_at = datetime.datetime.now(datetime.timezone.utc).replace(tzinfo=None)
  1192. segment.disabled_by = current_user.id
  1193. db.session.add(segment)
  1194. db.session.commit()
  1195. # Set cache to prevent indexing the same segment multiple times
  1196. redis_client.setex(indexing_cache_key, 600, 1)
  1197. disable_segment_from_index_task.delay(segment.id)
  1198. return segment
  1199. if not segment.enabled:
  1200. if 'enabled' in args and args['enabled'] is not None:
  1201. if not args['enabled']:
  1202. raise ValueError("Can't update disabled segment")
  1203. else:
  1204. raise ValueError("Can't update disabled segment")
  1205. try:
  1206. content = args['content']
  1207. if segment.content == content:
  1208. if document.doc_form == 'qa_model':
  1209. segment.answer = args['answer']
  1210. if args.get('keywords'):
  1211. segment.keywords = args['keywords']
  1212. segment.enabled = True
  1213. segment.disabled_at = None
  1214. segment.disabled_by = None
  1215. db.session.add(segment)
  1216. db.session.commit()
  1217. # update segment index task
  1218. if args['keywords']:
  1219. keyword = Keyword(dataset)
  1220. keyword.delete_by_ids([segment.index_node_id])
  1221. document = RAGDocument(
  1222. page_content=segment.content,
  1223. metadata={
  1224. "doc_id": segment.index_node_id,
  1225. "doc_hash": segment.index_node_hash,
  1226. "document_id": segment.document_id,
  1227. "dataset_id": segment.dataset_id,
  1228. }
  1229. )
  1230. keyword.add_texts([document], keywords_list=[args['keywords']])
  1231. else:
  1232. segment_hash = helper.generate_text_hash(content)
  1233. tokens = 0
  1234. if dataset.indexing_technique == 'high_quality':
  1235. model_manager = ModelManager()
  1236. embedding_model = model_manager.get_model_instance(
  1237. tenant_id=current_user.current_tenant_id,
  1238. provider=dataset.embedding_model_provider,
  1239. model_type=ModelType.TEXT_EMBEDDING,
  1240. model=dataset.embedding_model
  1241. )
  1242. # calc embedding use tokens
  1243. tokens = embedding_model.get_text_embedding_num_tokens(
  1244. texts=[content]
  1245. )
  1246. segment.content = content
  1247. segment.index_node_hash = segment_hash
  1248. segment.word_count = len(content)
  1249. segment.tokens = tokens
  1250. segment.status = 'completed'
  1251. segment.indexing_at = datetime.datetime.now(datetime.timezone.utc).replace(tzinfo=None)
  1252. segment.completed_at = datetime.datetime.now(datetime.timezone.utc).replace(tzinfo=None)
  1253. segment.updated_by = current_user.id
  1254. segment.updated_at = datetime.datetime.now(datetime.timezone.utc).replace(tzinfo=None)
  1255. segment.enabled = True
  1256. segment.disabled_at = None
  1257. segment.disabled_by = None
  1258. if document.doc_form == 'qa_model':
  1259. segment.answer = args['answer']
  1260. db.session.add(segment)
  1261. db.session.commit()
  1262. # update segment vector index
  1263. VectorService.update_segment_vector(args['keywords'], segment, dataset)
  1264. except Exception as e:
  1265. logging.exception("update segment index failed")
  1266. segment.enabled = False
  1267. segment.disabled_at = datetime.datetime.now(datetime.timezone.utc).replace(tzinfo=None)
  1268. segment.status = 'error'
  1269. segment.error = str(e)
  1270. db.session.commit()
  1271. segment = db.session.query(DocumentSegment).filter(DocumentSegment.id == segment.id).first()
  1272. return segment
  1273. @classmethod
  1274. def delete_segment(cls, segment: DocumentSegment, document: Document, dataset: Dataset):
  1275. indexing_cache_key = 'segment_{}_delete_indexing'.format(segment.id)
  1276. cache_result = redis_client.get(indexing_cache_key)
  1277. if cache_result is not None:
  1278. raise ValueError("Segment is deleting.")
  1279. # enabled segment need to delete index
  1280. if segment.enabled:
  1281. # send delete segment index task
  1282. redis_client.setex(indexing_cache_key, 600, 1)
  1283. delete_segment_from_index_task.delay(segment.id, segment.index_node_id, dataset.id, document.id)
  1284. db.session.delete(segment)
  1285. db.session.commit()
  1286. class DatasetCollectionBindingService:
  1287. @classmethod
  1288. def get_dataset_collection_binding(cls, provider_name: str, model_name: str,
  1289. collection_type: str = 'dataset') -> DatasetCollectionBinding:
  1290. dataset_collection_binding = db.session.query(DatasetCollectionBinding). \
  1291. filter(DatasetCollectionBinding.provider_name == provider_name,
  1292. DatasetCollectionBinding.model_name == model_name,
  1293. DatasetCollectionBinding.type == collection_type). \
  1294. order_by(DatasetCollectionBinding.created_at). \
  1295. first()
  1296. if not dataset_collection_binding:
  1297. dataset_collection_binding = DatasetCollectionBinding(
  1298. provider_name=provider_name,
  1299. model_name=model_name,
  1300. collection_name=Dataset.gen_collection_name_by_id(str(uuid.uuid4())),
  1301. type=collection_type
  1302. )
  1303. db.session.add(dataset_collection_binding)
  1304. db.session.commit()
  1305. return dataset_collection_binding
  1306. @classmethod
  1307. def get_dataset_collection_binding_by_id_and_type(cls, collection_binding_id: str,
  1308. collection_type: str = 'dataset') -> DatasetCollectionBinding:
  1309. dataset_collection_binding = db.session.query(DatasetCollectionBinding). \
  1310. filter(DatasetCollectionBinding.id == collection_binding_id,
  1311. DatasetCollectionBinding.type == collection_type). \
  1312. order_by(DatasetCollectionBinding.created_at). \
  1313. first()
  1314. return dataset_collection_binding