datasets_document.py 38 KB

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