datasets_document.py 42 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042
  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_model_instance(
  283. tenant_id=current_user.current_tenant_id,
  284. provider=args["embedding_model_provider"],
  285. model_type=ModelType.TEXT_EMBEDDING,
  286. model=args["embedding_model"],
  287. )
  288. except InvokeAuthorizationError:
  289. raise ProviderNotInitializeError(
  290. "No Embedding Model available. Please configure a valid provider "
  291. "in the Settings -> Model Provider."
  292. )
  293. except ProviderTokenNotInitError as ex:
  294. raise ProviderNotInitializeError(ex.description)
  295. # validate args
  296. DocumentService.document_create_args_validate(args)
  297. try:
  298. dataset, documents, batch = DocumentService.save_document_without_dataset_id(
  299. tenant_id=current_user.current_tenant_id, document_data=args, account=current_user
  300. )
  301. except ProviderTokenNotInitError as ex:
  302. raise ProviderNotInitializeError(ex.description)
  303. except QuotaExceededError:
  304. raise ProviderQuotaExceededError()
  305. except ModelCurrentlyNotSupportError:
  306. raise ProviderModelCurrentlyNotSupportError()
  307. response = {"dataset": dataset, "documents": documents, "batch": batch}
  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 = {"tokens": 0, "total_price": 0, "currency": "USD", "total_segments": 0, "preview": []}
  322. if document.data_source_type == "upload_file":
  323. data_source_info = document.data_source_info_dict
  324. if data_source_info and "upload_file_id" in data_source_info:
  325. file_id = data_source_info["upload_file_id"]
  326. file = (
  327. db.session.query(UploadFile)
  328. .filter(UploadFile.tenant_id == document.tenant_id, UploadFile.id == file_id)
  329. .first()
  330. )
  331. # raise error if file not found
  332. if not file:
  333. raise NotFound("File not found.")
  334. extract_setting = ExtractSetting(
  335. datasource_type="upload_file", upload_file=file, document_model=document.doc_form
  336. )
  337. indexing_runner = IndexingRunner()
  338. try:
  339. response = indexing_runner.indexing_estimate(
  340. current_user.current_tenant_id,
  341. [extract_setting],
  342. data_process_rule_dict,
  343. document.doc_form,
  344. "English",
  345. dataset_id,
  346. )
  347. except LLMBadRequestError:
  348. raise ProviderNotInitializeError(
  349. "No Embedding Model available. Please configure a valid provider "
  350. "in the Settings -> Model Provider."
  351. )
  352. except ProviderTokenNotInitError as ex:
  353. raise ProviderNotInitializeError(ex.description)
  354. except Exception as e:
  355. raise IndexingEstimateError(str(e))
  356. return response
  357. class DocumentBatchIndexingEstimateApi(DocumentResource):
  358. @setup_required
  359. @login_required
  360. @account_initialization_required
  361. def get(self, dataset_id, batch):
  362. dataset_id = str(dataset_id)
  363. batch = str(batch)
  364. documents = self.get_batch_documents(dataset_id, batch)
  365. response = {"tokens": 0, "total_price": 0, "currency": "USD", "total_segments": 0, "preview": []}
  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. extract_settings = []
  372. for document in documents:
  373. if document.indexing_status in {"completed", "error"}:
  374. raise DocumentAlreadyFinishedError()
  375. data_source_info = document.data_source_info_dict
  376. # format document files info
  377. if data_source_info and "upload_file_id" in data_source_info:
  378. file_id = data_source_info["upload_file_id"]
  379. info_list.append(file_id)
  380. # format document notion info
  381. elif (
  382. data_source_info and "notion_workspace_id" in data_source_info and "notion_page_id" in data_source_info
  383. ):
  384. pages = []
  385. page = {"page_id": data_source_info["notion_page_id"], "type": data_source_info["type"]}
  386. pages.append(page)
  387. notion_info = {"workspace_id": data_source_info["notion_workspace_id"], "pages": pages}
  388. info_list.append(notion_info)
  389. if document.data_source_type == "upload_file":
  390. file_id = data_source_info["upload_file_id"]
  391. file_detail = (
  392. db.session.query(UploadFile)
  393. .filter(UploadFile.tenant_id == current_user.current_tenant_id, UploadFile.id == file_id)
  394. .first()
  395. )
  396. if file_detail is None:
  397. raise NotFound("File not found.")
  398. extract_setting = ExtractSetting(
  399. datasource_type="upload_file", upload_file=file_detail, document_model=document.doc_form
  400. )
  401. extract_settings.append(extract_setting)
  402. elif document.data_source_type == "notion_import":
  403. extract_setting = ExtractSetting(
  404. datasource_type="notion_import",
  405. notion_info={
  406. "notion_workspace_id": data_source_info["notion_workspace_id"],
  407. "notion_obj_id": data_source_info["notion_page_id"],
  408. "notion_page_type": data_source_info["type"],
  409. "tenant_id": current_user.current_tenant_id,
  410. },
  411. document_model=document.doc_form,
  412. )
  413. extract_settings.append(extract_setting)
  414. elif document.data_source_type == "website_crawl":
  415. extract_setting = ExtractSetting(
  416. datasource_type="website_crawl",
  417. website_info={
  418. "provider": data_source_info["provider"],
  419. "job_id": data_source_info["job_id"],
  420. "url": data_source_info["url"],
  421. "tenant_id": current_user.current_tenant_id,
  422. "mode": data_source_info["mode"],
  423. "only_main_content": data_source_info["only_main_content"],
  424. },
  425. document_model=document.doc_form,
  426. )
  427. extract_settings.append(extract_setting)
  428. else:
  429. raise ValueError("Data source type not support")
  430. indexing_runner = IndexingRunner()
  431. try:
  432. response = indexing_runner.indexing_estimate(
  433. current_user.current_tenant_id,
  434. extract_settings,
  435. data_process_rule_dict,
  436. document.doc_form,
  437. "English",
  438. dataset_id,
  439. )
  440. except LLMBadRequestError:
  441. raise ProviderNotInitializeError(
  442. "No Embedding Model available. Please configure a valid provider "
  443. "in the Settings -> Model Provider."
  444. )
  445. except ProviderTokenNotInitError as ex:
  446. raise ProviderNotInitializeError(ex.description)
  447. except Exception as e:
  448. raise IndexingEstimateError(str(e))
  449. return response
  450. class DocumentBatchIndexingStatusApi(DocumentResource):
  451. @setup_required
  452. @login_required
  453. @account_initialization_required
  454. def get(self, dataset_id, batch):
  455. dataset_id = str(dataset_id)
  456. batch = str(batch)
  457. documents = self.get_batch_documents(dataset_id, batch)
  458. documents_status = []
  459. for document in documents:
  460. completed_segments = DocumentSegment.query.filter(
  461. DocumentSegment.completed_at.isnot(None),
  462. DocumentSegment.document_id == str(document.id),
  463. DocumentSegment.status != "re_segment",
  464. ).count()
  465. total_segments = DocumentSegment.query.filter(
  466. DocumentSegment.document_id == str(document.id), DocumentSegment.status != "re_segment"
  467. ).count()
  468. document.completed_segments = completed_segments
  469. document.total_segments = total_segments
  470. if document.is_paused:
  471. document.indexing_status = "paused"
  472. documents_status.append(marshal(document, document_status_fields))
  473. data = {"data": documents_status}
  474. return data
  475. class DocumentIndexingStatusApi(DocumentResource):
  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.filter(
  484. DocumentSegment.completed_at.isnot(None),
  485. DocumentSegment.document_id == str(document_id),
  486. DocumentSegment.status != "re_segment",
  487. ).count()
  488. total_segments = DocumentSegment.query.filter(
  489. DocumentSegment.document_id == str(document_id), DocumentSegment.status != "re_segment"
  490. ).count()
  491. document.completed_segments = completed_segments
  492. document.total_segments = total_segments
  493. if document.is_paused:
  494. document.indexing_status = "paused"
  495. return marshal(document, document_status_fields)
  496. class DocumentDetailApi(DocumentResource):
  497. METADATA_CHOICES = {"all", "only", "without"}
  498. @setup_required
  499. @login_required
  500. @account_initialization_required
  501. def get(self, dataset_id, document_id):
  502. dataset_id = str(dataset_id)
  503. document_id = str(document_id)
  504. document = self.get_document(dataset_id, document_id)
  505. metadata = request.args.get("metadata", "all")
  506. if metadata not in self.METADATA_CHOICES:
  507. raise InvalidMetadataError(f"Invalid metadata value: {metadata}")
  508. if metadata == "only":
  509. response = {"id": document.id, "doc_type": document.doc_type, "doc_metadata": document.doc_metadata}
  510. elif metadata == "without":
  511. process_rules = DatasetService.get_process_rules(dataset_id)
  512. data_source_info = document.data_source_detail_dict
  513. response = {
  514. "id": document.id,
  515. "position": document.position,
  516. "data_source_type": document.data_source_type,
  517. "data_source_info": data_source_info,
  518. "dataset_process_rule_id": document.dataset_process_rule_id,
  519. "dataset_process_rule": process_rules,
  520. "name": document.name,
  521. "created_from": document.created_from,
  522. "created_by": document.created_by,
  523. "created_at": document.created_at.timestamp(),
  524. "tokens": document.tokens,
  525. "indexing_status": document.indexing_status,
  526. "completed_at": int(document.completed_at.timestamp()) if document.completed_at else None,
  527. "updated_at": int(document.updated_at.timestamp()) if document.updated_at else None,
  528. "indexing_latency": document.indexing_latency,
  529. "error": document.error,
  530. "enabled": document.enabled,
  531. "disabled_at": int(document.disabled_at.timestamp()) if document.disabled_at else None,
  532. "disabled_by": document.disabled_by,
  533. "archived": document.archived,
  534. "segment_count": document.segment_count,
  535. "average_segment_length": document.average_segment_length,
  536. "hit_count": document.hit_count,
  537. "display_status": document.display_status,
  538. "doc_form": document.doc_form,
  539. "doc_language": document.doc_language,
  540. }
  541. else:
  542. process_rules = DatasetService.get_process_rules(dataset_id)
  543. data_source_info = document.data_source_detail_dict
  544. response = {
  545. "id": document.id,
  546. "position": document.position,
  547. "data_source_type": document.data_source_type,
  548. "data_source_info": data_source_info,
  549. "dataset_process_rule_id": document.dataset_process_rule_id,
  550. "dataset_process_rule": process_rules,
  551. "name": document.name,
  552. "created_from": document.created_from,
  553. "created_by": document.created_by,
  554. "created_at": document.created_at.timestamp(),
  555. "tokens": document.tokens,
  556. "indexing_status": document.indexing_status,
  557. "completed_at": int(document.completed_at.timestamp()) if document.completed_at else None,
  558. "updated_at": int(document.updated_at.timestamp()) if document.updated_at else None,
  559. "indexing_latency": document.indexing_latency,
  560. "error": document.error,
  561. "enabled": document.enabled,
  562. "disabled_at": int(document.disabled_at.timestamp()) if document.disabled_at else None,
  563. "disabled_by": document.disabled_by,
  564. "archived": document.archived,
  565. "doc_type": document.doc_type,
  566. "doc_metadata": document.doc_metadata,
  567. "segment_count": document.segment_count,
  568. "average_segment_length": document.average_segment_length,
  569. "hit_count": document.hit_count,
  570. "display_status": document.display_status,
  571. "doc_form": document.doc_form,
  572. "doc_language": document.doc_language,
  573. }
  574. return response, 200
  575. class DocumentProcessingApi(DocumentResource):
  576. @setup_required
  577. @login_required
  578. @account_initialization_required
  579. def patch(self, dataset_id, document_id, action):
  580. dataset_id = str(dataset_id)
  581. document_id = str(document_id)
  582. document = self.get_document(dataset_id, document_id)
  583. # The role of the current user in the ta table must be admin, owner, or editor
  584. if not current_user.is_editor:
  585. raise Forbidden()
  586. if action == "pause":
  587. if document.indexing_status != "indexing":
  588. raise InvalidActionError("Document not in indexing state.")
  589. document.paused_by = current_user.id
  590. document.paused_at = datetime.now(timezone.utc).replace(tzinfo=None)
  591. document.is_paused = True
  592. db.session.commit()
  593. elif action == "resume":
  594. if document.indexing_status not in {"paused", "error"}:
  595. raise InvalidActionError("Document not in paused or error state.")
  596. document.paused_by = None
  597. document.paused_at = None
  598. document.is_paused = False
  599. db.session.commit()
  600. else:
  601. raise InvalidActionError()
  602. return {"result": "success"}, 200
  603. class DocumentDeleteApi(DocumentResource):
  604. @setup_required
  605. @login_required
  606. @account_initialization_required
  607. def delete(self, dataset_id, document_id):
  608. dataset_id = str(dataset_id)
  609. document_id = str(document_id)
  610. dataset = DatasetService.get_dataset(dataset_id)
  611. if dataset is None:
  612. raise NotFound("Dataset not found.")
  613. # check user's model setting
  614. DatasetService.check_dataset_model_setting(dataset)
  615. document = self.get_document(dataset_id, document_id)
  616. try:
  617. DocumentService.delete_document(document)
  618. except services.errors.document.DocumentIndexingError:
  619. raise DocumentIndexingError("Cannot delete document during indexing.")
  620. return {"result": "success"}, 204
  621. class DocumentMetadataApi(DocumentResource):
  622. @setup_required
  623. @login_required
  624. @account_initialization_required
  625. def put(self, dataset_id, document_id):
  626. dataset_id = str(dataset_id)
  627. document_id = str(document_id)
  628. document = self.get_document(dataset_id, document_id)
  629. req_data = request.get_json()
  630. doc_type = req_data.get("doc_type")
  631. doc_metadata = req_data.get("doc_metadata")
  632. # The role of the current user in the ta table must be admin, owner, or editor
  633. if not current_user.is_editor:
  634. raise Forbidden()
  635. if doc_type is None or doc_metadata is None:
  636. raise ValueError("Both doc_type and doc_metadata must be provided.")
  637. if doc_type not in DocumentService.DOCUMENT_METADATA_SCHEMA:
  638. raise ValueError("Invalid doc_type.")
  639. if not isinstance(doc_metadata, dict):
  640. raise ValueError("doc_metadata must be a dictionary.")
  641. metadata_schema = DocumentService.DOCUMENT_METADATA_SCHEMA[doc_type]
  642. document.doc_metadata = {}
  643. if doc_type == "others":
  644. document.doc_metadata = doc_metadata
  645. else:
  646. for key, value_type in metadata_schema.items():
  647. value = doc_metadata.get(key)
  648. if value is not None and isinstance(value, value_type):
  649. document.doc_metadata[key] = value
  650. document.doc_type = doc_type
  651. document.updated_at = datetime.now(timezone.utc).replace(tzinfo=None)
  652. db.session.commit()
  653. return {"result": "success", "message": "Document metadata updated."}, 200
  654. class DocumentStatusApi(DocumentResource):
  655. @setup_required
  656. @login_required
  657. @account_initialization_required
  658. @cloud_edition_billing_resource_check("vector_space")
  659. def patch(self, dataset_id, document_id, action):
  660. dataset_id = str(dataset_id)
  661. document_id = str(document_id)
  662. dataset = DatasetService.get_dataset(dataset_id)
  663. if dataset is None:
  664. raise NotFound("Dataset not found.")
  665. # The role of the current user in the ta table must be admin, owner, or editor
  666. if not current_user.is_dataset_editor:
  667. raise Forbidden()
  668. # check user's model setting
  669. DatasetService.check_dataset_model_setting(dataset)
  670. # check user's permission
  671. DatasetService.check_dataset_permission(dataset, current_user)
  672. document = self.get_document(dataset_id, document_id)
  673. indexing_cache_key = "document_{}_indexing".format(document.id)
  674. cache_result = redis_client.get(indexing_cache_key)
  675. if cache_result is not None:
  676. raise InvalidActionError("Document is being indexed, please try again later")
  677. if action == "enable":
  678. if document.enabled:
  679. raise InvalidActionError("Document already enabled.")
  680. document.enabled = True
  681. document.disabled_at = None
  682. document.disabled_by = None
  683. document.updated_at = datetime.now(timezone.utc).replace(tzinfo=None)
  684. db.session.commit()
  685. # Set cache to prevent indexing the same document multiple times
  686. redis_client.setex(indexing_cache_key, 600, 1)
  687. add_document_to_index_task.delay(document_id)
  688. return {"result": "success"}, 200
  689. elif action == "disable":
  690. if not document.completed_at or document.indexing_status != "completed":
  691. raise InvalidActionError("Document is not completed.")
  692. if not document.enabled:
  693. raise InvalidActionError("Document already disabled.")
  694. document.enabled = False
  695. document.disabled_at = datetime.now(timezone.utc).replace(tzinfo=None)
  696. document.disabled_by = current_user.id
  697. document.updated_at = datetime.now(timezone.utc).replace(tzinfo=None)
  698. db.session.commit()
  699. # Set cache to prevent indexing the same document multiple times
  700. redis_client.setex(indexing_cache_key, 600, 1)
  701. remove_document_from_index_task.delay(document_id)
  702. return {"result": "success"}, 200
  703. elif action == "archive":
  704. if document.archived:
  705. raise InvalidActionError("Document already archived.")
  706. document.archived = True
  707. document.archived_at = datetime.now(timezone.utc).replace(tzinfo=None)
  708. document.archived_by = current_user.id
  709. document.updated_at = datetime.now(timezone.utc).replace(tzinfo=None)
  710. db.session.commit()
  711. if document.enabled:
  712. # Set cache to prevent indexing the same document multiple times
  713. redis_client.setex(indexing_cache_key, 600, 1)
  714. remove_document_from_index_task.delay(document_id)
  715. return {"result": "success"}, 200
  716. elif action == "un_archive":
  717. if not document.archived:
  718. raise InvalidActionError("Document is not archived.")
  719. document.archived = False
  720. document.archived_at = None
  721. document.archived_by = None
  722. document.updated_at = datetime.now(timezone.utc).replace(tzinfo=None)
  723. db.session.commit()
  724. # Set cache to prevent indexing the same document multiple times
  725. redis_client.setex(indexing_cache_key, 600, 1)
  726. add_document_to_index_task.delay(document_id)
  727. return {"result": "success"}, 200
  728. else:
  729. raise InvalidActionError()
  730. class DocumentPauseApi(DocumentResource):
  731. @setup_required
  732. @login_required
  733. @account_initialization_required
  734. def patch(self, dataset_id, document_id):
  735. """pause document."""
  736. dataset_id = str(dataset_id)
  737. document_id = str(document_id)
  738. dataset = DatasetService.get_dataset(dataset_id)
  739. if not dataset:
  740. raise NotFound("Dataset not found.")
  741. document = DocumentService.get_document(dataset.id, document_id)
  742. # 404 if document not found
  743. if document is None:
  744. raise NotFound("Document Not Exists.")
  745. # 403 if document is archived
  746. if DocumentService.check_archived(document):
  747. raise ArchivedDocumentImmutableError()
  748. try:
  749. # pause document
  750. DocumentService.pause_document(document)
  751. except services.errors.document.DocumentIndexingError:
  752. raise DocumentIndexingError("Cannot pause completed document.")
  753. return {"result": "success"}, 204
  754. class DocumentRecoverApi(DocumentResource):
  755. @setup_required
  756. @login_required
  757. @account_initialization_required
  758. def patch(self, dataset_id, document_id):
  759. """recover document."""
  760. dataset_id = str(dataset_id)
  761. document_id = str(document_id)
  762. dataset = DatasetService.get_dataset(dataset_id)
  763. if not dataset:
  764. raise NotFound("Dataset not found.")
  765. document = DocumentService.get_document(dataset.id, document_id)
  766. # 404 if document not found
  767. if document is None:
  768. raise NotFound("Document Not Exists.")
  769. # 403 if document is archived
  770. if DocumentService.check_archived(document):
  771. raise ArchivedDocumentImmutableError()
  772. try:
  773. # pause document
  774. DocumentService.recover_document(document)
  775. except services.errors.document.DocumentIndexingError:
  776. raise DocumentIndexingError("Document is not in paused status.")
  777. return {"result": "success"}, 204
  778. class DocumentRetryApi(DocumentResource):
  779. @setup_required
  780. @login_required
  781. @account_initialization_required
  782. def post(self, dataset_id):
  783. """retry document."""
  784. parser = reqparse.RequestParser()
  785. parser.add_argument("document_ids", type=list, required=True, nullable=False, location="json")
  786. args = parser.parse_args()
  787. dataset_id = str(dataset_id)
  788. dataset = DatasetService.get_dataset(dataset_id)
  789. retry_documents = []
  790. if not dataset:
  791. raise NotFound("Dataset not found.")
  792. for document_id in args["document_ids"]:
  793. try:
  794. document_id = str(document_id)
  795. document = DocumentService.get_document(dataset.id, document_id)
  796. # 404 if document not found
  797. if document is None:
  798. raise NotFound("Document Not Exists.")
  799. # 403 if document is archived
  800. if DocumentService.check_archived(document):
  801. raise ArchivedDocumentImmutableError()
  802. # 400 if document is completed
  803. if document.indexing_status == "completed":
  804. raise DocumentAlreadyFinishedError()
  805. retry_documents.append(document)
  806. except Exception as e:
  807. logging.exception(f"Document {document_id} retry failed: {str(e)}")
  808. continue
  809. # retry document
  810. DocumentService.retry_document(dataset_id, retry_documents)
  811. return {"result": "success"}, 204
  812. class DocumentRenameApi(DocumentResource):
  813. @setup_required
  814. @login_required
  815. @account_initialization_required
  816. @marshal_with(document_fields)
  817. def post(self, dataset_id, document_id):
  818. # The role of the current user in the ta table must be admin, owner, editor, or dataset_operator
  819. if not current_user.is_dataset_editor:
  820. raise Forbidden()
  821. dataset = DatasetService.get_dataset(dataset_id)
  822. DatasetService.check_dataset_operator_permission(current_user, dataset)
  823. parser = reqparse.RequestParser()
  824. parser.add_argument("name", type=str, required=True, nullable=False, location="json")
  825. args = parser.parse_args()
  826. try:
  827. document = DocumentService.rename_document(dataset_id, document_id, args["name"])
  828. except services.errors.document.DocumentIndexingError:
  829. raise DocumentIndexingError("Cannot delete document during indexing.")
  830. return document
  831. class WebsiteDocumentSyncApi(DocumentResource):
  832. @setup_required
  833. @login_required
  834. @account_initialization_required
  835. def get(self, dataset_id, document_id):
  836. """sync website document."""
  837. dataset_id = str(dataset_id)
  838. dataset = DatasetService.get_dataset(dataset_id)
  839. if not dataset:
  840. raise NotFound("Dataset not found.")
  841. document_id = str(document_id)
  842. document = DocumentService.get_document(dataset.id, document_id)
  843. if not document:
  844. raise NotFound("Document not found.")
  845. if document.tenant_id != current_user.current_tenant_id:
  846. raise Forbidden("No permission.")
  847. if document.data_source_type != "website_crawl":
  848. raise ValueError("Document is not a website document.")
  849. # 403 if document is archived
  850. if DocumentService.check_archived(document):
  851. raise ArchivedDocumentImmutableError()
  852. # sync document
  853. DocumentService.sync_website_document(dataset_id, document)
  854. return {"result": "success"}, 200
  855. api.add_resource(GetProcessRuleApi, "/datasets/process-rule")
  856. api.add_resource(DatasetDocumentListApi, "/datasets/<uuid:dataset_id>/documents")
  857. api.add_resource(DatasetInitApi, "/datasets/init")
  858. api.add_resource(
  859. DocumentIndexingEstimateApi, "/datasets/<uuid:dataset_id>/documents/<uuid:document_id>/indexing-estimate"
  860. )
  861. api.add_resource(DocumentBatchIndexingEstimateApi, "/datasets/<uuid:dataset_id>/batch/<string:batch>/indexing-estimate")
  862. api.add_resource(DocumentBatchIndexingStatusApi, "/datasets/<uuid:dataset_id>/batch/<string:batch>/indexing-status")
  863. api.add_resource(DocumentIndexingStatusApi, "/datasets/<uuid:dataset_id>/documents/<uuid:document_id>/indexing-status")
  864. api.add_resource(DocumentDetailApi, "/datasets/<uuid:dataset_id>/documents/<uuid:document_id>")
  865. api.add_resource(
  866. DocumentProcessingApi, "/datasets/<uuid:dataset_id>/documents/<uuid:document_id>/processing/<string:action>"
  867. )
  868. api.add_resource(DocumentDeleteApi, "/datasets/<uuid:dataset_id>/documents/<uuid:document_id>")
  869. api.add_resource(DocumentMetadataApi, "/datasets/<uuid:dataset_id>/documents/<uuid:document_id>/metadata")
  870. api.add_resource(DocumentStatusApi, "/datasets/<uuid:dataset_id>/documents/<uuid:document_id>/status/<string:action>")
  871. api.add_resource(DocumentPauseApi, "/datasets/<uuid:dataset_id>/documents/<uuid:document_id>/processing/pause")
  872. api.add_resource(DocumentRecoverApi, "/datasets/<uuid:dataset_id>/documents/<uuid:document_id>/processing/resume")
  873. api.add_resource(DocumentRetryApi, "/datasets/<uuid:dataset_id>/retry")
  874. api.add_resource(DocumentRenameApi, "/datasets/<uuid:dataset_id>/documents/<uuid:document_id>/rename")
  875. api.add_resource(WebsiteDocumentSyncApi, "/datasets/<uuid:dataset_id>/documents/<uuid:document_id>/website-sync")