Nevar pievienot vairāk kā 25 tēmas Tēmai ir jāsākas ar burtu vai ciparu, tā var saturēt domu zīmes ('-') un var būt līdz 35 simboliem gara.

workflow.py 31KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868
  1. import json
  2. import logging
  3. from collections.abc import Sequence
  4. from typing import cast
  5. from flask import abort, request
  6. from flask_restx import Resource, inputs, marshal_with, reqparse
  7. from sqlalchemy.orm import Session
  8. from werkzeug.exceptions import Forbidden, InternalServerError, NotFound
  9. import services
  10. from configs import dify_config
  11. from controllers.console import api
  12. from controllers.console.app.error import (
  13. ConversationCompletedError,
  14. DraftWorkflowNotExist,
  15. DraftWorkflowNotSync,
  16. )
  17. from controllers.console.app.wraps import get_app_model
  18. from controllers.console.wraps import account_initialization_required, setup_required
  19. from controllers.web.error import InvokeRateLimitError as InvokeRateLimitHttpError
  20. from core.app.app_config.features.file_upload.manager import FileUploadConfigManager
  21. from core.app.apps.base_app_queue_manager import AppQueueManager
  22. from core.app.entities.app_invoke_entities import InvokeFrom
  23. from core.file.models import File
  24. from core.helper.trace_id_helper import get_external_trace_id
  25. from extensions.ext_database import db
  26. from factories import file_factory, variable_factory
  27. from fields.workflow_fields import workflow_fields, workflow_pagination_fields
  28. from fields.workflow_run_fields import workflow_run_node_execution_fields
  29. from libs import helper
  30. from libs.helper import TimestampField, uuid_value
  31. from libs.login import current_user, login_required
  32. from models import App
  33. from models.account import Account
  34. from models.model import AppMode
  35. from models.workflow import Workflow
  36. from services.app_generate_service import AppGenerateService
  37. from services.errors.app import WorkflowHashNotEqualError
  38. from services.errors.llm import InvokeRateLimitError
  39. from services.workflow_service import DraftWorkflowDeletionError, WorkflowInUseError, WorkflowService
  40. logger = logging.getLogger(__name__)
  41. # TODO(QuantumGhost): Refactor existing node run API to handle file parameter parsing
  42. # at the controller level rather than in the workflow logic. This would improve separation
  43. # of concerns and make the code more maintainable.
  44. def _parse_file(workflow: Workflow, files: list[dict] | None = None) -> Sequence[File]:
  45. files = files or []
  46. file_extra_config = FileUploadConfigManager.convert(workflow.features_dict, is_vision=False)
  47. file_objs: Sequence[File] = []
  48. if file_extra_config is None:
  49. return file_objs
  50. file_objs = file_factory.build_from_mappings(
  51. mappings=files,
  52. tenant_id=workflow.tenant_id,
  53. config=file_extra_config,
  54. )
  55. return file_objs
  56. class DraftWorkflowApi(Resource):
  57. @setup_required
  58. @login_required
  59. @account_initialization_required
  60. @get_app_model(mode=[AppMode.ADVANCED_CHAT, AppMode.WORKFLOW])
  61. @marshal_with(workflow_fields)
  62. def get(self, app_model: App):
  63. """
  64. Get draft workflow
  65. """
  66. # The role of the current user in the ta table must be admin, owner, or editor
  67. if not current_user.is_editor:
  68. raise Forbidden()
  69. # fetch draft workflow by app_model
  70. workflow_service = WorkflowService()
  71. workflow = workflow_service.get_draft_workflow(app_model=app_model)
  72. if not workflow:
  73. raise DraftWorkflowNotExist()
  74. # return workflow, if not found, return None (initiate graph by frontend)
  75. return workflow
  76. @setup_required
  77. @login_required
  78. @account_initialization_required
  79. @get_app_model(mode=[AppMode.ADVANCED_CHAT, AppMode.WORKFLOW])
  80. def post(self, app_model: App):
  81. """
  82. Sync draft workflow
  83. """
  84. # The role of the current user in the ta table must be admin, owner, or editor
  85. if not current_user.is_editor:
  86. raise Forbidden()
  87. content_type = request.headers.get("Content-Type", "")
  88. if "application/json" in content_type:
  89. parser = reqparse.RequestParser()
  90. parser.add_argument("graph", type=dict, required=True, nullable=False, location="json")
  91. parser.add_argument("features", type=dict, required=True, nullable=False, location="json")
  92. parser.add_argument("hash", type=str, required=False, location="json")
  93. parser.add_argument("environment_variables", type=list, required=True, location="json")
  94. parser.add_argument("conversation_variables", type=list, required=False, location="json")
  95. args = parser.parse_args()
  96. elif "text/plain" in content_type:
  97. try:
  98. data = json.loads(request.data.decode("utf-8"))
  99. if "graph" not in data or "features" not in data:
  100. raise ValueError("graph or features not found in data")
  101. if not isinstance(data.get("graph"), dict) or not isinstance(data.get("features"), dict):
  102. raise ValueError("graph or features is not a dict")
  103. args = {
  104. "graph": data.get("graph"),
  105. "features": data.get("features"),
  106. "hash": data.get("hash"),
  107. "environment_variables": data.get("environment_variables"),
  108. "conversation_variables": data.get("conversation_variables"),
  109. }
  110. except json.JSONDecodeError:
  111. return {"message": "Invalid JSON data"}, 400
  112. else:
  113. abort(415)
  114. if not isinstance(current_user, Account):
  115. raise Forbidden()
  116. workflow_service = WorkflowService()
  117. try:
  118. environment_variables_list = args.get("environment_variables") or []
  119. environment_variables = [
  120. variable_factory.build_environment_variable_from_mapping(obj) for obj in environment_variables_list
  121. ]
  122. conversation_variables_list = args.get("conversation_variables") or []
  123. conversation_variables = [
  124. variable_factory.build_conversation_variable_from_mapping(obj) for obj in conversation_variables_list
  125. ]
  126. workflow = workflow_service.sync_draft_workflow(
  127. app_model=app_model,
  128. graph=args["graph"],
  129. features=args["features"],
  130. unique_hash=args.get("hash"),
  131. account=current_user,
  132. environment_variables=environment_variables,
  133. conversation_variables=conversation_variables,
  134. )
  135. except WorkflowHashNotEqualError:
  136. raise DraftWorkflowNotSync()
  137. return {
  138. "result": "success",
  139. "hash": workflow.unique_hash,
  140. "updated_at": TimestampField().format(workflow.updated_at or workflow.created_at),
  141. }
  142. class AdvancedChatDraftWorkflowRunApi(Resource):
  143. @setup_required
  144. @login_required
  145. @account_initialization_required
  146. @get_app_model(mode=[AppMode.ADVANCED_CHAT])
  147. def post(self, app_model: App):
  148. """
  149. Run draft workflow
  150. """
  151. # The role of the current user in the ta table must be admin, owner, or editor
  152. if not current_user.is_editor:
  153. raise Forbidden()
  154. if not isinstance(current_user, Account):
  155. raise Forbidden()
  156. parser = reqparse.RequestParser()
  157. parser.add_argument("inputs", type=dict, location="json")
  158. parser.add_argument("query", type=str, required=True, location="json", default="")
  159. parser.add_argument("files", type=list, location="json")
  160. parser.add_argument("conversation_id", type=uuid_value, location="json")
  161. parser.add_argument("parent_message_id", type=uuid_value, required=False, location="json")
  162. args = parser.parse_args()
  163. external_trace_id = get_external_trace_id(request)
  164. if external_trace_id:
  165. args["external_trace_id"] = external_trace_id
  166. try:
  167. response = AppGenerateService.generate(
  168. app_model=app_model, user=current_user, args=args, invoke_from=InvokeFrom.DEBUGGER, streaming=True
  169. )
  170. return helper.compact_generate_response(response)
  171. except services.errors.conversation.ConversationNotExistsError:
  172. raise NotFound("Conversation Not Exists.")
  173. except services.errors.conversation.ConversationCompletedError:
  174. raise ConversationCompletedError()
  175. except InvokeRateLimitError as ex:
  176. raise InvokeRateLimitHttpError(ex.description)
  177. except ValueError as e:
  178. raise e
  179. except Exception:
  180. logging.exception("internal server error.")
  181. raise InternalServerError()
  182. class AdvancedChatDraftRunIterationNodeApi(Resource):
  183. @setup_required
  184. @login_required
  185. @account_initialization_required
  186. @get_app_model(mode=[AppMode.ADVANCED_CHAT])
  187. def post(self, app_model: App, node_id: str):
  188. """
  189. Run draft workflow iteration node
  190. """
  191. # The role of the current user in the ta table must be admin, owner, or editor
  192. if not current_user.is_editor:
  193. raise Forbidden()
  194. if not isinstance(current_user, Account):
  195. raise Forbidden()
  196. parser = reqparse.RequestParser()
  197. parser.add_argument("inputs", type=dict, location="json")
  198. args = parser.parse_args()
  199. try:
  200. response = AppGenerateService.generate_single_iteration(
  201. app_model=app_model, user=current_user, node_id=node_id, args=args, streaming=True
  202. )
  203. return helper.compact_generate_response(response)
  204. except services.errors.conversation.ConversationNotExistsError:
  205. raise NotFound("Conversation Not Exists.")
  206. except services.errors.conversation.ConversationCompletedError:
  207. raise ConversationCompletedError()
  208. except ValueError as e:
  209. raise e
  210. except Exception:
  211. logging.exception("internal server error.")
  212. raise InternalServerError()
  213. class WorkflowDraftRunIterationNodeApi(Resource):
  214. @setup_required
  215. @login_required
  216. @account_initialization_required
  217. @get_app_model(mode=[AppMode.WORKFLOW])
  218. def post(self, app_model: App, node_id: str):
  219. """
  220. Run draft workflow iteration node
  221. """
  222. # The role of the current user in the ta table must be admin, owner, or editor
  223. if not current_user.is_editor:
  224. raise Forbidden()
  225. if not isinstance(current_user, Account):
  226. raise Forbidden()
  227. parser = reqparse.RequestParser()
  228. parser.add_argument("inputs", type=dict, location="json")
  229. args = parser.parse_args()
  230. try:
  231. response = AppGenerateService.generate_single_iteration(
  232. app_model=app_model, user=current_user, node_id=node_id, args=args, streaming=True
  233. )
  234. return helper.compact_generate_response(response)
  235. except services.errors.conversation.ConversationNotExistsError:
  236. raise NotFound("Conversation Not Exists.")
  237. except services.errors.conversation.ConversationCompletedError:
  238. raise ConversationCompletedError()
  239. except ValueError as e:
  240. raise e
  241. except Exception:
  242. logging.exception("internal server error.")
  243. raise InternalServerError()
  244. class AdvancedChatDraftRunLoopNodeApi(Resource):
  245. @setup_required
  246. @login_required
  247. @account_initialization_required
  248. @get_app_model(mode=[AppMode.ADVANCED_CHAT])
  249. def post(self, app_model: App, node_id: str):
  250. """
  251. Run draft workflow loop node
  252. """
  253. # The role of the current user in the ta table must be admin, owner, or editor
  254. if not current_user.is_editor:
  255. raise Forbidden()
  256. if not isinstance(current_user, Account):
  257. raise Forbidden()
  258. parser = reqparse.RequestParser()
  259. parser.add_argument("inputs", type=dict, location="json")
  260. args = parser.parse_args()
  261. try:
  262. response = AppGenerateService.generate_single_loop(
  263. app_model=app_model, user=current_user, node_id=node_id, args=args, streaming=True
  264. )
  265. return helper.compact_generate_response(response)
  266. except services.errors.conversation.ConversationNotExistsError:
  267. raise NotFound("Conversation Not Exists.")
  268. except services.errors.conversation.ConversationCompletedError:
  269. raise ConversationCompletedError()
  270. except ValueError as e:
  271. raise e
  272. except Exception:
  273. logging.exception("internal server error.")
  274. raise InternalServerError()
  275. class WorkflowDraftRunLoopNodeApi(Resource):
  276. @setup_required
  277. @login_required
  278. @account_initialization_required
  279. @get_app_model(mode=[AppMode.WORKFLOW])
  280. def post(self, app_model: App, node_id: str):
  281. """
  282. Run draft workflow loop node
  283. """
  284. # The role of the current user in the ta table must be admin, owner, or editor
  285. if not current_user.is_editor:
  286. raise Forbidden()
  287. if not isinstance(current_user, Account):
  288. raise Forbidden()
  289. parser = reqparse.RequestParser()
  290. parser.add_argument("inputs", type=dict, location="json")
  291. args = parser.parse_args()
  292. try:
  293. response = AppGenerateService.generate_single_loop(
  294. app_model=app_model, user=current_user, node_id=node_id, args=args, streaming=True
  295. )
  296. return helper.compact_generate_response(response)
  297. except services.errors.conversation.ConversationNotExistsError:
  298. raise NotFound("Conversation Not Exists.")
  299. except services.errors.conversation.ConversationCompletedError:
  300. raise ConversationCompletedError()
  301. except ValueError as e:
  302. raise e
  303. except Exception:
  304. logging.exception("internal server error.")
  305. raise InternalServerError()
  306. class DraftWorkflowRunApi(Resource):
  307. @setup_required
  308. @login_required
  309. @account_initialization_required
  310. @get_app_model(mode=[AppMode.WORKFLOW])
  311. def post(self, app_model: App):
  312. """
  313. Run draft workflow
  314. """
  315. # The role of the current user in the ta table must be admin, owner, or editor
  316. if not current_user.is_editor:
  317. raise Forbidden()
  318. if not isinstance(current_user, Account):
  319. raise Forbidden()
  320. parser = reqparse.RequestParser()
  321. parser.add_argument("inputs", type=dict, required=True, nullable=False, location="json")
  322. parser.add_argument("files", type=list, required=False, location="json")
  323. args = parser.parse_args()
  324. external_trace_id = get_external_trace_id(request)
  325. if external_trace_id:
  326. args["external_trace_id"] = external_trace_id
  327. try:
  328. response = AppGenerateService.generate(
  329. app_model=app_model,
  330. user=current_user,
  331. args=args,
  332. invoke_from=InvokeFrom.DEBUGGER,
  333. streaming=True,
  334. )
  335. return helper.compact_generate_response(response)
  336. except InvokeRateLimitError as ex:
  337. raise InvokeRateLimitHttpError(ex.description)
  338. class WorkflowTaskStopApi(Resource):
  339. @setup_required
  340. @login_required
  341. @account_initialization_required
  342. @get_app_model(mode=[AppMode.ADVANCED_CHAT, AppMode.WORKFLOW])
  343. def post(self, app_model: App, task_id: str):
  344. """
  345. Stop workflow task
  346. """
  347. # The role of the current user in the ta table must be admin, owner, or editor
  348. if not current_user.is_editor:
  349. raise Forbidden()
  350. AppQueueManager.set_stop_flag(task_id, InvokeFrom.DEBUGGER, current_user.id)
  351. return {"result": "success"}
  352. class DraftWorkflowNodeRunApi(Resource):
  353. @setup_required
  354. @login_required
  355. @account_initialization_required
  356. @get_app_model(mode=[AppMode.ADVANCED_CHAT, AppMode.WORKFLOW])
  357. @marshal_with(workflow_run_node_execution_fields)
  358. def post(self, app_model: App, node_id: str):
  359. """
  360. Run draft workflow node
  361. """
  362. # The role of the current user in the ta table must be admin, owner, or editor
  363. if not current_user.is_editor:
  364. raise Forbidden()
  365. if not isinstance(current_user, Account):
  366. raise Forbidden()
  367. parser = reqparse.RequestParser()
  368. parser.add_argument("inputs", type=dict, required=True, nullable=False, location="json")
  369. parser.add_argument("query", type=str, required=False, location="json", default="")
  370. parser.add_argument("files", type=list, location="json", default=[])
  371. args = parser.parse_args()
  372. user_inputs = args.get("inputs")
  373. if user_inputs is None:
  374. raise ValueError("missing inputs")
  375. workflow_srv = WorkflowService()
  376. # fetch draft workflow by app_model
  377. draft_workflow = workflow_srv.get_draft_workflow(app_model=app_model)
  378. if not draft_workflow:
  379. raise ValueError("Workflow not initialized")
  380. files = _parse_file(draft_workflow, args.get("files"))
  381. workflow_service = WorkflowService()
  382. workflow_node_execution = workflow_service.run_draft_workflow_node(
  383. app_model=app_model,
  384. draft_workflow=draft_workflow,
  385. node_id=node_id,
  386. user_inputs=user_inputs,
  387. account=current_user,
  388. query=args.get("query", ""),
  389. files=files,
  390. )
  391. return workflow_node_execution
  392. class PublishedWorkflowApi(Resource):
  393. @setup_required
  394. @login_required
  395. @account_initialization_required
  396. @get_app_model(mode=[AppMode.ADVANCED_CHAT, AppMode.WORKFLOW])
  397. @marshal_with(workflow_fields)
  398. def get(self, app_model: App):
  399. """
  400. Get published workflow
  401. """
  402. # The role of the current user in the ta table must be admin, owner, or editor
  403. if not current_user.is_editor:
  404. raise Forbidden()
  405. # fetch published workflow by app_model
  406. workflow_service = WorkflowService()
  407. workflow = workflow_service.get_published_workflow(app_model=app_model)
  408. # return workflow, if not found, return None
  409. return workflow
  410. @setup_required
  411. @login_required
  412. @account_initialization_required
  413. @get_app_model(mode=[AppMode.ADVANCED_CHAT, AppMode.WORKFLOW])
  414. def post(self, app_model: App):
  415. """
  416. Publish workflow
  417. """
  418. # The role of the current user in the ta table must be admin, owner, or editor
  419. if not current_user.is_editor:
  420. raise Forbidden()
  421. if not isinstance(current_user, Account):
  422. raise Forbidden()
  423. parser = reqparse.RequestParser()
  424. parser.add_argument("marked_name", type=str, required=False, default="", location="json")
  425. parser.add_argument("marked_comment", type=str, required=False, default="", location="json")
  426. args = parser.parse_args()
  427. # Validate name and comment length
  428. if args.marked_name and len(args.marked_name) > 20:
  429. raise ValueError("Marked name cannot exceed 20 characters")
  430. if args.marked_comment and len(args.marked_comment) > 100:
  431. raise ValueError("Marked comment cannot exceed 100 characters")
  432. workflow_service = WorkflowService()
  433. with Session(db.engine) as session:
  434. workflow = workflow_service.publish_workflow(
  435. session=session,
  436. app_model=app_model,
  437. account=current_user,
  438. marked_name=args.marked_name or "",
  439. marked_comment=args.marked_comment or "",
  440. )
  441. app_model.workflow_id = workflow.id
  442. db.session.commit()
  443. workflow_created_at = TimestampField().format(workflow.created_at)
  444. session.commit()
  445. return {
  446. "result": "success",
  447. "created_at": workflow_created_at,
  448. }
  449. class DefaultBlockConfigsApi(Resource):
  450. @setup_required
  451. @login_required
  452. @account_initialization_required
  453. @get_app_model(mode=[AppMode.ADVANCED_CHAT, AppMode.WORKFLOW])
  454. def get(self, app_model: App):
  455. """
  456. Get default block config
  457. """
  458. # The role of the current user in the ta table must be admin, owner, or editor
  459. if not current_user.is_editor:
  460. raise Forbidden()
  461. # Get default block configs
  462. workflow_service = WorkflowService()
  463. return workflow_service.get_default_block_configs()
  464. class DefaultBlockConfigApi(Resource):
  465. @setup_required
  466. @login_required
  467. @account_initialization_required
  468. @get_app_model(mode=[AppMode.ADVANCED_CHAT, AppMode.WORKFLOW])
  469. def get(self, app_model: App, block_type: str):
  470. """
  471. Get default block config
  472. """
  473. # The role of the current user in the ta table must be admin, owner, or editor
  474. if not current_user.is_editor:
  475. raise Forbidden()
  476. if not isinstance(current_user, Account):
  477. raise Forbidden()
  478. parser = reqparse.RequestParser()
  479. parser.add_argument("q", type=str, location="args")
  480. args = parser.parse_args()
  481. q = args.get("q")
  482. filters = None
  483. if q:
  484. try:
  485. filters = json.loads(args.get("q", ""))
  486. except json.JSONDecodeError:
  487. raise ValueError("Invalid filters")
  488. # Get default block configs
  489. workflow_service = WorkflowService()
  490. return workflow_service.get_default_block_config(node_type=block_type, filters=filters)
  491. class ConvertToWorkflowApi(Resource):
  492. @setup_required
  493. @login_required
  494. @account_initialization_required
  495. @get_app_model(mode=[AppMode.CHAT, AppMode.COMPLETION])
  496. def post(self, app_model: App):
  497. """
  498. Convert basic mode of chatbot app to workflow mode
  499. Convert expert mode of chatbot app to workflow mode
  500. Convert Completion App to Workflow App
  501. """
  502. # The role of the current user in the ta table must be admin, owner, or editor
  503. if not current_user.is_editor:
  504. raise Forbidden()
  505. if not isinstance(current_user, Account):
  506. raise Forbidden()
  507. if request.data:
  508. parser = reqparse.RequestParser()
  509. parser.add_argument("name", type=str, required=False, nullable=True, location="json")
  510. parser.add_argument("icon_type", type=str, required=False, nullable=True, location="json")
  511. parser.add_argument("icon", type=str, required=False, nullable=True, location="json")
  512. parser.add_argument("icon_background", type=str, required=False, nullable=True, location="json")
  513. args = parser.parse_args()
  514. else:
  515. args = {}
  516. # convert to workflow mode
  517. workflow_service = WorkflowService()
  518. new_app_model = workflow_service.convert_to_workflow(app_model=app_model, account=current_user, args=args)
  519. # return app id
  520. return {
  521. "new_app_id": new_app_model.id,
  522. }
  523. class WorkflowConfigApi(Resource):
  524. """Resource for workflow configuration."""
  525. @setup_required
  526. @login_required
  527. @account_initialization_required
  528. @get_app_model(mode=[AppMode.ADVANCED_CHAT, AppMode.WORKFLOW])
  529. def get(self, app_model: App):
  530. return {
  531. "parallel_depth_limit": dify_config.WORKFLOW_PARALLEL_DEPTH_LIMIT,
  532. }
  533. class PublishedAllWorkflowApi(Resource):
  534. @setup_required
  535. @login_required
  536. @account_initialization_required
  537. @get_app_model(mode=[AppMode.ADVANCED_CHAT, AppMode.WORKFLOW])
  538. @marshal_with(workflow_pagination_fields)
  539. def get(self, app_model: App):
  540. """
  541. Get published workflows
  542. """
  543. if not current_user.is_editor:
  544. raise Forbidden()
  545. parser = reqparse.RequestParser()
  546. parser.add_argument("page", type=inputs.int_range(1, 99999), required=False, default=1, location="args")
  547. parser.add_argument("limit", type=inputs.int_range(1, 100), required=False, default=20, location="args")
  548. parser.add_argument("user_id", type=str, required=False, location="args")
  549. parser.add_argument("named_only", type=inputs.boolean, required=False, default=False, location="args")
  550. args = parser.parse_args()
  551. page = int(args.get("page", 1))
  552. limit = int(args.get("limit", 10))
  553. user_id = args.get("user_id")
  554. named_only = args.get("named_only", False)
  555. if user_id:
  556. if user_id != current_user.id:
  557. raise Forbidden()
  558. user_id = cast(str, user_id)
  559. workflow_service = WorkflowService()
  560. with Session(db.engine) as session:
  561. workflows, has_more = workflow_service.get_all_published_workflow(
  562. session=session,
  563. app_model=app_model,
  564. page=page,
  565. limit=limit,
  566. user_id=user_id,
  567. named_only=named_only,
  568. )
  569. return {
  570. "items": workflows,
  571. "page": page,
  572. "limit": limit,
  573. "has_more": has_more,
  574. }
  575. class WorkflowByIdApi(Resource):
  576. @setup_required
  577. @login_required
  578. @account_initialization_required
  579. @get_app_model(mode=[AppMode.ADVANCED_CHAT, AppMode.WORKFLOW])
  580. @marshal_with(workflow_fields)
  581. def patch(self, app_model: App, workflow_id: str):
  582. """
  583. Update workflow attributes
  584. """
  585. # Check permission
  586. if not current_user.is_editor:
  587. raise Forbidden()
  588. if not isinstance(current_user, Account):
  589. raise Forbidden()
  590. parser = reqparse.RequestParser()
  591. parser.add_argument("marked_name", type=str, required=False, location="json")
  592. parser.add_argument("marked_comment", type=str, required=False, location="json")
  593. args = parser.parse_args()
  594. # Validate name and comment length
  595. if args.marked_name and len(args.marked_name) > 20:
  596. raise ValueError("Marked name cannot exceed 20 characters")
  597. if args.marked_comment and len(args.marked_comment) > 100:
  598. raise ValueError("Marked comment cannot exceed 100 characters")
  599. args = parser.parse_args()
  600. # Prepare update data
  601. update_data = {}
  602. if args.get("marked_name") is not None:
  603. update_data["marked_name"] = args["marked_name"]
  604. if args.get("marked_comment") is not None:
  605. update_data["marked_comment"] = args["marked_comment"]
  606. if not update_data:
  607. return {"message": "No valid fields to update"}, 400
  608. workflow_service = WorkflowService()
  609. # Create a session and manage the transaction
  610. with Session(db.engine, expire_on_commit=False) as session:
  611. workflow = workflow_service.update_workflow(
  612. session=session,
  613. workflow_id=workflow_id,
  614. tenant_id=app_model.tenant_id,
  615. account_id=current_user.id,
  616. data=update_data,
  617. )
  618. if not workflow:
  619. raise NotFound("Workflow not found")
  620. # Commit the transaction in the controller
  621. session.commit()
  622. return workflow
  623. @setup_required
  624. @login_required
  625. @account_initialization_required
  626. @get_app_model(mode=[AppMode.ADVANCED_CHAT, AppMode.WORKFLOW])
  627. def delete(self, app_model: App, workflow_id: str):
  628. """
  629. Delete workflow
  630. """
  631. # Check permission
  632. if not current_user.is_editor:
  633. raise Forbidden()
  634. if not isinstance(current_user, Account):
  635. raise Forbidden()
  636. workflow_service = WorkflowService()
  637. # Create a session and manage the transaction
  638. with Session(db.engine) as session:
  639. try:
  640. workflow_service.delete_workflow(
  641. session=session, workflow_id=workflow_id, tenant_id=app_model.tenant_id
  642. )
  643. # Commit the transaction in the controller
  644. session.commit()
  645. except WorkflowInUseError as e:
  646. abort(400, description=str(e))
  647. except DraftWorkflowDeletionError as e:
  648. abort(400, description=str(e))
  649. except ValueError as e:
  650. raise NotFound(str(e))
  651. return None, 204
  652. class DraftWorkflowNodeLastRunApi(Resource):
  653. @setup_required
  654. @login_required
  655. @account_initialization_required
  656. @get_app_model(mode=[AppMode.ADVANCED_CHAT, AppMode.WORKFLOW])
  657. @marshal_with(workflow_run_node_execution_fields)
  658. def get(self, app_model: App, node_id: str):
  659. srv = WorkflowService()
  660. workflow = srv.get_draft_workflow(app_model)
  661. if not workflow:
  662. raise NotFound("Workflow not found")
  663. node_exec = srv.get_node_last_run(
  664. app_model=app_model,
  665. workflow=workflow,
  666. node_id=node_id,
  667. )
  668. if node_exec is None:
  669. raise NotFound("last run not found")
  670. return node_exec
  671. api.add_resource(
  672. DraftWorkflowApi,
  673. "/apps/<uuid:app_id>/workflows/draft",
  674. )
  675. api.add_resource(
  676. WorkflowConfigApi,
  677. "/apps/<uuid:app_id>/workflows/draft/config",
  678. )
  679. api.add_resource(
  680. AdvancedChatDraftWorkflowRunApi,
  681. "/apps/<uuid:app_id>/advanced-chat/workflows/draft/run",
  682. )
  683. api.add_resource(
  684. DraftWorkflowRunApi,
  685. "/apps/<uuid:app_id>/workflows/draft/run",
  686. )
  687. api.add_resource(
  688. WorkflowTaskStopApi,
  689. "/apps/<uuid:app_id>/workflow-runs/tasks/<string:task_id>/stop",
  690. )
  691. api.add_resource(
  692. DraftWorkflowNodeRunApi,
  693. "/apps/<uuid:app_id>/workflows/draft/nodes/<string:node_id>/run",
  694. )
  695. api.add_resource(
  696. AdvancedChatDraftRunIterationNodeApi,
  697. "/apps/<uuid:app_id>/advanced-chat/workflows/draft/iteration/nodes/<string:node_id>/run",
  698. )
  699. api.add_resource(
  700. WorkflowDraftRunIterationNodeApi,
  701. "/apps/<uuid:app_id>/workflows/draft/iteration/nodes/<string:node_id>/run",
  702. )
  703. api.add_resource(
  704. AdvancedChatDraftRunLoopNodeApi,
  705. "/apps/<uuid:app_id>/advanced-chat/workflows/draft/loop/nodes/<string:node_id>/run",
  706. )
  707. api.add_resource(
  708. WorkflowDraftRunLoopNodeApi,
  709. "/apps/<uuid:app_id>/workflows/draft/loop/nodes/<string:node_id>/run",
  710. )
  711. api.add_resource(
  712. PublishedWorkflowApi,
  713. "/apps/<uuid:app_id>/workflows/publish",
  714. )
  715. api.add_resource(
  716. PublishedAllWorkflowApi,
  717. "/apps/<uuid:app_id>/workflows",
  718. )
  719. api.add_resource(
  720. DefaultBlockConfigsApi,
  721. "/apps/<uuid:app_id>/workflows/default-workflow-block-configs",
  722. )
  723. api.add_resource(
  724. DefaultBlockConfigApi,
  725. "/apps/<uuid:app_id>/workflows/default-workflow-block-configs/<string:block_type>",
  726. )
  727. api.add_resource(
  728. ConvertToWorkflowApi,
  729. "/apps/<uuid:app_id>/convert-to-workflow",
  730. )
  731. api.add_resource(
  732. WorkflowByIdApi,
  733. "/apps/<uuid:app_id>/workflows/<string:workflow_id>",
  734. )
  735. api.add_resource(
  736. DraftWorkflowNodeLastRunApi,
  737. "/apps/<uuid:app_id>/workflows/draft/nodes/<string:node_id>/last-run",
  738. )