datasets.py 33 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852
  1. import flask_restful # type: ignore
  2. from flask import request
  3. from flask_login import current_user # type: ignore # type: ignore
  4. from flask_restful import Resource, marshal, marshal_with, reqparse # type: ignore
  5. from werkzeug.exceptions import Forbidden, NotFound
  6. import services
  7. from configs import dify_config
  8. from controllers.console import api
  9. from controllers.console.apikey import api_key_fields, api_key_list
  10. from controllers.console.app.error import ProviderNotInitializeError
  11. from controllers.console.datasets.error import DatasetInUseError, DatasetNameDuplicateError, IndexingEstimateError
  12. from controllers.console.wraps import (
  13. account_initialization_required,
  14. cloud_edition_billing_rate_limit_check,
  15. enterprise_license_required,
  16. setup_required,
  17. )
  18. from core.errors.error import LLMBadRequestError, ProviderTokenNotInitError
  19. from core.indexing_runner import IndexingRunner
  20. from core.model_runtime.entities.model_entities import ModelType
  21. from core.plugin.entities.plugin import ModelProviderID
  22. from core.provider_manager import ProviderManager
  23. from core.rag.datasource.vdb.vector_type import VectorType
  24. from core.rag.extractor.entity.extract_setting import ExtractSetting
  25. from core.rag.retrieval.retrieval_methods import RetrievalMethod
  26. from extensions.ext_database import db
  27. from fields.app_fields import related_app_list
  28. from fields.dataset_fields import dataset_detail_fields, dataset_query_detail_fields
  29. from fields.document_fields import document_status_fields
  30. from libs.login import login_required
  31. from models import ApiToken, Dataset, Document, DocumentSegment, UploadFile
  32. from models.dataset import DatasetPermissionEnum
  33. from services.dataset_service import DatasetPermissionService, DatasetService, DocumentService
  34. def _validate_name(name):
  35. if not name or len(name) < 1 or len(name) > 40:
  36. raise ValueError("Name must be between 1 to 40 characters.")
  37. return name
  38. def _validate_description_length(description):
  39. if len(description) > 400:
  40. raise ValueError("Description cannot exceed 400 characters.")
  41. return description
  42. class DatasetListApi(Resource):
  43. @setup_required
  44. @login_required
  45. @account_initialization_required
  46. @enterprise_license_required
  47. def get(self):
  48. page = request.args.get("page", default=1, type=int)
  49. limit = request.args.get("limit", default=20, type=int)
  50. ids = request.args.getlist("ids")
  51. # provider = request.args.get("provider", default="vendor")
  52. search = request.args.get("keyword", default=None, type=str)
  53. tag_ids = request.args.getlist("tag_ids")
  54. auth_type = request.args.get("authType", default=None, type=int)
  55. creator_dept = request.args.get("creatorDept")
  56. creator = request.args.get("creator", default=None, type=str)
  57. category_ids = request.args.getlist("category_ids")
  58. include_all = request.args.get("include_all", default="false").lower() == "true"
  59. if ids:
  60. datasets, total = DatasetService.get_datasets_by_ids(ids, current_user.current_tenant_id)
  61. else:
  62. datasets, total = DatasetService.get_datasets2(
  63. page,
  64. limit,
  65. current_user.current_tenant_id,
  66. current_user,
  67. search,
  68. tag_ids,
  69. category_ids,
  70. auth_type,
  71. creator_dept,
  72. creator,
  73. include_all,
  74. )
  75. # check embedding setting
  76. provider_manager = ProviderManager()
  77. configurations = provider_manager.get_configurations(tenant_id=current_user.current_tenant_id)
  78. embedding_models = configurations.get_models(model_type=ModelType.TEXT_EMBEDDING, only_active=True)
  79. model_names = []
  80. for embedding_model in embedding_models:
  81. model_names.append(f"{embedding_model.model}:{embedding_model.provider.provider}")
  82. data = marshal(datasets, dataset_detail_fields)
  83. for item in data:
  84. # 返回编辑授权
  85. item["has_edit_permission"] = DatasetService.has_edit_permission(current_user.id, item["id"])
  86. # convert embedding_model_provider to plugin standard format
  87. if item["indexing_technique"] == "high_quality" and item["embedding_model_provider"]:
  88. item["embedding_model_provider"] = str(ModelProviderID(item["embedding_model_provider"]))
  89. item_model = f"{item['embedding_model']}:{item['embedding_model_provider']}"
  90. if item_model in model_names:
  91. item["embedding_available"] = True
  92. else:
  93. item["embedding_available"] = False
  94. else:
  95. item["embedding_available"] = True
  96. if item.get("permission") == "partial_members":
  97. part_users_list = DatasetPermissionService.get_dataset_partial_member_list(item["id"])
  98. item.update({"partial_member_list": part_users_list})
  99. else:
  100. item.update({"partial_member_list": []})
  101. response = {"data": data, "has_more": len(datasets) == limit, "limit": limit, "total": total, "page": page}
  102. return response, 200
  103. @setup_required
  104. @login_required
  105. @account_initialization_required
  106. @cloud_edition_billing_rate_limit_check("knowledge")
  107. def post(self):
  108. parser = reqparse.RequestParser()
  109. parser.add_argument(
  110. "name",
  111. nullable=False,
  112. required=True,
  113. help="type is required. Name must be between 1 to 40 characters.",
  114. type=_validate_name,
  115. )
  116. parser.add_argument(
  117. "description",
  118. type=str,
  119. nullable=True,
  120. required=False,
  121. default="",
  122. )
  123. parser.add_argument(
  124. "indexing_technique",
  125. type=str,
  126. location="json",
  127. choices=Dataset.INDEXING_TECHNIQUE_LIST,
  128. nullable=True,
  129. help="Invalid indexing technique.",
  130. )
  131. parser.add_argument(
  132. "external_knowledge_api_id",
  133. type=str,
  134. nullable=True,
  135. required=False,
  136. )
  137. parser.add_argument(
  138. "provider",
  139. type=str,
  140. nullable=True,
  141. choices=Dataset.PROVIDER_LIST,
  142. required=False,
  143. default="vendor",
  144. )
  145. parser.add_argument(
  146. "external_knowledge_id",
  147. type=str,
  148. nullable=True,
  149. required=False,
  150. )
  151. args = parser.parse_args()
  152. # The role of the current user in the ta table must be admin, owner, or editor, or dataset_operator
  153. if not current_user.is_dataset_editor:
  154. raise Forbidden()
  155. try:
  156. dataset = DatasetService.create_empty_dataset(
  157. tenant_id=current_user.current_tenant_id,
  158. name=args["name"],
  159. description=args["description"],
  160. indexing_technique=args["indexing_technique"],
  161. account=current_user,
  162. permission=DatasetPermissionEnum.ONLY_ME,
  163. provider=args["provider"],
  164. external_knowledge_api_id=args["external_knowledge_api_id"],
  165. external_knowledge_id=args["external_knowledge_id"],
  166. )
  167. except services.errors.dataset.DatasetNameDuplicateError:
  168. raise DatasetNameDuplicateError()
  169. return marshal(dataset, dataset_detail_fields), 201
  170. class DatasetApi(Resource):
  171. @setup_required
  172. @login_required
  173. @account_initialization_required
  174. def get(self, dataset_id):
  175. dataset_id_str = str(dataset_id)
  176. dataset = DatasetService.get_dataset(dataset_id_str)
  177. if dataset is None:
  178. raise NotFound("Dataset not found.")
  179. try:
  180. DatasetService.check_dataset_permission(dataset, current_user)
  181. except services.errors.account.NoPermissionError as e:
  182. raise Forbidden(str(e))
  183. data = marshal(dataset, dataset_detail_fields)
  184. if dataset.indexing_technique == "high_quality":
  185. if dataset.embedding_model_provider:
  186. provider_id = ModelProviderID(dataset.embedding_model_provider)
  187. data["embedding_model_provider"] = str(provider_id)
  188. if data.get("permission") == "partial_members":
  189. part_users_list = DatasetPermissionService.get_dataset_partial_member_list(dataset_id_str)
  190. data.update({"partial_member_list": part_users_list})
  191. # check embedding setting
  192. provider_manager = ProviderManager()
  193. configurations = provider_manager.get_configurations(tenant_id=current_user.current_tenant_id)
  194. embedding_models = configurations.get_models(model_type=ModelType.TEXT_EMBEDDING, only_active=True)
  195. model_names = []
  196. for embedding_model in embedding_models:
  197. model_names.append(f"{embedding_model.model}:{embedding_model.provider.provider}")
  198. if data["indexing_technique"] == "high_quality":
  199. item_model = f"{data['embedding_model']}:{data['embedding_model_provider']}"
  200. if item_model in model_names:
  201. data["embedding_available"] = True
  202. else:
  203. data["embedding_available"] = False
  204. else:
  205. data["embedding_available"] = True
  206. if data.get("permission") == "partial_members":
  207. part_users_list = DatasetPermissionService.get_dataset_partial_member_list(dataset_id_str)
  208. data.update({"partial_member_list": part_users_list})
  209. data["has_edit_permission"] = DatasetService.has_edit_permission(current_user.id, dataset_id_str)
  210. return data, 200
  211. @setup_required
  212. @login_required
  213. @account_initialization_required
  214. @cloud_edition_billing_rate_limit_check("knowledge")
  215. def patch(self, dataset_id):
  216. dataset_id_str = str(dataset_id)
  217. dataset = DatasetService.get_dataset(dataset_id_str)
  218. if dataset is None:
  219. raise NotFound("Dataset not found.")
  220. parser = reqparse.RequestParser()
  221. parser.add_argument(
  222. "name",
  223. nullable=False,
  224. help="type is required. Name must be between 1 to 40 characters.",
  225. type=_validate_name,
  226. )
  227. parser.add_argument("description", location="json", store_missing=False, type=_validate_description_length)
  228. parser.add_argument(
  229. "indexing_technique",
  230. type=str,
  231. location="json",
  232. choices=Dataset.INDEXING_TECHNIQUE_LIST,
  233. nullable=True,
  234. help="Invalid indexing technique.",
  235. )
  236. parser.add_argument(
  237. "permission",
  238. type=str,
  239. location="json",
  240. choices=(DatasetPermissionEnum.ONLY_ME, DatasetPermissionEnum.ALL_TEAM, DatasetPermissionEnum.PARTIAL_TEAM),
  241. help="Invalid permission.",
  242. )
  243. parser.add_argument("embedding_model", type=str, location="json", help="Invalid embedding model.")
  244. parser.add_argument(
  245. "embedding_model_provider", type=str, location="json", help="Invalid embedding model provider."
  246. )
  247. parser.add_argument("retrieval_model", type=dict, location="json", help="Invalid retrieval model.")
  248. parser.add_argument("partial_member_list", type=list, location="json", help="Invalid parent user list.")
  249. parser.add_argument(
  250. "external_retrieval_model",
  251. type=dict,
  252. required=False,
  253. nullable=True,
  254. location="json",
  255. help="Invalid external retrieval model.",
  256. )
  257. parser.add_argument(
  258. "external_knowledge_id",
  259. type=str,
  260. required=False,
  261. nullable=True,
  262. location="json",
  263. help="Invalid external knowledge id.",
  264. )
  265. parser.add_argument(
  266. "external_knowledge_api_id",
  267. type=str,
  268. required=False,
  269. nullable=True,
  270. location="json",
  271. help="Invalid external knowledge api id.",
  272. )
  273. args = parser.parse_args()
  274. data = request.get_json()
  275. # check embedding model setting
  276. if (
  277. data.get("indexing_technique") == "high_quality"
  278. and data.get("embedding_model_provider") is not None
  279. and data.get("embedding_model") is not None
  280. ):
  281. DatasetService.check_embedding_model_setting(
  282. dataset.tenant_id, data.get("embedding_model_provider"), data.get("embedding_model")
  283. )
  284. # The role of the current user in the ta table must be admin, owner, editor, or dataset_operator
  285. DatasetPermissionService.check_permission(
  286. current_user, dataset, data.get("permission"), data.get("partial_member_list")
  287. )
  288. dataset = DatasetService.update_dataset(dataset_id_str, args, current_user)
  289. if dataset is None:
  290. raise NotFound("Dataset not found.")
  291. result_data = marshal(dataset, dataset_detail_fields)
  292. tenant_id = current_user.current_tenant_id
  293. if data.get("partial_member_list") and data.get("permission") == "partial_members":
  294. DatasetPermissionService.update_partial_member_list(
  295. tenant_id, dataset_id_str, data.get("partial_member_list")
  296. )
  297. # clear partial member list when permission is only_me or all_team_members
  298. elif (
  299. data.get("permission") == DatasetPermissionEnum.ONLY_ME
  300. or data.get("permission") == DatasetPermissionEnum.ALL_TEAM
  301. ):
  302. DatasetPermissionService.clear_partial_member_list(dataset_id_str)
  303. partial_member_list = DatasetPermissionService.get_dataset_partial_member_list(dataset_id_str)
  304. result_data.update({"partial_member_list": partial_member_list})
  305. return result_data, 200
  306. @setup_required
  307. @login_required
  308. @account_initialization_required
  309. @cloud_edition_billing_rate_limit_check("knowledge")
  310. def delete(self, dataset_id):
  311. dataset_id_str = str(dataset_id)
  312. # The role of the current user in the ta table must be admin, owner, or editor
  313. if not current_user.is_editor or current_user.is_dataset_operator:
  314. raise Forbidden()
  315. try:
  316. if DatasetService.delete_dataset(dataset_id_str, current_user):
  317. DatasetPermissionService.clear_partial_member_list(dataset_id_str)
  318. return {"result": "success"}, 204
  319. else:
  320. raise NotFound("Dataset not found.")
  321. except services.errors.dataset.DatasetInUseError:
  322. raise DatasetInUseError()
  323. class DatasetUseCheckApi(Resource):
  324. @setup_required
  325. @login_required
  326. @account_initialization_required
  327. def get(self, dataset_id):
  328. dataset_id_str = str(dataset_id)
  329. dataset_is_using = DatasetService.dataset_use_check(dataset_id_str)
  330. return {"is_using": dataset_is_using}, 200
  331. class DatasetQueryApi(Resource):
  332. @setup_required
  333. @login_required
  334. @account_initialization_required
  335. def get(self, dataset_id):
  336. dataset_id_str = str(dataset_id)
  337. dataset = DatasetService.get_dataset(dataset_id_str)
  338. if dataset is None:
  339. raise NotFound("Dataset not found.")
  340. try:
  341. DatasetService.check_dataset_permission(dataset, current_user)
  342. except services.errors.account.NoPermissionError as e:
  343. raise Forbidden(str(e))
  344. page = request.args.get("page", default=1, type=int)
  345. limit = request.args.get("limit", default=20, type=int)
  346. dataset_queries, total = DatasetService.get_dataset_queries(dataset_id=dataset.id, page=page, per_page=limit)
  347. response = {
  348. "data": marshal(dataset_queries, dataset_query_detail_fields),
  349. "has_more": len(dataset_queries) == limit,
  350. "limit": limit,
  351. "total": total,
  352. "page": page,
  353. }
  354. return response, 200
  355. class DatasetIndexingEstimateApi(Resource):
  356. @setup_required
  357. @login_required
  358. @account_initialization_required
  359. def post(self):
  360. parser = reqparse.RequestParser()
  361. parser.add_argument("info_list", type=dict, required=True, nullable=True, location="json")
  362. parser.add_argument("process_rule", type=dict, required=True, nullable=True, location="json")
  363. parser.add_argument(
  364. "indexing_technique",
  365. type=str,
  366. required=True,
  367. choices=Dataset.INDEXING_TECHNIQUE_LIST,
  368. nullable=True,
  369. location="json",
  370. )
  371. parser.add_argument("doc_form", type=str, default="text_model", required=False, nullable=False, location="json")
  372. parser.add_argument("dataset_id", type=str, required=False, nullable=False, location="json")
  373. parser.add_argument(
  374. "doc_language", type=str, default="English", required=False, nullable=False, location="json"
  375. )
  376. args = parser.parse_args()
  377. # validate args
  378. DocumentService.estimate_args_validate(args)
  379. extract_settings = []
  380. if args["info_list"]["data_source_type"] == "upload_file":
  381. file_ids = args["info_list"]["file_info_list"]["file_ids"]
  382. file_details = (
  383. db.session.query(UploadFile)
  384. .filter(UploadFile.tenant_id == current_user.current_tenant_id, UploadFile.id.in_(file_ids))
  385. .all()
  386. )
  387. if file_details is None:
  388. raise NotFound("File not found.")
  389. if file_details:
  390. for file_detail in file_details:
  391. extract_setting = ExtractSetting(
  392. datasource_type="upload_file", upload_file=file_detail, document_model=args["doc_form"]
  393. )
  394. extract_settings.append(extract_setting)
  395. elif args["info_list"]["data_source_type"] == "notion_import":
  396. notion_info_list = args["info_list"]["notion_info_list"]
  397. for notion_info in notion_info_list:
  398. workspace_id = notion_info["workspace_id"]
  399. for page in notion_info["pages"]:
  400. extract_setting = ExtractSetting(
  401. datasource_type="notion_import",
  402. notion_info={
  403. "notion_workspace_id": workspace_id,
  404. "notion_obj_id": page["page_id"],
  405. "notion_page_type": page["type"],
  406. "tenant_id": current_user.current_tenant_id,
  407. },
  408. document_model=args["doc_form"],
  409. )
  410. extract_settings.append(extract_setting)
  411. elif args["info_list"]["data_source_type"] == "website_crawl":
  412. website_info_list = args["info_list"]["website_info_list"]
  413. for url in website_info_list["urls"]:
  414. extract_setting = ExtractSetting(
  415. datasource_type="website_crawl",
  416. website_info={
  417. "provider": website_info_list["provider"],
  418. "job_id": website_info_list["job_id"],
  419. "url": url,
  420. "tenant_id": current_user.current_tenant_id,
  421. "mode": "crawl",
  422. "only_main_content": website_info_list["only_main_content"],
  423. },
  424. document_model=args["doc_form"],
  425. )
  426. extract_settings.append(extract_setting)
  427. else:
  428. raise ValueError("Data source type not support")
  429. indexing_runner = IndexingRunner()
  430. try:
  431. response = indexing_runner.indexing_estimate(
  432. current_user.current_tenant_id,
  433. extract_settings,
  434. args["process_rule"],
  435. args["doc_form"],
  436. args["doc_language"],
  437. args["dataset_id"],
  438. args["indexing_technique"],
  439. )
  440. except LLMBadRequestError:
  441. raise ProviderNotInitializeError(
  442. "No Embedding Model available. Please configure a valid provider in the Settings -> Model Provider."
  443. )
  444. except ProviderTokenNotInitError as ex:
  445. raise ProviderNotInitializeError(ex.description)
  446. except Exception as e:
  447. raise IndexingEstimateError(str(e))
  448. return response.model_dump(), 200
  449. class DatasetRelatedAppListApi(Resource):
  450. @setup_required
  451. @login_required
  452. @account_initialization_required
  453. @marshal_with(related_app_list)
  454. def get(self, dataset_id):
  455. dataset_id_str = str(dataset_id)
  456. dataset = DatasetService.get_dataset(dataset_id_str)
  457. if dataset is None:
  458. raise NotFound("Dataset not found.")
  459. try:
  460. DatasetService.check_dataset_permission(dataset, current_user)
  461. except services.errors.account.NoPermissionError as e:
  462. raise Forbidden(str(e))
  463. app_dataset_joins = DatasetService.get_related_apps(dataset.id)
  464. related_apps = []
  465. for app_dataset_join in app_dataset_joins:
  466. app_model = app_dataset_join.app
  467. if app_model:
  468. related_apps.append(app_model)
  469. return {"data": related_apps, "total": len(related_apps)}, 200
  470. class DatasetIndexingStatusApi(Resource):
  471. @setup_required
  472. @login_required
  473. @account_initialization_required
  474. def get(self, dataset_id):
  475. dataset_id = str(dataset_id)
  476. documents = (
  477. db.session.query(Document)
  478. .filter(Document.dataset_id == dataset_id, Document.tenant_id == current_user.current_tenant_id)
  479. .all()
  480. )
  481. documents_status = []
  482. for document in documents:
  483. completed_segments = DocumentSegment.query.filter(
  484. DocumentSegment.completed_at.isnot(None),
  485. DocumentSegment.document_id == str(document.id),
  486. DocumentSegment.status != "re_segment",
  487. ).count()
  488. total_segments = DocumentSegment.query.filter(
  489. DocumentSegment.document_id == str(document.id), DocumentSegment.status != "re_segment"
  490. ).count()
  491. document.completed_segments = completed_segments
  492. document.total_segments = total_segments
  493. documents_status.append(marshal(document, document_status_fields))
  494. data = {"data": documents_status}
  495. return data
  496. class DatasetApiKeyApi(Resource):
  497. max_keys = 10
  498. token_prefix = "dataset-"
  499. resource_type = "dataset"
  500. @setup_required
  501. @login_required
  502. @account_initialization_required
  503. @marshal_with(api_key_list)
  504. def get(self):
  505. keys = (
  506. db.session.query(ApiToken)
  507. .filter(ApiToken.type == self.resource_type, ApiToken.tenant_id == current_user.current_tenant_id)
  508. .all()
  509. )
  510. return {"items": keys}
  511. @setup_required
  512. @login_required
  513. @account_initialization_required
  514. @marshal_with(api_key_fields)
  515. def post(self):
  516. # The role of the current user in the ta table must be admin or owner
  517. if not current_user.is_admin_or_owner:
  518. raise Forbidden()
  519. current_key_count = (
  520. db.session.query(ApiToken)
  521. .filter(ApiToken.type == self.resource_type, ApiToken.tenant_id == current_user.current_tenant_id)
  522. .count()
  523. )
  524. if current_key_count >= self.max_keys:
  525. flask_restful.abort(
  526. 400,
  527. message=f"Cannot create more than {self.max_keys} API keys for this resource type.",
  528. code="max_keys_exceeded",
  529. )
  530. key = ApiToken.generate_api_key(self.token_prefix, 24)
  531. api_token = ApiToken()
  532. api_token.tenant_id = current_user.current_tenant_id
  533. api_token.token = key
  534. api_token.type = self.resource_type
  535. db.session.add(api_token)
  536. db.session.commit()
  537. return api_token, 200
  538. class DatasetApiDeleteApi(Resource):
  539. resource_type = "dataset"
  540. @setup_required
  541. @login_required
  542. @account_initialization_required
  543. def delete(self, api_key_id):
  544. api_key_id = str(api_key_id)
  545. # The role of the current user in the ta table must be admin or owner
  546. if not current_user.is_admin_or_owner:
  547. raise Forbidden()
  548. key = (
  549. db.session.query(ApiToken)
  550. .filter(
  551. ApiToken.tenant_id == current_user.current_tenant_id,
  552. ApiToken.type == self.resource_type,
  553. ApiToken.id == api_key_id,
  554. )
  555. .first()
  556. )
  557. if key is None:
  558. flask_restful.abort(404, message="API key not found")
  559. db.session.query(ApiToken).filter(ApiToken.id == api_key_id).delete()
  560. db.session.commit()
  561. return {"result": "success"}, 204
  562. class DatasetApiBaseUrlApi(Resource):
  563. @setup_required
  564. @login_required
  565. @account_initialization_required
  566. def get(self):
  567. return {"api_base_url": (dify_config.SERVICE_API_URL or request.host_url.rstrip("/")) + "/v1"}
  568. class DatasetRetrievalSettingApi(Resource):
  569. @setup_required
  570. @login_required
  571. @account_initialization_required
  572. def get(self):
  573. vector_type = dify_config.VECTOR_STORE
  574. match vector_type:
  575. case (
  576. VectorType.RELYT
  577. | VectorType.TIDB_VECTOR
  578. | VectorType.CHROMA
  579. | VectorType.TENCENT
  580. | VectorType.PGVECTO_RS
  581. | VectorType.BAIDU
  582. | VectorType.VIKINGDB
  583. | VectorType.UPSTASH
  584. ):
  585. return {"retrieval_method": [RetrievalMethod.SEMANTIC_SEARCH.value]}
  586. case (
  587. VectorType.QDRANT
  588. | VectorType.WEAVIATE
  589. | VectorType.OPENSEARCH
  590. | VectorType.ANALYTICDB
  591. | VectorType.MYSCALE
  592. | VectorType.ORACLE
  593. | VectorType.ELASTICSEARCH
  594. | VectorType.ELASTICSEARCH_JA
  595. | VectorType.PGVECTOR
  596. | VectorType.TIDB_ON_QDRANT
  597. | VectorType.LINDORM
  598. | VectorType.COUCHBASE
  599. | VectorType.MILVUS
  600. | VectorType.OPENGAUSS
  601. | VectorType.OCEANBASE
  602. ):
  603. return {
  604. "retrieval_method": [
  605. RetrievalMethod.SEMANTIC_SEARCH.value,
  606. RetrievalMethod.FULL_TEXT_SEARCH.value,
  607. RetrievalMethod.HYBRID_SEARCH.value,
  608. ]
  609. }
  610. case _:
  611. raise ValueError(f"Unsupported vector db type {vector_type}.")
  612. class DatasetRetrievalSettingMockApi(Resource):
  613. @setup_required
  614. @login_required
  615. @account_initialization_required
  616. def get(self, vector_type):
  617. match vector_type:
  618. case (
  619. VectorType.MILVUS
  620. | VectorType.RELYT
  621. | VectorType.TIDB_VECTOR
  622. | VectorType.CHROMA
  623. | VectorType.TENCENT
  624. | VectorType.PGVECTO_RS
  625. | VectorType.BAIDU
  626. | VectorType.VIKINGDB
  627. | VectorType.UPSTASH
  628. ):
  629. return {"retrieval_method": [RetrievalMethod.SEMANTIC_SEARCH.value]}
  630. case (
  631. VectorType.QDRANT
  632. | VectorType.WEAVIATE
  633. | VectorType.OPENSEARCH
  634. | VectorType.ANALYTICDB
  635. | VectorType.MYSCALE
  636. | VectorType.ORACLE
  637. | VectorType.ELASTICSEARCH
  638. | VectorType.ELASTICSEARCH_JA
  639. | VectorType.COUCHBASE
  640. | VectorType.PGVECTOR
  641. | VectorType.LINDORM
  642. | VectorType.OPENGAUSS
  643. | VectorType.OCEANBASE
  644. ):
  645. return {
  646. "retrieval_method": [
  647. RetrievalMethod.SEMANTIC_SEARCH.value,
  648. RetrievalMethod.FULL_TEXT_SEARCH.value,
  649. RetrievalMethod.HYBRID_SEARCH.value,
  650. ]
  651. }
  652. case _:
  653. raise ValueError(f"Unsupported vector db type {vector_type}.")
  654. class DatasetErrorDocs(Resource):
  655. @setup_required
  656. @login_required
  657. @account_initialization_required
  658. def get(self, dataset_id):
  659. dataset_id_str = str(dataset_id)
  660. dataset = DatasetService.get_dataset(dataset_id_str)
  661. if dataset is None:
  662. raise NotFound("Dataset not found.")
  663. results = DocumentService.get_error_documents_by_dataset_id(dataset_id_str)
  664. return {"data": [marshal(item, document_status_fields) for item in results], "total": len(results)}, 200
  665. class DatasetPermissionUserListApi(Resource):
  666. @setup_required
  667. @login_required
  668. @account_initialization_required
  669. def get(self, dataset_id):
  670. dataset_id_str = str(dataset_id)
  671. dataset = DatasetService.get_dataset(dataset_id_str)
  672. if dataset is None:
  673. raise NotFound("Dataset not found.")
  674. try:
  675. DatasetService.check_dataset_permission(dataset, current_user)
  676. except services.errors.account.NoPermissionError as e:
  677. raise Forbidden(str(e))
  678. partial_members_list = DatasetPermissionService.get_dataset_partial_member_list(dataset_id_str)
  679. return {
  680. "data": partial_members_list,
  681. }, 200
  682. class DatasetAutoDisableLogApi(Resource):
  683. @setup_required
  684. @login_required
  685. @account_initialization_required
  686. def get(self, dataset_id):
  687. dataset_id_str = str(dataset_id)
  688. dataset = DatasetService.get_dataset(dataset_id_str)
  689. if dataset is None:
  690. raise NotFound("Dataset not found.")
  691. return DatasetService.get_dataset_auto_disable_logs(dataset_id_str), 200
  692. class DatasetCountApi(Resource):
  693. @setup_required
  694. @login_required
  695. @account_initialization_required
  696. def get(self):
  697. # tenant_id = current_user.current_tenant_id
  698. tenant_id = request.args.get("tenant_id", default=None, type=str)
  699. datasets_count = DatasetService.get_datasets_count(tenant_id, current_user)
  700. tags_count = DatasetService.get_tags_count(tenant_id)
  701. response = {"datasets_count": datasets_count, "tags_count": tags_count, "depts_count": 0}
  702. return {"data": response}, 200
  703. class DatasetUpdateStatsApi(Resource):
  704. @setup_required
  705. @login_required
  706. @account_initialization_required
  707. def get(self):
  708. """Get dataset update statistics."""
  709. tenant_id = request.args.get("tenant_id", default=None, type=str)
  710. stats = DatasetService.get_dataset_update_stats(tenant_id)
  711. # 转换为前端需要的格式
  712. response = {
  713. "data": [
  714. {"period": "半年以上", "count": stats["over_180_days"]},
  715. {"period": "半年以内", "count": stats["within_180_days"]},
  716. {"period": "90天内", "count": stats["within_90_days"]},
  717. {"period": "30天内", "count": stats["within_30_days"]},
  718. {"period": "7天内", "count": stats["within_7_days"]},
  719. {"period": "3天内", "count": stats["within_3_days"]},
  720. ]
  721. }
  722. return response, 200
  723. class DatasetTypeStatsApi(Resource):
  724. @setup_required
  725. @login_required
  726. @account_initialization_required
  727. def get(self):
  728. tenant_id = current_user.current_tenant_id
  729. response = DatasetService.get_dataset_type_stats(tenant_id)
  730. return {"data": response}, 200
  731. api.add_resource(DatasetListApi, "/datasets")
  732. api.add_resource(DatasetApi, "/datasets/<uuid:dataset_id>")
  733. api.add_resource(DatasetUseCheckApi, "/datasets/<uuid:dataset_id>/use-check")
  734. api.add_resource(DatasetQueryApi, "/datasets/<uuid:dataset_id>/queries")
  735. api.add_resource(DatasetErrorDocs, "/datasets/<uuid:dataset_id>/error-docs")
  736. api.add_resource(DatasetIndexingEstimateApi, "/datasets/indexing-estimate")
  737. api.add_resource(DatasetRelatedAppListApi, "/datasets/<uuid:dataset_id>/related-apps")
  738. api.add_resource(DatasetIndexingStatusApi, "/datasets/<uuid:dataset_id>/indexing-status")
  739. api.add_resource(DatasetApiKeyApi, "/datasets/api-keys")
  740. api.add_resource(DatasetApiDeleteApi, "/datasets/api-keys/<uuid:api_key_id>")
  741. api.add_resource(DatasetApiBaseUrlApi, "/datasets/api-base-info")
  742. api.add_resource(DatasetRetrievalSettingApi, "/datasets/retrieval-setting")
  743. api.add_resource(DatasetRetrievalSettingMockApi, "/datasets/retrieval-setting/<string:vector_type>")
  744. api.add_resource(DatasetPermissionUserListApi, "/datasets/<uuid:dataset_id>/permission-part-users")
  745. api.add_resource(DatasetAutoDisableLogApi, "/datasets/<uuid:dataset_id>/auto-disable-logs")
  746. api.add_resource(DatasetCountApi, "/datasets/count")
  747. api.add_resource(DatasetUpdateStatsApi, "/datasets/update-stats")
  748. api.add_resource(DatasetTypeStatsApi, "/datasets/type-stats")