datasets_document.py 36 KB

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