datasets_document.py 41 KB

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