datasets_document.py 36 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897
  1. # -*- coding:utf-8 -*-
  2. import random
  3. from datetime import datetime
  4. from typing import List
  5. from flask import request, current_app
  6. from flask_login import current_user
  7. from core.login.login import login_required
  8. from flask_restful import Resource, fields, marshal, marshal_with, reqparse
  9. from sqlalchemy import desc, asc
  10. from werkzeug.exceptions import NotFound, Forbidden
  11. import services
  12. from controllers.console import api
  13. from controllers.console.app.error import ProviderNotInitializeError, ProviderQuotaExceededError, \
  14. ProviderModelCurrentlyNotSupportError
  15. from controllers.console.datasets.error import DocumentAlreadyFinishedError, InvalidActionError, DocumentIndexingError, \
  16. InvalidMetadataError, ArchivedDocumentImmutableError
  17. from controllers.console.setup import setup_required
  18. from controllers.console.wraps import account_initialization_required
  19. from core.indexing_runner import IndexingRunner
  20. from core.model_providers.error import ProviderTokenNotInitError, QuotaExceededError, ModelCurrentlyNotSupportError, \
  21. LLMBadRequestError
  22. from core.model_providers.model_factory import ModelFactory
  23. from extensions.ext_redis import redis_client
  24. from fields.document_fields import document_with_segments_fields, document_fields, \
  25. dataset_and_document_fields, document_status_fields
  26. from libs.helper import TimestampField
  27. from extensions.ext_database import db
  28. from models.dataset import DatasetProcessRule, Dataset
  29. from models.dataset import Document, DocumentSegment
  30. from models.model import UploadFile
  31. from services.dataset_service import DocumentService, DatasetService
  32. from tasks.add_document_to_index_task import add_document_to_index_task
  33. from tasks.remove_document_from_index_task import remove_document_from_index_task
  34. class DocumentResource(Resource):
  35. def get_document(self, dataset_id: str, document_id: str) -> Document:
  36. dataset = DatasetService.get_dataset(dataset_id)
  37. if not dataset:
  38. raise NotFound('Dataset not found.')
  39. try:
  40. DatasetService.check_dataset_permission(dataset, current_user)
  41. except services.errors.account.NoPermissionError as e:
  42. raise Forbidden(str(e))
  43. document = DocumentService.get_document(dataset_id, document_id)
  44. if not document:
  45. raise NotFound('Document not found.')
  46. if document.tenant_id != current_user.current_tenant_id:
  47. raise Forbidden('No permission.')
  48. return document
  49. def get_batch_documents(self, dataset_id: str, batch: str) -> List[Document]:
  50. dataset = DatasetService.get_dataset(dataset_id)
  51. if not dataset:
  52. raise NotFound('Dataset not found.')
  53. try:
  54. DatasetService.check_dataset_permission(dataset, current_user)
  55. except services.errors.account.NoPermissionError as e:
  56. raise Forbidden(str(e))
  57. documents = DocumentService.get_batch_documents(dataset_id, batch)
  58. if not documents:
  59. raise NotFound('Documents not found.')
  60. return documents
  61. class GetProcessRuleApi(Resource):
  62. @setup_required
  63. @login_required
  64. @account_initialization_required
  65. def get(self):
  66. req_data = request.args
  67. document_id = req_data.get('document_id')
  68. # get default rules
  69. mode = DocumentService.DEFAULT_RULES['mode']
  70. rules = DocumentService.DEFAULT_RULES['rules']
  71. if document_id:
  72. # get the latest process rule
  73. document = Document.query.get_or_404(document_id)
  74. dataset = DatasetService.get_dataset(document.dataset_id)
  75. if not dataset:
  76. raise NotFound('Dataset not found.')
  77. try:
  78. DatasetService.check_dataset_permission(dataset, current_user)
  79. except services.errors.account.NoPermissionError as e:
  80. raise Forbidden(str(e))
  81. # get the latest process rule
  82. dataset_process_rule = db.session.query(DatasetProcessRule). \
  83. filter(DatasetProcessRule.dataset_id == document.dataset_id). \
  84. order_by(DatasetProcessRule.created_at.desc()). \
  85. limit(1). \
  86. one_or_none()
  87. if dataset_process_rule:
  88. mode = dataset_process_rule.mode
  89. rules = dataset_process_rule.rules_dict
  90. return {
  91. 'mode': mode,
  92. 'rules': rules
  93. }
  94. class DatasetDocumentListApi(Resource):
  95. @setup_required
  96. @login_required
  97. @account_initialization_required
  98. def get(self, dataset_id):
  99. dataset_id = str(dataset_id)
  100. page = request.args.get('page', default=1, type=int)
  101. limit = request.args.get('limit', default=20, type=int)
  102. search = request.args.get('keyword', default=None, type=str)
  103. sort = request.args.get('sort', default='-created_at', type=str)
  104. fetch = request.args.get('fetch', default=False, type=bool)
  105. dataset = DatasetService.get_dataset(dataset_id)
  106. if not dataset:
  107. raise NotFound('Dataset not found.')
  108. try:
  109. DatasetService.check_dataset_permission(dataset, current_user)
  110. except services.errors.account.NoPermissionError as e:
  111. raise Forbidden(str(e))
  112. query = Document.query.filter_by(
  113. dataset_id=str(dataset_id), tenant_id=current_user.current_tenant_id)
  114. if search:
  115. search = f'%{search}%'
  116. query = query.filter(Document.name.like(search))
  117. if sort.startswith('-'):
  118. sort_logic = desc
  119. sort = sort[1:]
  120. else:
  121. sort_logic = asc
  122. if sort == 'hit_count':
  123. sub_query = db.select(DocumentSegment.document_id,
  124. db.func.sum(DocumentSegment.hit_count).label("total_hit_count")) \
  125. .group_by(DocumentSegment.document_id) \
  126. .subquery()
  127. query = query.outerjoin(sub_query, sub_query.c.document_id == Document.id) \
  128. .order_by(sort_logic(db.func.coalesce(sub_query.c.total_hit_count, 0)))
  129. elif sort == 'created_at':
  130. query = query.order_by(sort_logic(Document.created_at))
  131. else:
  132. query = query.order_by(desc(Document.created_at))
  133. paginated_documents = query.paginate(
  134. page=page, per_page=limit, max_per_page=100, error_out=False)
  135. documents = paginated_documents.items
  136. if fetch:
  137. for document in documents:
  138. completed_segments = DocumentSegment.query.filter(DocumentSegment.completed_at.isnot(None),
  139. DocumentSegment.document_id == str(document.id),
  140. DocumentSegment.status != 're_segment').count()
  141. total_segments = DocumentSegment.query.filter(DocumentSegment.document_id == str(document.id),
  142. DocumentSegment.status != 're_segment').count()
  143. document.completed_segments = completed_segments
  144. document.total_segments = total_segments
  145. data = marshal(documents, document_with_segments_fields)
  146. else:
  147. data = marshal(documents, document_fields)
  148. response = {
  149. 'data': data,
  150. 'has_more': len(documents) == limit,
  151. 'limit': limit,
  152. 'total': paginated_documents.total,
  153. 'page': page
  154. }
  155. return response
  156. documents_and_batch_fields = {
  157. 'documents': fields.List(fields.Nested(document_fields)),
  158. 'batch': fields.String
  159. }
  160. @setup_required
  161. @login_required
  162. @account_initialization_required
  163. @marshal_with(documents_and_batch_fields)
  164. def post(self, dataset_id):
  165. dataset_id = str(dataset_id)
  166. dataset = DatasetService.get_dataset(dataset_id)
  167. if not dataset:
  168. raise NotFound('Dataset not found.')
  169. # The role of the current user in the ta table must be admin or owner
  170. if current_user.current_tenant.current_role not in ['admin', 'owner']:
  171. raise Forbidden()
  172. try:
  173. DatasetService.check_dataset_permission(dataset, current_user)
  174. except services.errors.account.NoPermissionError as e:
  175. raise Forbidden(str(e))
  176. parser = reqparse.RequestParser()
  177. parser.add_argument('indexing_technique', type=str, choices=Dataset.INDEXING_TECHNIQUE_LIST, nullable=False,
  178. location='json')
  179. parser.add_argument('data_source', type=dict, required=False, location='json')
  180. parser.add_argument('process_rule', type=dict, required=False, location='json')
  181. parser.add_argument('duplicate', type=bool, nullable=False, location='json')
  182. parser.add_argument('original_document_id', type=str, required=False, location='json')
  183. parser.add_argument('doc_form', type=str, default='text_model', required=False, nullable=False, location='json')
  184. parser.add_argument('doc_language', type=str, default='English', required=False, nullable=False,
  185. location='json')
  186. args = parser.parse_args()
  187. if not dataset.indexing_technique and not args['indexing_technique']:
  188. raise ValueError('indexing_technique is required.')
  189. # validate args
  190. DocumentService.document_create_args_validate(args)
  191. try:
  192. documents, batch = DocumentService.save_document_with_dataset_id(dataset, args, current_user)
  193. except ProviderTokenNotInitError as ex:
  194. raise ProviderNotInitializeError(ex.description)
  195. except QuotaExceededError:
  196. raise ProviderQuotaExceededError()
  197. except ModelCurrentlyNotSupportError:
  198. raise ProviderModelCurrentlyNotSupportError()
  199. return {
  200. 'documents': documents,
  201. 'batch': batch
  202. }
  203. class DatasetInitApi(Resource):
  204. @setup_required
  205. @login_required
  206. @account_initialization_required
  207. @marshal_with(dataset_and_document_fields)
  208. def post(self):
  209. # The role of the current user in the ta table must be admin or owner
  210. if current_user.current_tenant.current_role not in ['admin', 'owner']:
  211. raise Forbidden()
  212. parser = reqparse.RequestParser()
  213. parser.add_argument('indexing_technique', type=str, choices=Dataset.INDEXING_TECHNIQUE_LIST, required=True,
  214. nullable=False, location='json')
  215. parser.add_argument('data_source', type=dict, required=True, nullable=True, location='json')
  216. parser.add_argument('process_rule', type=dict, required=True, nullable=True, location='json')
  217. parser.add_argument('doc_form', type=str, default='text_model', required=False, nullable=False, location='json')
  218. parser.add_argument('doc_language', type=str, default='English', required=False, nullable=False,
  219. location='json')
  220. args = parser.parse_args()
  221. if args['indexing_technique'] == 'high_quality':
  222. try:
  223. ModelFactory.get_embedding_model(
  224. tenant_id=current_user.current_tenant_id
  225. )
  226. except LLMBadRequestError:
  227. raise ProviderNotInitializeError(
  228. f"No Embedding Model available. Please configure a valid provider "
  229. f"in the Settings -> Model Provider.")
  230. except ProviderTokenNotInitError as ex:
  231. raise ProviderNotInitializeError(ex.description)
  232. # validate args
  233. DocumentService.document_create_args_validate(args)
  234. try:
  235. dataset, documents, batch = DocumentService.save_document_without_dataset_id(
  236. tenant_id=current_user.current_tenant_id,
  237. document_data=args,
  238. account=current_user
  239. )
  240. except ProviderTokenNotInitError as ex:
  241. raise ProviderNotInitializeError(ex.description)
  242. except QuotaExceededError:
  243. raise ProviderQuotaExceededError()
  244. except ModelCurrentlyNotSupportError:
  245. raise ProviderModelCurrentlyNotSupportError()
  246. response = {
  247. 'dataset': dataset,
  248. 'documents': documents,
  249. 'batch': batch
  250. }
  251. return response
  252. class DocumentIndexingEstimateApi(DocumentResource):
  253. @setup_required
  254. @login_required
  255. @account_initialization_required
  256. def get(self, dataset_id, document_id):
  257. dataset_id = str(dataset_id)
  258. document_id = str(document_id)
  259. document = self.get_document(dataset_id, document_id)
  260. if document.indexing_status in ['completed', 'error']:
  261. raise DocumentAlreadyFinishedError()
  262. data_process_rule = document.dataset_process_rule
  263. data_process_rule_dict = data_process_rule.to_dict()
  264. response = {
  265. "tokens": 0,
  266. "total_price": 0,
  267. "currency": "USD",
  268. "total_segments": 0,
  269. "preview": []
  270. }
  271. if document.data_source_type == 'upload_file':
  272. data_source_info = document.data_source_info_dict
  273. if data_source_info and 'upload_file_id' in data_source_info:
  274. file_id = data_source_info['upload_file_id']
  275. file = db.session.query(UploadFile).filter(
  276. UploadFile.tenant_id == document.tenant_id,
  277. UploadFile.id == file_id
  278. ).first()
  279. # raise error if file not found
  280. if not file:
  281. raise NotFound('File not found.')
  282. indexing_runner = IndexingRunner()
  283. try:
  284. response = indexing_runner.file_indexing_estimate(current_user.current_tenant_id, [file],
  285. data_process_rule_dict, None,
  286. 'English', dataset_id)
  287. except LLMBadRequestError:
  288. raise ProviderNotInitializeError(
  289. f"No Embedding Model available. Please configure a valid provider "
  290. f"in the Settings -> Model Provider.")
  291. except ProviderTokenNotInitError as ex:
  292. raise ProviderNotInitializeError(ex.description)
  293. return response
  294. class DocumentBatchIndexingEstimateApi(DocumentResource):
  295. @setup_required
  296. @login_required
  297. @account_initialization_required
  298. def get(self, dataset_id, batch):
  299. dataset_id = str(dataset_id)
  300. batch = str(batch)
  301. dataset = DatasetService.get_dataset(dataset_id)
  302. if dataset is None:
  303. raise NotFound("Dataset not found.")
  304. documents = self.get_batch_documents(dataset_id, batch)
  305. response = {
  306. "tokens": 0,
  307. "total_price": 0,
  308. "currency": "USD",
  309. "total_segments": 0,
  310. "preview": []
  311. }
  312. if not documents:
  313. return response
  314. data_process_rule = documents[0].dataset_process_rule
  315. data_process_rule_dict = data_process_rule.to_dict()
  316. info_list = []
  317. for document in documents:
  318. if document.indexing_status in ['completed', 'error']:
  319. raise DocumentAlreadyFinishedError()
  320. data_source_info = document.data_source_info_dict
  321. # format document files info
  322. if data_source_info and 'upload_file_id' in data_source_info:
  323. file_id = data_source_info['upload_file_id']
  324. info_list.append(file_id)
  325. # format document notion info
  326. elif data_source_info and 'notion_workspace_id' in data_source_info and 'notion_page_id' in data_source_info:
  327. pages = []
  328. page = {
  329. 'page_id': data_source_info['notion_page_id'],
  330. 'type': data_source_info['type']
  331. }
  332. pages.append(page)
  333. notion_info = {
  334. 'workspace_id': data_source_info['notion_workspace_id'],
  335. 'pages': pages
  336. }
  337. info_list.append(notion_info)
  338. if dataset.data_source_type == 'upload_file':
  339. file_details = db.session.query(UploadFile).filter(
  340. UploadFile.tenant_id == current_user.current_tenant_id,
  341. UploadFile.id in info_list
  342. ).all()
  343. if file_details is None:
  344. raise NotFound("File not found.")
  345. indexing_runner = IndexingRunner()
  346. try:
  347. response = indexing_runner.file_indexing_estimate(current_user.current_tenant_id, file_details,
  348. data_process_rule_dict, None,
  349. 'English', dataset_id)
  350. except LLMBadRequestError:
  351. raise ProviderNotInitializeError(
  352. f"No Embedding Model available. Please configure a valid provider "
  353. f"in the Settings -> Model Provider.")
  354. except ProviderTokenNotInitError as ex:
  355. raise ProviderNotInitializeError(ex.description)
  356. elif dataset.data_source_type == 'notion_import':
  357. indexing_runner = IndexingRunner()
  358. try:
  359. response = indexing_runner.notion_indexing_estimate(current_user.current_tenant_id,
  360. info_list,
  361. data_process_rule_dict,
  362. None, 'English', dataset_id)
  363. except LLMBadRequestError:
  364. raise ProviderNotInitializeError(
  365. f"No Embedding Model available. Please configure a valid provider "
  366. f"in the Settings -> Model Provider.")
  367. except ProviderTokenNotInitError as ex:
  368. raise ProviderNotInitializeError(ex.description)
  369. else:
  370. raise ValueError('Data source type not support')
  371. return response
  372. class DocumentBatchIndexingStatusApi(DocumentResource):
  373. @setup_required
  374. @login_required
  375. @account_initialization_required
  376. def get(self, dataset_id, batch):
  377. dataset_id = str(dataset_id)
  378. batch = str(batch)
  379. documents = self.get_batch_documents(dataset_id, batch)
  380. documents_status = []
  381. for document in documents:
  382. completed_segments = DocumentSegment.query.filter(DocumentSegment.completed_at.isnot(None),
  383. DocumentSegment.document_id == str(document.id),
  384. DocumentSegment.status != 're_segment').count()
  385. total_segments = DocumentSegment.query.filter(DocumentSegment.document_id == str(document.id),
  386. DocumentSegment.status != 're_segment').count()
  387. document.completed_segments = completed_segments
  388. document.total_segments = total_segments
  389. if document.is_paused:
  390. document.indexing_status = 'paused'
  391. documents_status.append(marshal(document, document_status_fields))
  392. data = {
  393. 'data': documents_status
  394. }
  395. return data
  396. class DocumentIndexingStatusApi(DocumentResource):
  397. @setup_required
  398. @login_required
  399. @account_initialization_required
  400. def get(self, dataset_id, document_id):
  401. dataset_id = str(dataset_id)
  402. document_id = str(document_id)
  403. document = self.get_document(dataset_id, document_id)
  404. completed_segments = DocumentSegment.query \
  405. .filter(DocumentSegment.completed_at.isnot(None),
  406. DocumentSegment.document_id == str(document_id),
  407. DocumentSegment.status != 're_segment') \
  408. .count()
  409. total_segments = DocumentSegment.query \
  410. .filter(DocumentSegment.document_id == str(document_id),
  411. DocumentSegment.status != 're_segment') \
  412. .count()
  413. document.completed_segments = completed_segments
  414. document.total_segments = total_segments
  415. if document.is_paused:
  416. document.indexing_status = 'paused'
  417. return marshal(document, document_status_fields)
  418. class DocumentDetailApi(DocumentResource):
  419. METADATA_CHOICES = {'all', 'only', 'without'}
  420. @setup_required
  421. @login_required
  422. @account_initialization_required
  423. def get(self, dataset_id, document_id):
  424. dataset_id = str(dataset_id)
  425. document_id = str(document_id)
  426. document = self.get_document(dataset_id, document_id)
  427. metadata = request.args.get('metadata', 'all')
  428. if metadata not in self.METADATA_CHOICES:
  429. raise InvalidMetadataError(f'Invalid metadata value: {metadata}')
  430. if metadata == 'only':
  431. response = {
  432. 'id': document.id,
  433. 'doc_type': document.doc_type,
  434. 'doc_metadata': document.doc_metadata
  435. }
  436. elif metadata == 'without':
  437. process_rules = DatasetService.get_process_rules(dataset_id)
  438. data_source_info = document.data_source_detail_dict
  439. response = {
  440. 'id': document.id,
  441. 'position': document.position,
  442. 'data_source_type': document.data_source_type,
  443. 'data_source_info': data_source_info,
  444. 'dataset_process_rule_id': document.dataset_process_rule_id,
  445. 'dataset_process_rule': process_rules,
  446. 'name': document.name,
  447. 'created_from': document.created_from,
  448. 'created_by': document.created_by,
  449. 'created_at': document.created_at.timestamp(),
  450. 'tokens': document.tokens,
  451. 'indexing_status': document.indexing_status,
  452. 'completed_at': int(document.completed_at.timestamp()) if document.completed_at else None,
  453. 'updated_at': int(document.updated_at.timestamp()) if document.updated_at else None,
  454. 'indexing_latency': document.indexing_latency,
  455. 'error': document.error,
  456. 'enabled': document.enabled,
  457. 'disabled_at': int(document.disabled_at.timestamp()) if document.disabled_at else None,
  458. 'disabled_by': document.disabled_by,
  459. 'archived': document.archived,
  460. 'segment_count': document.segment_count,
  461. 'average_segment_length': document.average_segment_length,
  462. 'hit_count': document.hit_count,
  463. 'display_status': document.display_status,
  464. 'doc_form': document.doc_form
  465. }
  466. else:
  467. process_rules = DatasetService.get_process_rules(dataset_id)
  468. data_source_info = document.data_source_detail_dict_()
  469. response = {
  470. 'id': document.id,
  471. 'position': document.position,
  472. 'data_source_type': document.data_source_type,
  473. 'data_source_info': data_source_info,
  474. 'dataset_process_rule_id': document.dataset_process_rule_id,
  475. 'dataset_process_rule': process_rules,
  476. 'name': document.name,
  477. 'created_from': document.created_from,
  478. 'created_by': document.created_by,
  479. 'created_at': document.created_at.timestamp(),
  480. 'tokens': document.tokens,
  481. 'indexing_status': document.indexing_status,
  482. 'completed_at': int(document.completed_at.timestamp()) if document.completed_at else None,
  483. 'updated_at': int(document.updated_at.timestamp()) if document.updated_at else None,
  484. 'indexing_latency': document.indexing_latency,
  485. 'error': document.error,
  486. 'enabled': document.enabled,
  487. 'disabled_at': int(document.disabled_at.timestamp()) if document.disabled_at else None,
  488. 'disabled_by': document.disabled_by,
  489. 'archived': document.archived,
  490. 'doc_type': document.doc_type,
  491. 'doc_metadata': document.doc_metadata,
  492. 'segment_count': document.segment_count,
  493. 'average_segment_length': document.average_segment_length,
  494. 'hit_count': document.hit_count,
  495. 'display_status': document.display_status,
  496. 'doc_form': document.doc_form
  497. }
  498. return response, 200
  499. class DocumentProcessingApi(DocumentResource):
  500. @setup_required
  501. @login_required
  502. @account_initialization_required
  503. def patch(self, dataset_id, document_id, action):
  504. dataset_id = str(dataset_id)
  505. document_id = str(document_id)
  506. document = self.get_document(dataset_id, document_id)
  507. # The role of the current user in the ta table must be admin or owner
  508. if current_user.current_tenant.current_role not in ['admin', 'owner']:
  509. raise Forbidden()
  510. if action == "pause":
  511. if document.indexing_status != "indexing":
  512. raise InvalidActionError('Document not in indexing state.')
  513. document.paused_by = current_user.id
  514. document.paused_at = datetime.utcnow()
  515. document.is_paused = True
  516. db.session.commit()
  517. elif action == "resume":
  518. if document.indexing_status not in ["paused", "error"]:
  519. raise InvalidActionError('Document not in paused or error state.')
  520. document.paused_by = None
  521. document.paused_at = None
  522. document.is_paused = False
  523. db.session.commit()
  524. else:
  525. raise InvalidActionError()
  526. return {'result': 'success'}, 200
  527. class DocumentDeleteApi(DocumentResource):
  528. @setup_required
  529. @login_required
  530. @account_initialization_required
  531. def delete(self, dataset_id, document_id):
  532. dataset_id = str(dataset_id)
  533. document_id = str(document_id)
  534. dataset = DatasetService.get_dataset(dataset_id)
  535. if dataset is None:
  536. raise NotFound("Dataset not found.")
  537. # check user's model setting
  538. DatasetService.check_dataset_model_setting(dataset)
  539. document = self.get_document(dataset_id, document_id)
  540. try:
  541. DocumentService.delete_document(document)
  542. except services.errors.document.DocumentIndexingError:
  543. raise DocumentIndexingError('Cannot delete document during indexing.')
  544. return {'result': 'success'}, 204
  545. class DocumentMetadataApi(DocumentResource):
  546. @setup_required
  547. @login_required
  548. @account_initialization_required
  549. def put(self, dataset_id, document_id):
  550. dataset_id = str(dataset_id)
  551. document_id = str(document_id)
  552. document = self.get_document(dataset_id, document_id)
  553. req_data = request.get_json()
  554. doc_type = req_data.get('doc_type')
  555. doc_metadata = req_data.get('doc_metadata')
  556. # The role of the current user in the ta table must be admin or owner
  557. if current_user.current_tenant.current_role not in ['admin', 'owner']:
  558. raise Forbidden()
  559. if doc_type is None or doc_metadata is None:
  560. raise ValueError('Both doc_type and doc_metadata must be provided.')
  561. if doc_type not in DocumentService.DOCUMENT_METADATA_SCHEMA:
  562. raise ValueError('Invalid doc_type.')
  563. if not isinstance(doc_metadata, dict):
  564. raise ValueError('doc_metadata must be a dictionary.')
  565. metadata_schema = DocumentService.DOCUMENT_METADATA_SCHEMA[doc_type]
  566. document.doc_metadata = {}
  567. if doc_type == 'others':
  568. document.doc_metadata = doc_metadata
  569. else:
  570. for key, value_type in metadata_schema.items():
  571. value = doc_metadata.get(key)
  572. if value is not None and isinstance(value, value_type):
  573. document.doc_metadata[key] = value
  574. document.doc_type = doc_type
  575. document.updated_at = datetime.utcnow()
  576. db.session.commit()
  577. return {'result': 'success', 'message': 'Document metadata updated.'}, 200
  578. class DocumentStatusApi(DocumentResource):
  579. @setup_required
  580. @login_required
  581. @account_initialization_required
  582. def patch(self, dataset_id, document_id, action):
  583. dataset_id = str(dataset_id)
  584. document_id = str(document_id)
  585. dataset = DatasetService.get_dataset(dataset_id)
  586. if dataset is None:
  587. raise NotFound("Dataset not found.")
  588. # check user's model setting
  589. DatasetService.check_dataset_model_setting(dataset)
  590. document = self.get_document(dataset_id, document_id)
  591. # The role of the current user in the ta table must be admin or owner
  592. if current_user.current_tenant.current_role not in ['admin', 'owner']:
  593. raise Forbidden()
  594. indexing_cache_key = 'document_{}_indexing'.format(document.id)
  595. cache_result = redis_client.get(indexing_cache_key)
  596. if cache_result is not None:
  597. raise InvalidActionError("Document is being indexed, please try again later")
  598. if action == "enable":
  599. if document.enabled:
  600. raise InvalidActionError('Document already enabled.')
  601. document.enabled = True
  602. document.disabled_at = None
  603. document.disabled_by = None
  604. document.updated_at = datetime.utcnow()
  605. db.session.commit()
  606. # Set cache to prevent indexing the same document multiple times
  607. redis_client.setex(indexing_cache_key, 600, 1)
  608. add_document_to_index_task.delay(document_id)
  609. return {'result': 'success'}, 200
  610. elif action == "disable":
  611. if not document.completed_at or document.indexing_status != 'completed':
  612. raise InvalidActionError('Document is not completed.')
  613. if not document.enabled:
  614. raise InvalidActionError('Document already disabled.')
  615. document.enabled = False
  616. document.disabled_at = datetime.utcnow()
  617. document.disabled_by = current_user.id
  618. document.updated_at = datetime.utcnow()
  619. db.session.commit()
  620. # Set cache to prevent indexing the same document multiple times
  621. redis_client.setex(indexing_cache_key, 600, 1)
  622. remove_document_from_index_task.delay(document_id)
  623. return {'result': 'success'}, 200
  624. elif action == "archive":
  625. if document.archived:
  626. raise InvalidActionError('Document already archived.')
  627. document.archived = True
  628. document.archived_at = datetime.utcnow()
  629. document.archived_by = current_user.id
  630. document.updated_at = datetime.utcnow()
  631. db.session.commit()
  632. if document.enabled:
  633. # Set cache to prevent indexing the same document multiple times
  634. redis_client.setex(indexing_cache_key, 600, 1)
  635. remove_document_from_index_task.delay(document_id)
  636. return {'result': 'success'}, 200
  637. elif action == "un_archive":
  638. if not document.archived:
  639. raise InvalidActionError('Document is not archived.')
  640. # check document limit
  641. if current_app.config['EDITION'] == 'CLOUD':
  642. documents_count = DocumentService.get_tenant_documents_count()
  643. total_count = documents_count + 1
  644. tenant_document_count = int(current_app.config['TENANT_DOCUMENT_COUNT'])
  645. if total_count > tenant_document_count:
  646. raise ValueError(f"All your documents have overed limit {tenant_document_count}.")
  647. document.archived = False
  648. document.archived_at = None
  649. document.archived_by = None
  650. document.updated_at = datetime.utcnow()
  651. db.session.commit()
  652. # Set cache to prevent indexing the same document multiple times
  653. redis_client.setex(indexing_cache_key, 600, 1)
  654. add_document_to_index_task.delay(document_id)
  655. return {'result': 'success'}, 200
  656. else:
  657. raise InvalidActionError()
  658. class DocumentPauseApi(DocumentResource):
  659. @setup_required
  660. @login_required
  661. @account_initialization_required
  662. def patch(self, dataset_id, document_id):
  663. """pause document."""
  664. dataset_id = str(dataset_id)
  665. document_id = str(document_id)
  666. dataset = DatasetService.get_dataset(dataset_id)
  667. if not dataset:
  668. raise NotFound('Dataset not found.')
  669. document = DocumentService.get_document(dataset.id, document_id)
  670. # 404 if document not found
  671. if document is None:
  672. raise NotFound("Document Not Exists.")
  673. # 403 if document is archived
  674. if DocumentService.check_archived(document):
  675. raise ArchivedDocumentImmutableError()
  676. try:
  677. # pause document
  678. DocumentService.pause_document(document)
  679. except services.errors.document.DocumentIndexingError:
  680. raise DocumentIndexingError('Cannot pause completed document.')
  681. return {'result': 'success'}, 204
  682. class DocumentRecoverApi(DocumentResource):
  683. @setup_required
  684. @login_required
  685. @account_initialization_required
  686. def patch(self, dataset_id, document_id):
  687. """recover document."""
  688. dataset_id = str(dataset_id)
  689. document_id = str(document_id)
  690. dataset = DatasetService.get_dataset(dataset_id)
  691. if not dataset:
  692. raise NotFound('Dataset not found.')
  693. document = DocumentService.get_document(dataset.id, document_id)
  694. # 404 if document not found
  695. if document is None:
  696. raise NotFound("Document Not Exists.")
  697. # 403 if document is archived
  698. if DocumentService.check_archived(document):
  699. raise ArchivedDocumentImmutableError()
  700. try:
  701. # pause document
  702. DocumentService.recover_document(document)
  703. except services.errors.document.DocumentIndexingError:
  704. raise DocumentIndexingError('Document is not in paused status.')
  705. return {'result': 'success'}, 204
  706. class DocumentLimitApi(DocumentResource):
  707. @setup_required
  708. @login_required
  709. @account_initialization_required
  710. def get(self):
  711. """get document limit"""
  712. documents_count = DocumentService.get_tenant_documents_count()
  713. tenant_document_count = int(current_app.config['TENANT_DOCUMENT_COUNT'])
  714. return {
  715. 'documents_count': documents_count,
  716. 'documents_limit': tenant_document_count
  717. }, 200
  718. api.add_resource(GetProcessRuleApi, '/datasets/process-rule')
  719. api.add_resource(DatasetDocumentListApi,
  720. '/datasets/<uuid:dataset_id>/documents')
  721. api.add_resource(DatasetInitApi,
  722. '/datasets/init')
  723. api.add_resource(DocumentIndexingEstimateApi,
  724. '/datasets/<uuid:dataset_id>/documents/<uuid:document_id>/indexing-estimate')
  725. api.add_resource(DocumentBatchIndexingEstimateApi,
  726. '/datasets/<uuid:dataset_id>/batch/<string:batch>/indexing-estimate')
  727. api.add_resource(DocumentBatchIndexingStatusApi,
  728. '/datasets/<uuid:dataset_id>/batch/<string:batch>/indexing-status')
  729. api.add_resource(DocumentIndexingStatusApi,
  730. '/datasets/<uuid:dataset_id>/documents/<uuid:document_id>/indexing-status')
  731. api.add_resource(DocumentDetailApi,
  732. '/datasets/<uuid:dataset_id>/documents/<uuid:document_id>')
  733. api.add_resource(DocumentProcessingApi,
  734. '/datasets/<uuid:dataset_id>/documents/<uuid:document_id>/processing/<string:action>')
  735. api.add_resource(DocumentDeleteApi,
  736. '/datasets/<uuid:dataset_id>/documents/<uuid:document_id>')
  737. api.add_resource(DocumentMetadataApi,
  738. '/datasets/<uuid:dataset_id>/documents/<uuid:document_id>/metadata')
  739. api.add_resource(DocumentStatusApi,
  740. '/datasets/<uuid:dataset_id>/documents/<uuid:document_id>/status/<string:action>')
  741. api.add_resource(DocumentPauseApi, '/datasets/<uuid:dataset_id>/documents/<uuid:document_id>/processing/pause')
  742. api.add_resource(DocumentRecoverApi, '/datasets/<uuid:dataset_id>/documents/<uuid:document_id>/processing/resume')
  743. api.add_resource(DocumentLimitApi, '/datasets/limit')