datasets_document.py 47 KB

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