datasets_document.py 41 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020
  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. }
  520. else:
  521. process_rules = DatasetService.get_process_rules(dataset_id)
  522. data_source_info = document.data_source_detail_dict
  523. response = {
  524. "id": document.id,
  525. "position": document.position,
  526. "data_source_type": document.data_source_type,
  527. "data_source_info": data_source_info,
  528. "dataset_process_rule_id": document.dataset_process_rule_id,
  529. "dataset_process_rule": process_rules,
  530. "name": document.name,
  531. "created_from": document.created_from,
  532. "created_by": document.created_by,
  533. "created_at": document.created_at.timestamp(),
  534. "tokens": document.tokens,
  535. "indexing_status": document.indexing_status,
  536. "completed_at": int(document.completed_at.timestamp()) if document.completed_at else None,
  537. "updated_at": int(document.updated_at.timestamp()) if document.updated_at else None,
  538. "indexing_latency": document.indexing_latency,
  539. "error": document.error,
  540. "enabled": document.enabled,
  541. "disabled_at": int(document.disabled_at.timestamp()) if document.disabled_at else None,
  542. "disabled_by": document.disabled_by,
  543. "archived": document.archived,
  544. "doc_type": document.doc_type,
  545. "doc_metadata": document.doc_metadata,
  546. "segment_count": document.segment_count,
  547. "average_segment_length": document.average_segment_length,
  548. "hit_count": document.hit_count,
  549. "display_status": document.display_status,
  550. "doc_form": document.doc_form,
  551. }
  552. return response, 200
  553. class DocumentProcessingApi(DocumentResource):
  554. @setup_required
  555. @login_required
  556. @account_initialization_required
  557. def patch(self, dataset_id, document_id, action):
  558. dataset_id = str(dataset_id)
  559. document_id = str(document_id)
  560. document = self.get_document(dataset_id, document_id)
  561. # The role of the current user in the ta table must be admin, owner, or editor
  562. if not current_user.is_editor:
  563. raise Forbidden()
  564. if action == "pause":
  565. if document.indexing_status != "indexing":
  566. raise InvalidActionError("Document not in indexing state.")
  567. document.paused_by = current_user.id
  568. document.paused_at = datetime.now(timezone.utc).replace(tzinfo=None)
  569. document.is_paused = True
  570. db.session.commit()
  571. elif action == "resume":
  572. if document.indexing_status not in ["paused", "error"]:
  573. raise InvalidActionError("Document not in paused or error state.")
  574. document.paused_by = None
  575. document.paused_at = None
  576. document.is_paused = False
  577. db.session.commit()
  578. else:
  579. raise InvalidActionError()
  580. return {"result": "success"}, 200
  581. class DocumentDeleteApi(DocumentResource):
  582. @setup_required
  583. @login_required
  584. @account_initialization_required
  585. def delete(self, dataset_id, document_id):
  586. dataset_id = str(dataset_id)
  587. document_id = str(document_id)
  588. dataset = DatasetService.get_dataset(dataset_id)
  589. if dataset is None:
  590. raise NotFound("Dataset not found.")
  591. # check user's model setting
  592. DatasetService.check_dataset_model_setting(dataset)
  593. document = self.get_document(dataset_id, document_id)
  594. try:
  595. DocumentService.delete_document(document)
  596. except services.errors.document.DocumentIndexingError:
  597. raise DocumentIndexingError("Cannot delete document during indexing.")
  598. return {"result": "success"}, 204
  599. class DocumentMetadataApi(DocumentResource):
  600. @setup_required
  601. @login_required
  602. @account_initialization_required
  603. def put(self, dataset_id, document_id):
  604. dataset_id = str(dataset_id)
  605. document_id = str(document_id)
  606. document = self.get_document(dataset_id, document_id)
  607. req_data = request.get_json()
  608. doc_type = req_data.get("doc_type")
  609. doc_metadata = req_data.get("doc_metadata")
  610. # The role of the current user in the ta table must be admin, owner, or editor
  611. if not current_user.is_editor:
  612. raise Forbidden()
  613. if doc_type is None or doc_metadata is None:
  614. raise ValueError("Both doc_type and doc_metadata must be provided.")
  615. if doc_type not in DocumentService.DOCUMENT_METADATA_SCHEMA:
  616. raise ValueError("Invalid doc_type.")
  617. if not isinstance(doc_metadata, dict):
  618. raise ValueError("doc_metadata must be a dictionary.")
  619. metadata_schema = DocumentService.DOCUMENT_METADATA_SCHEMA[doc_type]
  620. document.doc_metadata = {}
  621. if doc_type == "others":
  622. document.doc_metadata = doc_metadata
  623. else:
  624. for key, value_type in metadata_schema.items():
  625. value = doc_metadata.get(key)
  626. if value is not None and isinstance(value, value_type):
  627. document.doc_metadata[key] = value
  628. document.doc_type = doc_type
  629. document.updated_at = datetime.now(timezone.utc).replace(tzinfo=None)
  630. db.session.commit()
  631. return {"result": "success", "message": "Document metadata updated."}, 200
  632. class DocumentStatusApi(DocumentResource):
  633. @setup_required
  634. @login_required
  635. @account_initialization_required
  636. @cloud_edition_billing_resource_check("vector_space")
  637. def patch(self, dataset_id, document_id, action):
  638. dataset_id = str(dataset_id)
  639. document_id = str(document_id)
  640. dataset = DatasetService.get_dataset(dataset_id)
  641. if dataset is None:
  642. raise NotFound("Dataset not found.")
  643. # The role of the current user in the ta table must be admin, owner, or editor
  644. if not current_user.is_dataset_editor:
  645. raise Forbidden()
  646. # check user's model setting
  647. DatasetService.check_dataset_model_setting(dataset)
  648. # check user's permission
  649. DatasetService.check_dataset_permission(dataset, current_user)
  650. document = self.get_document(dataset_id, document_id)
  651. indexing_cache_key = "document_{}_indexing".format(document.id)
  652. cache_result = redis_client.get(indexing_cache_key)
  653. if cache_result is not None:
  654. raise InvalidActionError("Document is being indexed, please try again later")
  655. if action == "enable":
  656. if document.enabled:
  657. raise InvalidActionError("Document already enabled.")
  658. document.enabled = True
  659. document.disabled_at = None
  660. document.disabled_by = None
  661. document.updated_at = datetime.now(timezone.utc).replace(tzinfo=None)
  662. db.session.commit()
  663. # Set cache to prevent indexing the same document multiple times
  664. redis_client.setex(indexing_cache_key, 600, 1)
  665. add_document_to_index_task.delay(document_id)
  666. return {"result": "success"}, 200
  667. elif action == "disable":
  668. if not document.completed_at or document.indexing_status != "completed":
  669. raise InvalidActionError("Document is not completed.")
  670. if not document.enabled:
  671. raise InvalidActionError("Document already disabled.")
  672. document.enabled = False
  673. document.disabled_at = datetime.now(timezone.utc).replace(tzinfo=None)
  674. document.disabled_by = current_user.id
  675. document.updated_at = datetime.now(timezone.utc).replace(tzinfo=None)
  676. db.session.commit()
  677. # Set cache to prevent indexing the same document multiple times
  678. redis_client.setex(indexing_cache_key, 600, 1)
  679. remove_document_from_index_task.delay(document_id)
  680. return {"result": "success"}, 200
  681. elif action == "archive":
  682. if document.archived:
  683. raise InvalidActionError("Document already archived.")
  684. document.archived = True
  685. document.archived_at = datetime.now(timezone.utc).replace(tzinfo=None)
  686. document.archived_by = current_user.id
  687. document.updated_at = datetime.now(timezone.utc).replace(tzinfo=None)
  688. db.session.commit()
  689. if document.enabled:
  690. # Set cache to prevent indexing the same document multiple times
  691. redis_client.setex(indexing_cache_key, 600, 1)
  692. remove_document_from_index_task.delay(document_id)
  693. return {"result": "success"}, 200
  694. elif action == "un_archive":
  695. if not document.archived:
  696. raise InvalidActionError("Document is not archived.")
  697. document.archived = False
  698. document.archived_at = None
  699. document.archived_by = None
  700. document.updated_at = datetime.now(timezone.utc).replace(tzinfo=None)
  701. db.session.commit()
  702. # Set cache to prevent indexing the same document multiple times
  703. redis_client.setex(indexing_cache_key, 600, 1)
  704. add_document_to_index_task.delay(document_id)
  705. return {"result": "success"}, 200
  706. else:
  707. raise InvalidActionError()
  708. class DocumentPauseApi(DocumentResource):
  709. @setup_required
  710. @login_required
  711. @account_initialization_required
  712. def patch(self, dataset_id, document_id):
  713. """pause document."""
  714. dataset_id = str(dataset_id)
  715. document_id = str(document_id)
  716. dataset = DatasetService.get_dataset(dataset_id)
  717. if not dataset:
  718. raise NotFound("Dataset not found.")
  719. document = DocumentService.get_document(dataset.id, document_id)
  720. # 404 if document not found
  721. if document is None:
  722. raise NotFound("Document Not Exists.")
  723. # 403 if document is archived
  724. if DocumentService.check_archived(document):
  725. raise ArchivedDocumentImmutableError()
  726. try:
  727. # pause document
  728. DocumentService.pause_document(document)
  729. except services.errors.document.DocumentIndexingError:
  730. raise DocumentIndexingError("Cannot pause completed document.")
  731. return {"result": "success"}, 204
  732. class DocumentRecoverApi(DocumentResource):
  733. @setup_required
  734. @login_required
  735. @account_initialization_required
  736. def patch(self, dataset_id, document_id):
  737. """recover document."""
  738. dataset_id = str(dataset_id)
  739. document_id = str(document_id)
  740. dataset = DatasetService.get_dataset(dataset_id)
  741. if not dataset:
  742. raise NotFound("Dataset not found.")
  743. document = DocumentService.get_document(dataset.id, document_id)
  744. # 404 if document not found
  745. if document is None:
  746. raise NotFound("Document Not Exists.")
  747. # 403 if document is archived
  748. if DocumentService.check_archived(document):
  749. raise ArchivedDocumentImmutableError()
  750. try:
  751. # pause document
  752. DocumentService.recover_document(document)
  753. except services.errors.document.DocumentIndexingError:
  754. raise DocumentIndexingError("Document is not in paused status.")
  755. return {"result": "success"}, 204
  756. class DocumentRetryApi(DocumentResource):
  757. @setup_required
  758. @login_required
  759. @account_initialization_required
  760. def post(self, dataset_id):
  761. """retry document."""
  762. parser = reqparse.RequestParser()
  763. parser.add_argument("document_ids", type=list, required=True, nullable=False, location="json")
  764. args = parser.parse_args()
  765. dataset_id = str(dataset_id)
  766. dataset = DatasetService.get_dataset(dataset_id)
  767. retry_documents = []
  768. if not dataset:
  769. raise NotFound("Dataset not found.")
  770. for document_id in args["document_ids"]:
  771. try:
  772. document_id = str(document_id)
  773. document = DocumentService.get_document(dataset.id, document_id)
  774. # 404 if document not found
  775. if document is None:
  776. raise NotFound("Document Not Exists.")
  777. # 403 if document is archived
  778. if DocumentService.check_archived(document):
  779. raise ArchivedDocumentImmutableError()
  780. # 400 if document is completed
  781. if document.indexing_status == "completed":
  782. raise DocumentAlreadyFinishedError()
  783. retry_documents.append(document)
  784. except Exception as e:
  785. logging.error(f"Document {document_id} retry failed: {str(e)}")
  786. continue
  787. # retry document
  788. DocumentService.retry_document(dataset_id, retry_documents)
  789. return {"result": "success"}, 204
  790. class DocumentRenameApi(DocumentResource):
  791. @setup_required
  792. @login_required
  793. @account_initialization_required
  794. @marshal_with(document_fields)
  795. def post(self, dataset_id, document_id):
  796. # The role of the current user in the ta table must be admin, owner, editor, or dataset_operator
  797. if not current_user.is_dataset_editor:
  798. raise Forbidden()
  799. dataset = DatasetService.get_dataset(dataset_id)
  800. DatasetService.check_dataset_operator_permission(current_user, dataset)
  801. parser = reqparse.RequestParser()
  802. parser.add_argument("name", type=str, required=True, nullable=False, location="json")
  803. args = parser.parse_args()
  804. try:
  805. document = DocumentService.rename_document(dataset_id, document_id, args["name"])
  806. except services.errors.document.DocumentIndexingError:
  807. raise DocumentIndexingError("Cannot delete document during indexing.")
  808. return document
  809. class WebsiteDocumentSyncApi(DocumentResource):
  810. @setup_required
  811. @login_required
  812. @account_initialization_required
  813. def get(self, dataset_id, document_id):
  814. """sync website document."""
  815. dataset_id = str(dataset_id)
  816. dataset = DatasetService.get_dataset(dataset_id)
  817. if not dataset:
  818. raise NotFound("Dataset not found.")
  819. document_id = str(document_id)
  820. document = DocumentService.get_document(dataset.id, document_id)
  821. if not document:
  822. raise NotFound("Document not found.")
  823. if document.tenant_id != current_user.current_tenant_id:
  824. raise Forbidden("No permission.")
  825. if document.data_source_type != "website_crawl":
  826. raise ValueError("Document is not a website document.")
  827. # 403 if document is archived
  828. if DocumentService.check_archived(document):
  829. raise ArchivedDocumentImmutableError()
  830. # sync document
  831. DocumentService.sync_website_document(dataset_id, document)
  832. return {"result": "success"}, 200
  833. api.add_resource(GetProcessRuleApi, "/datasets/process-rule")
  834. api.add_resource(DatasetDocumentListApi, "/datasets/<uuid:dataset_id>/documents")
  835. api.add_resource(DatasetInitApi, "/datasets/init")
  836. api.add_resource(
  837. DocumentIndexingEstimateApi, "/datasets/<uuid:dataset_id>/documents/<uuid:document_id>/indexing-estimate"
  838. )
  839. api.add_resource(DocumentBatchIndexingEstimateApi, "/datasets/<uuid:dataset_id>/batch/<string:batch>/indexing-estimate")
  840. api.add_resource(DocumentBatchIndexingStatusApi, "/datasets/<uuid:dataset_id>/batch/<string:batch>/indexing-status")
  841. api.add_resource(DocumentIndexingStatusApi, "/datasets/<uuid:dataset_id>/documents/<uuid:document_id>/indexing-status")
  842. api.add_resource(DocumentDetailApi, "/datasets/<uuid:dataset_id>/documents/<uuid:document_id>")
  843. api.add_resource(
  844. DocumentProcessingApi, "/datasets/<uuid:dataset_id>/documents/<uuid:document_id>/processing/<string:action>"
  845. )
  846. api.add_resource(DocumentDeleteApi, "/datasets/<uuid:dataset_id>/documents/<uuid:document_id>")
  847. api.add_resource(DocumentMetadataApi, "/datasets/<uuid:dataset_id>/documents/<uuid:document_id>/metadata")
  848. api.add_resource(DocumentStatusApi, "/datasets/<uuid:dataset_id>/documents/<uuid:document_id>/status/<string:action>")
  849. api.add_resource(DocumentPauseApi, "/datasets/<uuid:dataset_id>/documents/<uuid:document_id>/processing/pause")
  850. api.add_resource(DocumentRecoverApi, "/datasets/<uuid:dataset_id>/documents/<uuid:document_id>/processing/resume")
  851. api.add_resource(DocumentRetryApi, "/datasets/<uuid:dataset_id>/retry")
  852. api.add_resource(DocumentRenameApi, "/datasets/<uuid:dataset_id>/documents/<uuid:document_id>/rename")
  853. api.add_resource(WebsiteDocumentSyncApi, "/datasets/<uuid:dataset_id>/documents/<uuid:document_id>/website-sync")