datasets_document.py 42 KB

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