datasets_document.py 36 KB

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