datasets_document.py 41 KB

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