datasets_document.py 36 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900
  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. parser.add_argument('retrieval_model', type=dict, 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. parser.add_argument('retrieval_model', type=dict, required=False, nullable=False,
  221. location='json')
  222. args = parser.parse_args()
  223. if args['indexing_technique'] == 'high_quality':
  224. try:
  225. ModelFactory.get_embedding_model(
  226. tenant_id=current_user.current_tenant_id
  227. )
  228. except LLMBadRequestError:
  229. raise ProviderNotInitializeError(
  230. f"No Embedding Model available. Please configure a valid provider "
  231. f"in the Settings -> Model Provider.")
  232. except ProviderTokenNotInitError as ex:
  233. raise ProviderNotInitializeError(ex.description)
  234. # validate args
  235. DocumentService.document_create_args_validate(args)
  236. try:
  237. dataset, documents, batch = DocumentService.save_document_without_dataset_id(
  238. tenant_id=current_user.current_tenant_id,
  239. document_data=args,
  240. account=current_user
  241. )
  242. except ProviderTokenNotInitError as ex:
  243. raise ProviderNotInitializeError(ex.description)
  244. except QuotaExceededError:
  245. raise ProviderQuotaExceededError()
  246. except ModelCurrentlyNotSupportError:
  247. raise ProviderModelCurrentlyNotSupportError()
  248. response = {
  249. 'dataset': dataset,
  250. 'documents': documents,
  251. 'batch': batch
  252. }
  253. return response
  254. class DocumentIndexingEstimateApi(DocumentResource):
  255. @setup_required
  256. @login_required
  257. @account_initialization_required
  258. def get(self, dataset_id, document_id):
  259. dataset_id = str(dataset_id)
  260. document_id = str(document_id)
  261. document = self.get_document(dataset_id, document_id)
  262. if document.indexing_status in ['completed', 'error']:
  263. raise DocumentAlreadyFinishedError()
  264. data_process_rule = document.dataset_process_rule
  265. data_process_rule_dict = data_process_rule.to_dict()
  266. response = {
  267. "tokens": 0,
  268. "total_price": 0,
  269. "currency": "USD",
  270. "total_segments": 0,
  271. "preview": []
  272. }
  273. if document.data_source_type == 'upload_file':
  274. data_source_info = document.data_source_info_dict
  275. if data_source_info and 'upload_file_id' in data_source_info:
  276. file_id = data_source_info['upload_file_id']
  277. file = db.session.query(UploadFile).filter(
  278. UploadFile.tenant_id == document.tenant_id,
  279. UploadFile.id == file_id
  280. ).first()
  281. # raise error if file not found
  282. if not file:
  283. raise NotFound('File not found.')
  284. indexing_runner = IndexingRunner()
  285. try:
  286. response = indexing_runner.file_indexing_estimate(current_user.current_tenant_id, [file],
  287. data_process_rule_dict, None,
  288. 'English', dataset_id)
  289. except LLMBadRequestError:
  290. raise ProviderNotInitializeError(
  291. f"No Embedding Model available. Please configure a valid provider "
  292. f"in the Settings -> Model Provider.")
  293. except ProviderTokenNotInitError as ex:
  294. raise ProviderNotInitializeError(ex.description)
  295. return response
  296. class DocumentBatchIndexingEstimateApi(DocumentResource):
  297. @setup_required
  298. @login_required
  299. @account_initialization_required
  300. def get(self, dataset_id, batch):
  301. dataset_id = str(dataset_id)
  302. batch = str(batch)
  303. dataset = DatasetService.get_dataset(dataset_id)
  304. if dataset is None:
  305. raise NotFound("Dataset not found.")
  306. documents = self.get_batch_documents(dataset_id, batch)
  307. response = {
  308. "tokens": 0,
  309. "total_price": 0,
  310. "currency": "USD",
  311. "total_segments": 0,
  312. "preview": []
  313. }
  314. if not documents:
  315. return response
  316. data_process_rule = documents[0].dataset_process_rule
  317. data_process_rule_dict = data_process_rule.to_dict()
  318. info_list = []
  319. for document in documents:
  320. if document.indexing_status in ['completed', 'error']:
  321. raise DocumentAlreadyFinishedError()
  322. data_source_info = document.data_source_info_dict
  323. # format document files info
  324. if data_source_info and 'upload_file_id' in data_source_info:
  325. file_id = data_source_info['upload_file_id']
  326. info_list.append(file_id)
  327. # format document notion info
  328. elif data_source_info and 'notion_workspace_id' in data_source_info and 'notion_page_id' in data_source_info:
  329. pages = []
  330. page = {
  331. 'page_id': data_source_info['notion_page_id'],
  332. 'type': data_source_info['type']
  333. }
  334. pages.append(page)
  335. notion_info = {
  336. 'workspace_id': data_source_info['notion_workspace_id'],
  337. 'pages': pages
  338. }
  339. info_list.append(notion_info)
  340. if dataset.data_source_type == 'upload_file':
  341. file_details = db.session.query(UploadFile).filter(
  342. UploadFile.tenant_id == current_user.current_tenant_id,
  343. UploadFile.id in info_list
  344. ).all()
  345. if file_details is None:
  346. raise NotFound("File not found.")
  347. indexing_runner = IndexingRunner()
  348. try:
  349. response = indexing_runner.file_indexing_estimate(current_user.current_tenant_id, file_details,
  350. data_process_rule_dict, None,
  351. 'English', dataset_id)
  352. except LLMBadRequestError:
  353. raise ProviderNotInitializeError(
  354. f"No Embedding Model available. Please configure a valid provider "
  355. f"in the Settings -> Model Provider.")
  356. except ProviderTokenNotInitError as ex:
  357. raise ProviderNotInitializeError(ex.description)
  358. elif dataset.data_source_type == 'notion_import':
  359. indexing_runner = IndexingRunner()
  360. try:
  361. response = indexing_runner.notion_indexing_estimate(current_user.current_tenant_id,
  362. info_list,
  363. data_process_rule_dict,
  364. None, 'English', dataset_id)
  365. except LLMBadRequestError:
  366. raise ProviderNotInitializeError(
  367. f"No Embedding Model available. Please configure a valid provider "
  368. f"in the Settings -> Model Provider.")
  369. except ProviderTokenNotInitError as ex:
  370. raise ProviderNotInitializeError(ex.description)
  371. else:
  372. raise ValueError('Data source type not support')
  373. return response
  374. class DocumentBatchIndexingStatusApi(DocumentResource):
  375. @setup_required
  376. @login_required
  377. @account_initialization_required
  378. def get(self, dataset_id, batch):
  379. dataset_id = str(dataset_id)
  380. batch = str(batch)
  381. documents = self.get_batch_documents(dataset_id, batch)
  382. documents_status = []
  383. for document in documents:
  384. completed_segments = DocumentSegment.query.filter(DocumentSegment.completed_at.isnot(None),
  385. DocumentSegment.document_id == str(document.id),
  386. DocumentSegment.status != 're_segment').count()
  387. total_segments = DocumentSegment.query.filter(DocumentSegment.document_id == str(document.id),
  388. DocumentSegment.status != 're_segment').count()
  389. document.completed_segments = completed_segments
  390. document.total_segments = total_segments
  391. if document.is_paused:
  392. document.indexing_status = 'paused'
  393. documents_status.append(marshal(document, document_status_fields))
  394. data = {
  395. 'data': documents_status
  396. }
  397. return data
  398. class DocumentIndexingStatusApi(DocumentResource):
  399. @setup_required
  400. @login_required
  401. @account_initialization_required
  402. def get(self, dataset_id, document_id):
  403. dataset_id = str(dataset_id)
  404. document_id = str(document_id)
  405. document = self.get_document(dataset_id, document_id)
  406. completed_segments = DocumentSegment.query \
  407. .filter(DocumentSegment.completed_at.isnot(None),
  408. DocumentSegment.document_id == str(document_id),
  409. DocumentSegment.status != 're_segment') \
  410. .count()
  411. total_segments = DocumentSegment.query \
  412. .filter(DocumentSegment.document_id == str(document_id),
  413. DocumentSegment.status != 're_segment') \
  414. .count()
  415. document.completed_segments = completed_segments
  416. document.total_segments = total_segments
  417. if document.is_paused:
  418. document.indexing_status = 'paused'
  419. return marshal(document, document_status_fields)
  420. class DocumentDetailApi(DocumentResource):
  421. METADATA_CHOICES = {'all', 'only', 'without'}
  422. @setup_required
  423. @login_required
  424. @account_initialization_required
  425. def get(self, dataset_id, document_id):
  426. dataset_id = str(dataset_id)
  427. document_id = str(document_id)
  428. document = self.get_document(dataset_id, document_id)
  429. metadata = request.args.get('metadata', 'all')
  430. if metadata not in self.METADATA_CHOICES:
  431. raise InvalidMetadataError(f'Invalid metadata value: {metadata}')
  432. if metadata == 'only':
  433. response = {
  434. 'id': document.id,
  435. 'doc_type': document.doc_type,
  436. 'doc_metadata': document.doc_metadata
  437. }
  438. elif metadata == 'without':
  439. process_rules = DatasetService.get_process_rules(dataset_id)
  440. data_source_info = document.data_source_detail_dict
  441. response = {
  442. 'id': document.id,
  443. 'position': document.position,
  444. 'data_source_type': document.data_source_type,
  445. 'data_source_info': data_source_info,
  446. 'dataset_process_rule_id': document.dataset_process_rule_id,
  447. 'dataset_process_rule': process_rules,
  448. 'name': document.name,
  449. 'created_from': document.created_from,
  450. 'created_by': document.created_by,
  451. 'created_at': document.created_at.timestamp(),
  452. 'tokens': document.tokens,
  453. 'indexing_status': document.indexing_status,
  454. 'completed_at': int(document.completed_at.timestamp()) if document.completed_at else None,
  455. 'updated_at': int(document.updated_at.timestamp()) if document.updated_at else None,
  456. 'indexing_latency': document.indexing_latency,
  457. 'error': document.error,
  458. 'enabled': document.enabled,
  459. 'disabled_at': int(document.disabled_at.timestamp()) if document.disabled_at else None,
  460. 'disabled_by': document.disabled_by,
  461. 'archived': document.archived,
  462. 'segment_count': document.segment_count,
  463. 'average_segment_length': document.average_segment_length,
  464. 'hit_count': document.hit_count,
  465. 'display_status': document.display_status,
  466. 'doc_form': document.doc_form
  467. }
  468. else:
  469. process_rules = DatasetService.get_process_rules(dataset_id)
  470. data_source_info = document.data_source_detail_dict_()
  471. response = {
  472. 'id': document.id,
  473. 'position': document.position,
  474. 'data_source_type': document.data_source_type,
  475. 'data_source_info': data_source_info,
  476. 'dataset_process_rule_id': document.dataset_process_rule_id,
  477. 'dataset_process_rule': process_rules,
  478. 'name': document.name,
  479. 'created_from': document.created_from,
  480. 'created_by': document.created_by,
  481. 'created_at': document.created_at.timestamp(),
  482. 'tokens': document.tokens,
  483. 'indexing_status': document.indexing_status,
  484. 'completed_at': int(document.completed_at.timestamp()) if document.completed_at else None,
  485. 'updated_at': int(document.updated_at.timestamp()) if document.updated_at else None,
  486. 'indexing_latency': document.indexing_latency,
  487. 'error': document.error,
  488. 'enabled': document.enabled,
  489. 'disabled_at': int(document.disabled_at.timestamp()) if document.disabled_at else None,
  490. 'disabled_by': document.disabled_by,
  491. 'archived': document.archived,
  492. 'doc_type': document.doc_type,
  493. 'doc_metadata': document.doc_metadata,
  494. 'segment_count': document.segment_count,
  495. 'average_segment_length': document.average_segment_length,
  496. 'hit_count': document.hit_count,
  497. 'display_status': document.display_status,
  498. 'doc_form': document.doc_form
  499. }
  500. return response, 200
  501. class DocumentProcessingApi(DocumentResource):
  502. @setup_required
  503. @login_required
  504. @account_initialization_required
  505. def patch(self, dataset_id, document_id, action):
  506. dataset_id = str(dataset_id)
  507. document_id = str(document_id)
  508. document = self.get_document(dataset_id, document_id)
  509. # The role of the current user in the ta table must be admin or owner
  510. if current_user.current_tenant.current_role not in ['admin', 'owner']:
  511. raise Forbidden()
  512. if action == "pause":
  513. if document.indexing_status != "indexing":
  514. raise InvalidActionError('Document not in indexing state.')
  515. document.paused_by = current_user.id
  516. document.paused_at = datetime.utcnow()
  517. document.is_paused = True
  518. db.session.commit()
  519. elif action == "resume":
  520. if document.indexing_status not in ["paused", "error"]:
  521. raise InvalidActionError('Document not in paused or error state.')
  522. document.paused_by = None
  523. document.paused_at = None
  524. document.is_paused = False
  525. db.session.commit()
  526. else:
  527. raise InvalidActionError()
  528. return {'result': 'success'}, 200
  529. class DocumentDeleteApi(DocumentResource):
  530. @setup_required
  531. @login_required
  532. @account_initialization_required
  533. def delete(self, dataset_id, document_id):
  534. dataset_id = str(dataset_id)
  535. document_id = str(document_id)
  536. dataset = DatasetService.get_dataset(dataset_id)
  537. if dataset is None:
  538. raise NotFound("Dataset not found.")
  539. # check user's model setting
  540. DatasetService.check_dataset_model_setting(dataset)
  541. document = self.get_document(dataset_id, document_id)
  542. try:
  543. DocumentService.delete_document(document)
  544. except services.errors.document.DocumentIndexingError:
  545. raise DocumentIndexingError('Cannot delete document during indexing.')
  546. return {'result': 'success'}, 204
  547. class DocumentMetadataApi(DocumentResource):
  548. @setup_required
  549. @login_required
  550. @account_initialization_required
  551. def put(self, dataset_id, document_id):
  552. dataset_id = str(dataset_id)
  553. document_id = str(document_id)
  554. document = self.get_document(dataset_id, document_id)
  555. req_data = request.get_json()
  556. doc_type = req_data.get('doc_type')
  557. doc_metadata = req_data.get('doc_metadata')
  558. # The role of the current user in the ta table must be admin or owner
  559. if current_user.current_tenant.current_role not in ['admin', 'owner']:
  560. raise Forbidden()
  561. if doc_type is None or doc_metadata is None:
  562. raise ValueError('Both doc_type and doc_metadata must be provided.')
  563. if doc_type not in DocumentService.DOCUMENT_METADATA_SCHEMA:
  564. raise ValueError('Invalid doc_type.')
  565. if not isinstance(doc_metadata, dict):
  566. raise ValueError('doc_metadata must be a dictionary.')
  567. metadata_schema = DocumentService.DOCUMENT_METADATA_SCHEMA[doc_type]
  568. document.doc_metadata = {}
  569. if doc_type == 'others':
  570. document.doc_metadata = doc_metadata
  571. else:
  572. for key, value_type in metadata_schema.items():
  573. value = doc_metadata.get(key)
  574. if value is not None and isinstance(value, value_type):
  575. document.doc_metadata[key] = value
  576. document.doc_type = doc_type
  577. document.updated_at = datetime.utcnow()
  578. db.session.commit()
  579. return {'result': 'success', 'message': 'Document metadata updated.'}, 200
  580. class DocumentStatusApi(DocumentResource):
  581. @setup_required
  582. @login_required
  583. @account_initialization_required
  584. def patch(self, dataset_id, document_id, action):
  585. dataset_id = str(dataset_id)
  586. document_id = str(document_id)
  587. dataset = DatasetService.get_dataset(dataset_id)
  588. if dataset is None:
  589. raise NotFound("Dataset not found.")
  590. # check user's model setting
  591. DatasetService.check_dataset_model_setting(dataset)
  592. document = self.get_document(dataset_id, document_id)
  593. # The role of the current user in the ta table must be admin or owner
  594. if current_user.current_tenant.current_role not in ['admin', 'owner']:
  595. raise Forbidden()
  596. indexing_cache_key = 'document_{}_indexing'.format(document.id)
  597. cache_result = redis_client.get(indexing_cache_key)
  598. if cache_result is not None:
  599. raise InvalidActionError("Document is being indexed, please try again later")
  600. if action == "enable":
  601. if document.enabled:
  602. raise InvalidActionError('Document already enabled.')
  603. document.enabled = True
  604. document.disabled_at = None
  605. document.disabled_by = None
  606. document.updated_at = datetime.utcnow()
  607. db.session.commit()
  608. # Set cache to prevent indexing the same document multiple times
  609. redis_client.setex(indexing_cache_key, 600, 1)
  610. add_document_to_index_task.delay(document_id)
  611. return {'result': 'success'}, 200
  612. elif action == "disable":
  613. if not document.completed_at or document.indexing_status != 'completed':
  614. raise InvalidActionError('Document is not completed.')
  615. if not document.enabled:
  616. raise InvalidActionError('Document already disabled.')
  617. document.enabled = False
  618. document.disabled_at = datetime.utcnow()
  619. document.disabled_by = current_user.id
  620. document.updated_at = datetime.utcnow()
  621. db.session.commit()
  622. # Set cache to prevent indexing the same document multiple times
  623. redis_client.setex(indexing_cache_key, 600, 1)
  624. remove_document_from_index_task.delay(document_id)
  625. return {'result': 'success'}, 200
  626. elif action == "archive":
  627. if document.archived:
  628. raise InvalidActionError('Document already archived.')
  629. document.archived = True
  630. document.archived_at = datetime.utcnow()
  631. document.archived_by = current_user.id
  632. document.updated_at = datetime.utcnow()
  633. db.session.commit()
  634. if document.enabled:
  635. # Set cache to prevent indexing the same document multiple times
  636. redis_client.setex(indexing_cache_key, 600, 1)
  637. remove_document_from_index_task.delay(document_id)
  638. return {'result': 'success'}, 200
  639. elif action == "un_archive":
  640. if not document.archived:
  641. raise InvalidActionError('Document is not archived.')
  642. # check document limit
  643. if current_app.config['EDITION'] == 'CLOUD':
  644. documents_count = DocumentService.get_tenant_documents_count()
  645. total_count = documents_count + 1
  646. tenant_document_count = int(current_app.config['TENANT_DOCUMENT_COUNT'])
  647. if total_count > tenant_document_count:
  648. raise ValueError(f"All your documents have overed limit {tenant_document_count}.")
  649. document.archived = False
  650. document.archived_at = None
  651. document.archived_by = None
  652. document.updated_at = datetime.utcnow()
  653. db.session.commit()
  654. # Set cache to prevent indexing the same document multiple times
  655. redis_client.setex(indexing_cache_key, 600, 1)
  656. add_document_to_index_task.delay(document_id)
  657. return {'result': 'success'}, 200
  658. else:
  659. raise InvalidActionError()
  660. class DocumentPauseApi(DocumentResource):
  661. @setup_required
  662. @login_required
  663. @account_initialization_required
  664. def patch(self, dataset_id, document_id):
  665. """pause document."""
  666. dataset_id = str(dataset_id)
  667. document_id = str(document_id)
  668. dataset = DatasetService.get_dataset(dataset_id)
  669. if not dataset:
  670. raise NotFound('Dataset not found.')
  671. document = DocumentService.get_document(dataset.id, document_id)
  672. # 404 if document not found
  673. if document is None:
  674. raise NotFound("Document Not Exists.")
  675. # 403 if document is archived
  676. if DocumentService.check_archived(document):
  677. raise ArchivedDocumentImmutableError()
  678. try:
  679. # pause document
  680. DocumentService.pause_document(document)
  681. except services.errors.document.DocumentIndexingError:
  682. raise DocumentIndexingError('Cannot pause completed document.')
  683. return {'result': 'success'}, 204
  684. class DocumentRecoverApi(DocumentResource):
  685. @setup_required
  686. @login_required
  687. @account_initialization_required
  688. def patch(self, dataset_id, document_id):
  689. """recover document."""
  690. dataset_id = str(dataset_id)
  691. document_id = str(document_id)
  692. dataset = DatasetService.get_dataset(dataset_id)
  693. if not dataset:
  694. raise NotFound('Dataset not found.')
  695. document = DocumentService.get_document(dataset.id, document_id)
  696. # 404 if document not found
  697. if document is None:
  698. raise NotFound("Document Not Exists.")
  699. # 403 if document is archived
  700. if DocumentService.check_archived(document):
  701. raise ArchivedDocumentImmutableError()
  702. try:
  703. # pause document
  704. DocumentService.recover_document(document)
  705. except services.errors.document.DocumentIndexingError:
  706. raise DocumentIndexingError('Document is not in paused status.')
  707. return {'result': 'success'}, 204
  708. class DocumentLimitApi(DocumentResource):
  709. @setup_required
  710. @login_required
  711. @account_initialization_required
  712. def get(self):
  713. """get document limit"""
  714. documents_count = DocumentService.get_tenant_documents_count()
  715. tenant_document_count = int(current_app.config['TENANT_DOCUMENT_COUNT'])
  716. return {
  717. 'documents_count': documents_count,
  718. 'documents_limit': tenant_document_count
  719. }, 200
  720. api.add_resource(GetProcessRuleApi, '/datasets/process-rule')
  721. api.add_resource(DatasetDocumentListApi,
  722. '/datasets/<uuid:dataset_id>/documents')
  723. api.add_resource(DatasetInitApi,
  724. '/datasets/init')
  725. api.add_resource(DocumentIndexingEstimateApi,
  726. '/datasets/<uuid:dataset_id>/documents/<uuid:document_id>/indexing-estimate')
  727. api.add_resource(DocumentBatchIndexingEstimateApi,
  728. '/datasets/<uuid:dataset_id>/batch/<string:batch>/indexing-estimate')
  729. api.add_resource(DocumentBatchIndexingStatusApi,
  730. '/datasets/<uuid:dataset_id>/batch/<string:batch>/indexing-status')
  731. api.add_resource(DocumentIndexingStatusApi,
  732. '/datasets/<uuid:dataset_id>/documents/<uuid:document_id>/indexing-status')
  733. api.add_resource(DocumentDetailApi,
  734. '/datasets/<uuid:dataset_id>/documents/<uuid:document_id>')
  735. api.add_resource(DocumentProcessingApi,
  736. '/datasets/<uuid:dataset_id>/documents/<uuid:document_id>/processing/<string:action>')
  737. api.add_resource(DocumentDeleteApi,
  738. '/datasets/<uuid:dataset_id>/documents/<uuid:document_id>')
  739. api.add_resource(DocumentMetadataApi,
  740. '/datasets/<uuid:dataset_id>/documents/<uuid:document_id>/metadata')
  741. api.add_resource(DocumentStatusApi,
  742. '/datasets/<uuid:dataset_id>/documents/<uuid:document_id>/status/<string:action>')
  743. api.add_resource(DocumentPauseApi, '/datasets/<uuid:dataset_id>/documents/<uuid:document_id>/processing/pause')
  744. api.add_resource(DocumentRecoverApi, '/datasets/<uuid:dataset_id>/documents/<uuid:document_id>/processing/resume')
  745. api.add_resource(DocumentLimitApi, '/datasets/limit')