datasets.py 30 KB

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