model.py 60 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519
  1. import json
  2. import re
  3. import uuid
  4. from enum import Enum
  5. from typing import TYPE_CHECKING, Optional
  6. if TYPE_CHECKING:
  7. from models.workflow import Workflow
  8. from flask import request
  9. from flask_login import UserMixin
  10. from sqlalchemy import Float, Index, PrimaryKeyConstraint, func, text
  11. from sqlalchemy.orm import Mapped, mapped_column
  12. from configs import dify_config
  13. from core.file.tool_file_parser import ToolFileParser
  14. from core.file.upload_file_parser import UploadFileParser
  15. from extensions.ext_database import db
  16. from libs.helper import generate_string
  17. from models.base import Base
  18. from .account import Account, Tenant
  19. from .types import StringUUID
  20. class DifySetup(Base):
  21. __tablename__ = "dify_setups"
  22. __table_args__ = (db.PrimaryKeyConstraint("version", name="dify_setup_pkey"),)
  23. version = db.Column(db.String(255), nullable=False)
  24. setup_at = db.Column(db.DateTime, nullable=False, server_default=db.text("CURRENT_TIMESTAMP(0)"))
  25. class AppMode(Enum):
  26. COMPLETION = "completion"
  27. WORKFLOW = "workflow"
  28. CHAT = "chat"
  29. ADVANCED_CHAT = "advanced-chat"
  30. AGENT_CHAT = "agent-chat"
  31. CHANNEL = "channel"
  32. @classmethod
  33. def value_of(cls, value: str) -> "AppMode":
  34. """
  35. Get value of given mode.
  36. :param value: mode value
  37. :return: mode
  38. """
  39. for mode in cls:
  40. if mode.value == value:
  41. return mode
  42. raise ValueError(f"invalid mode value {value}")
  43. class IconType(Enum):
  44. IMAGE = "image"
  45. EMOJI = "emoji"
  46. class App(Base):
  47. __tablename__ = "apps"
  48. __table_args__ = (db.PrimaryKeyConstraint("id", name="app_pkey"), db.Index("app_tenant_id_idx", "tenant_id"))
  49. id = db.Column(StringUUID, server_default=db.text("uuid_generate_v4()"))
  50. tenant_id = db.Column(StringUUID, nullable=False)
  51. name = db.Column(db.String(255), nullable=False)
  52. description = db.Column(db.Text, nullable=False, server_default=db.text("''::character varying"))
  53. mode = db.Column(db.String(255), nullable=False)
  54. icon_type = db.Column(db.String(255), nullable=True)
  55. icon = db.Column(db.String(255))
  56. icon_background = db.Column(db.String(255))
  57. app_model_config_id = db.Column(StringUUID, nullable=True)
  58. workflow_id = db.Column(StringUUID, nullable=True)
  59. status = db.Column(db.String(255), nullable=False, server_default=db.text("'normal'::character varying"))
  60. enable_site = db.Column(db.Boolean, nullable=False)
  61. enable_api = db.Column(db.Boolean, nullable=False)
  62. api_rpm = db.Column(db.Integer, nullable=False, server_default=db.text("0"))
  63. api_rph = db.Column(db.Integer, nullable=False, server_default=db.text("0"))
  64. is_demo = db.Column(db.Boolean, nullable=False, server_default=db.text("false"))
  65. is_public = db.Column(db.Boolean, nullable=False, server_default=db.text("false"))
  66. is_universal = db.Column(db.Boolean, nullable=False, server_default=db.text("false"))
  67. tracing = db.Column(db.Text, nullable=True)
  68. max_active_requests = db.Column(db.Integer, nullable=True)
  69. created_by = db.Column(StringUUID, nullable=True)
  70. created_at = db.Column(db.DateTime, nullable=False, server_default=db.text("CURRENT_TIMESTAMP(0)"))
  71. updated_by = db.Column(StringUUID, nullable=True)
  72. updated_at = db.Column(db.DateTime, nullable=False, server_default=db.text("CURRENT_TIMESTAMP(0)"))
  73. use_icon_as_answer_icon = db.Column(db.Boolean, nullable=False, server_default=db.text("false"))
  74. @property
  75. def desc_or_prompt(self):
  76. if self.description:
  77. return self.description
  78. else:
  79. app_model_config = self.app_model_config
  80. if app_model_config:
  81. return app_model_config.pre_prompt
  82. else:
  83. return ""
  84. @property
  85. def site(self):
  86. site = db.session.query(Site).filter(Site.app_id == self.id).first()
  87. return site
  88. @property
  89. def app_model_config(self) -> Optional["AppModelConfig"]:
  90. if self.app_model_config_id:
  91. return db.session.query(AppModelConfig).filter(AppModelConfig.id == self.app_model_config_id).first()
  92. return None
  93. @property
  94. def workflow(self) -> Optional["Workflow"]:
  95. if self.workflow_id:
  96. from .workflow import Workflow
  97. return db.session.query(Workflow).filter(Workflow.id == self.workflow_id).first()
  98. return None
  99. @property
  100. def api_base_url(self):
  101. return (dify_config.SERVICE_API_URL or request.host_url.rstrip("/")) + "/v1"
  102. @property
  103. def tenant(self):
  104. tenant = db.session.query(Tenant).filter(Tenant.id == self.tenant_id).first()
  105. return tenant
  106. @property
  107. def is_agent(self) -> bool:
  108. app_model_config = self.app_model_config
  109. if not app_model_config:
  110. return False
  111. if not app_model_config.agent_mode:
  112. return False
  113. if app_model_config.agent_mode_dict.get("enabled", False) and app_model_config.agent_mode_dict.get(
  114. "strategy", ""
  115. ) in {"function_call", "react"}:
  116. self.mode = AppMode.AGENT_CHAT.value
  117. db.session.commit()
  118. return True
  119. return False
  120. @property
  121. def mode_compatible_with_agent(self) -> str:
  122. if self.mode == AppMode.CHAT.value and self.is_agent:
  123. return AppMode.AGENT_CHAT.value
  124. return self.mode
  125. @property
  126. def deleted_tools(self) -> list:
  127. # get agent mode tools
  128. app_model_config = self.app_model_config
  129. if not app_model_config:
  130. return []
  131. if not app_model_config.agent_mode:
  132. return []
  133. agent_mode = app_model_config.agent_mode_dict
  134. tools = agent_mode.get("tools", [])
  135. provider_ids = []
  136. for tool in tools:
  137. keys = list(tool.keys())
  138. if len(keys) >= 4:
  139. provider_type = tool.get("provider_type", "")
  140. provider_id = tool.get("provider_id", "")
  141. if provider_type == "api":
  142. # check if provider id is a uuid string, if not, skip
  143. try:
  144. uuid.UUID(provider_id)
  145. except Exception:
  146. continue
  147. provider_ids.append(provider_id)
  148. if not provider_ids:
  149. return []
  150. api_providers = db.session.execute(
  151. text("SELECT id FROM tool_api_providers WHERE id IN :provider_ids"), {"provider_ids": tuple(provider_ids)}
  152. ).fetchall()
  153. deleted_tools = []
  154. current_api_provider_ids = [str(api_provider.id) for api_provider in api_providers]
  155. for tool in tools:
  156. keys = list(tool.keys())
  157. if len(keys) >= 4:
  158. provider_type = tool.get("provider_type", "")
  159. provider_id = tool.get("provider_id", "")
  160. if provider_type == "api" and provider_id not in current_api_provider_ids:
  161. deleted_tools.append(tool["tool_name"])
  162. return deleted_tools
  163. @property
  164. def tags(self):
  165. tags = (
  166. db.session.query(Tag)
  167. .join(TagBinding, Tag.id == TagBinding.tag_id)
  168. .filter(
  169. TagBinding.target_id == self.id,
  170. TagBinding.tenant_id == self.tenant_id,
  171. Tag.tenant_id == self.tenant_id,
  172. Tag.type == "app",
  173. )
  174. .all()
  175. )
  176. return tags or []
  177. class AppModelConfig(Base):
  178. __tablename__ = "app_model_configs"
  179. __table_args__ = (db.PrimaryKeyConstraint("id", name="app_model_config_pkey"), db.Index("app_app_id_idx", "app_id"))
  180. id = db.Column(StringUUID, server_default=db.text("uuid_generate_v4()"))
  181. app_id = db.Column(StringUUID, nullable=False)
  182. provider = db.Column(db.String(255), nullable=True)
  183. model_id = db.Column(db.String(255), nullable=True)
  184. configs = db.Column(db.JSON, nullable=True)
  185. created_by = db.Column(StringUUID, nullable=True)
  186. created_at = db.Column(db.DateTime, nullable=False, server_default=db.text("CURRENT_TIMESTAMP(0)"))
  187. updated_by = db.Column(StringUUID, nullable=True)
  188. updated_at = db.Column(db.DateTime, nullable=False, server_default=db.text("CURRENT_TIMESTAMP(0)"))
  189. opening_statement = db.Column(db.Text)
  190. suggested_questions = db.Column(db.Text)
  191. suggested_questions_after_answer = db.Column(db.Text)
  192. speech_to_text = db.Column(db.Text)
  193. text_to_speech = db.Column(db.Text)
  194. more_like_this = db.Column(db.Text)
  195. model = db.Column(db.Text)
  196. user_input_form = db.Column(db.Text)
  197. dataset_query_variable = db.Column(db.String(255))
  198. pre_prompt = db.Column(db.Text)
  199. agent_mode = db.Column(db.Text)
  200. sensitive_word_avoidance = db.Column(db.Text)
  201. retriever_resource = db.Column(db.Text)
  202. prompt_type = db.Column(db.String(255), nullable=False, server_default=db.text("'simple'::character varying"))
  203. chat_prompt_config = db.Column(db.Text)
  204. completion_prompt_config = db.Column(db.Text)
  205. dataset_configs = db.Column(db.Text)
  206. external_data_tools = db.Column(db.Text)
  207. file_upload = db.Column(db.Text)
  208. @property
  209. def app(self):
  210. app = db.session.query(App).filter(App.id == self.app_id).first()
  211. return app
  212. @property
  213. def model_dict(self):
  214. return json.loads(self.model) if self.model else None
  215. @property
  216. def suggested_questions_list(self) -> list:
  217. return json.loads(self.suggested_questions) if self.suggested_questions else []
  218. @property
  219. def suggested_questions_after_answer_dict(self) -> dict:
  220. return (
  221. json.loads(self.suggested_questions_after_answer)
  222. if self.suggested_questions_after_answer
  223. else {"enabled": False}
  224. )
  225. @property
  226. def speech_to_text_dict(self) -> dict:
  227. return json.loads(self.speech_to_text) if self.speech_to_text else {"enabled": False}
  228. @property
  229. def text_to_speech_dict(self) -> dict:
  230. return json.loads(self.text_to_speech) if self.text_to_speech else {"enabled": False}
  231. @property
  232. def retriever_resource_dict(self) -> dict:
  233. return json.loads(self.retriever_resource) if self.retriever_resource else {"enabled": True}
  234. @property
  235. def annotation_reply_dict(self) -> dict:
  236. annotation_setting = (
  237. db.session.query(AppAnnotationSetting).filter(AppAnnotationSetting.app_id == self.app_id).first()
  238. )
  239. if annotation_setting:
  240. collection_binding_detail = annotation_setting.collection_binding_detail
  241. if not collection_binding_detail:
  242. raise ValueError("Collection binding detail not found")
  243. return {
  244. "id": annotation_setting.id,
  245. "enabled": True,
  246. "score_threshold": annotation_setting.score_threshold,
  247. "embedding_model": {
  248. "embedding_provider_name": collection_binding_detail.provider_name,
  249. "embedding_model_name": collection_binding_detail.model_name,
  250. },
  251. }
  252. else:
  253. return {"enabled": False}
  254. @property
  255. def more_like_this_dict(self) -> dict:
  256. return json.loads(self.more_like_this) if self.more_like_this else {"enabled": False}
  257. @property
  258. def sensitive_word_avoidance_dict(self) -> dict:
  259. return (
  260. json.loads(self.sensitive_word_avoidance)
  261. if self.sensitive_word_avoidance
  262. else {"enabled": False, "type": "", "configs": []}
  263. )
  264. @property
  265. def external_data_tools_list(self) -> list[dict]:
  266. return json.loads(self.external_data_tools) if self.external_data_tools else []
  267. @property
  268. def user_input_form_list(self):
  269. return json.loads(self.user_input_form) if self.user_input_form else []
  270. @property
  271. def agent_mode_dict(self) -> dict:
  272. return (
  273. json.loads(self.agent_mode)
  274. if self.agent_mode
  275. else {"enabled": False, "strategy": None, "tools": [], "prompt": None}
  276. )
  277. @property
  278. def chat_prompt_config_dict(self) -> dict:
  279. return json.loads(self.chat_prompt_config) if self.chat_prompt_config else {}
  280. @property
  281. def completion_prompt_config_dict(self) -> dict:
  282. return json.loads(self.completion_prompt_config) if self.completion_prompt_config else {}
  283. @property
  284. def dataset_configs_dict(self) -> dict:
  285. if self.dataset_configs:
  286. dataset_configs = json.loads(self.dataset_configs)
  287. if "retrieval_model" not in dataset_configs:
  288. return {"retrieval_model": "single"}
  289. else:
  290. return dataset_configs
  291. return {
  292. "retrieval_model": "multiple",
  293. }
  294. @property
  295. def file_upload_dict(self) -> dict:
  296. return (
  297. json.loads(self.file_upload)
  298. if self.file_upload
  299. else {
  300. "image": {
  301. "enabled": False,
  302. "number_limits": 3,
  303. "detail": "high",
  304. "transfer_methods": ["remote_url", "local_file"],
  305. }
  306. }
  307. )
  308. def to_dict(self) -> dict:
  309. return {
  310. "opening_statement": self.opening_statement,
  311. "suggested_questions": self.suggested_questions_list,
  312. "suggested_questions_after_answer": self.suggested_questions_after_answer_dict,
  313. "speech_to_text": self.speech_to_text_dict,
  314. "text_to_speech": self.text_to_speech_dict,
  315. "retriever_resource": self.retriever_resource_dict,
  316. "annotation_reply": self.annotation_reply_dict,
  317. "more_like_this": self.more_like_this_dict,
  318. "sensitive_word_avoidance": self.sensitive_word_avoidance_dict,
  319. "external_data_tools": self.external_data_tools_list,
  320. "model": self.model_dict,
  321. "user_input_form": self.user_input_form_list,
  322. "dataset_query_variable": self.dataset_query_variable,
  323. "pre_prompt": self.pre_prompt,
  324. "agent_mode": self.agent_mode_dict,
  325. "prompt_type": self.prompt_type,
  326. "chat_prompt_config": self.chat_prompt_config_dict,
  327. "completion_prompt_config": self.completion_prompt_config_dict,
  328. "dataset_configs": self.dataset_configs_dict,
  329. "file_upload": self.file_upload_dict,
  330. }
  331. def from_model_config_dict(self, model_config: dict):
  332. self.opening_statement = model_config.get("opening_statement")
  333. self.suggested_questions = (
  334. json.dumps(model_config["suggested_questions"]) if model_config.get("suggested_questions") else None
  335. )
  336. self.suggested_questions_after_answer = (
  337. json.dumps(model_config["suggested_questions_after_answer"])
  338. if model_config.get("suggested_questions_after_answer")
  339. else None
  340. )
  341. self.speech_to_text = json.dumps(model_config["speech_to_text"]) if model_config.get("speech_to_text") else None
  342. self.text_to_speech = json.dumps(model_config["text_to_speech"]) if model_config.get("text_to_speech") else None
  343. self.more_like_this = json.dumps(model_config["more_like_this"]) if model_config.get("more_like_this") else None
  344. self.sensitive_word_avoidance = (
  345. json.dumps(model_config["sensitive_word_avoidance"])
  346. if model_config.get("sensitive_word_avoidance")
  347. else None
  348. )
  349. self.external_data_tools = (
  350. json.dumps(model_config["external_data_tools"]) if model_config.get("external_data_tools") else None
  351. )
  352. self.model = json.dumps(model_config["model"]) if model_config.get("model") else None
  353. self.user_input_form = (
  354. json.dumps(model_config["user_input_form"]) if model_config.get("user_input_form") else None
  355. )
  356. self.dataset_query_variable = model_config.get("dataset_query_variable")
  357. self.pre_prompt = model_config["pre_prompt"]
  358. self.agent_mode = json.dumps(model_config["agent_mode"]) if model_config.get("agent_mode") else None
  359. self.retriever_resource = (
  360. json.dumps(model_config["retriever_resource"]) if model_config.get("retriever_resource") else None
  361. )
  362. self.prompt_type = model_config.get("prompt_type", "simple")
  363. self.chat_prompt_config = (
  364. json.dumps(model_config.get("chat_prompt_config")) if model_config.get("chat_prompt_config") else None
  365. )
  366. self.completion_prompt_config = (
  367. json.dumps(model_config.get("completion_prompt_config"))
  368. if model_config.get("completion_prompt_config")
  369. else None
  370. )
  371. self.dataset_configs = (
  372. json.dumps(model_config.get("dataset_configs")) if model_config.get("dataset_configs") else None
  373. )
  374. self.file_upload = json.dumps(model_config.get("file_upload")) if model_config.get("file_upload") else None
  375. return self
  376. def copy(self):
  377. new_app_model_config = AppModelConfig(
  378. id=self.id,
  379. app_id=self.app_id,
  380. opening_statement=self.opening_statement,
  381. suggested_questions=self.suggested_questions,
  382. suggested_questions_after_answer=self.suggested_questions_after_answer,
  383. speech_to_text=self.speech_to_text,
  384. text_to_speech=self.text_to_speech,
  385. more_like_this=self.more_like_this,
  386. sensitive_word_avoidance=self.sensitive_word_avoidance,
  387. external_data_tools=self.external_data_tools,
  388. model=self.model,
  389. user_input_form=self.user_input_form,
  390. dataset_query_variable=self.dataset_query_variable,
  391. pre_prompt=self.pre_prompt,
  392. agent_mode=self.agent_mode,
  393. retriever_resource=self.retriever_resource,
  394. prompt_type=self.prompt_type,
  395. chat_prompt_config=self.chat_prompt_config,
  396. completion_prompt_config=self.completion_prompt_config,
  397. dataset_configs=self.dataset_configs,
  398. file_upload=self.file_upload,
  399. )
  400. return new_app_model_config
  401. class RecommendedApp(Base):
  402. __tablename__ = "recommended_apps"
  403. __table_args__ = (
  404. db.PrimaryKeyConstraint("id", name="recommended_app_pkey"),
  405. db.Index("recommended_app_app_id_idx", "app_id"),
  406. db.Index("recommended_app_is_listed_idx", "is_listed", "language"),
  407. )
  408. id = db.Column(StringUUID, primary_key=True, server_default=db.text("uuid_generate_v4()"))
  409. app_id = db.Column(StringUUID, nullable=False)
  410. description = db.Column(db.JSON, nullable=False)
  411. copyright = db.Column(db.String(255), nullable=False)
  412. privacy_policy = db.Column(db.String(255), nullable=False)
  413. custom_disclaimer = db.Column(db.String(255), nullable=True)
  414. category = db.Column(db.String(255), nullable=False)
  415. position = db.Column(db.Integer, nullable=False, default=0)
  416. is_listed = db.Column(db.Boolean, nullable=False, default=True)
  417. install_count = db.Column(db.Integer, nullable=False, default=0)
  418. language = db.Column(db.String(255), nullable=False, server_default=db.text("'en-US'::character varying"))
  419. created_at = db.Column(db.DateTime, nullable=False, server_default=db.text("CURRENT_TIMESTAMP(0)"))
  420. updated_at = db.Column(db.DateTime, nullable=False, server_default=db.text("CURRENT_TIMESTAMP(0)"))
  421. @property
  422. def app(self):
  423. app = db.session.query(App).filter(App.id == self.app_id).first()
  424. return app
  425. class InstalledApp(Base):
  426. __tablename__ = "installed_apps"
  427. __table_args__ = (
  428. db.PrimaryKeyConstraint("id", name="installed_app_pkey"),
  429. db.Index("installed_app_tenant_id_idx", "tenant_id"),
  430. db.Index("installed_app_app_id_idx", "app_id"),
  431. db.UniqueConstraint("tenant_id", "app_id", name="unique_tenant_app"),
  432. )
  433. id = db.Column(StringUUID, server_default=db.text("uuid_generate_v4()"))
  434. tenant_id = db.Column(StringUUID, nullable=False)
  435. app_id = db.Column(StringUUID, nullable=False)
  436. app_owner_tenant_id = db.Column(StringUUID, nullable=False)
  437. position = db.Column(db.Integer, nullable=False, default=0)
  438. is_pinned = db.Column(db.Boolean, nullable=False, server_default=db.text("false"))
  439. last_used_at = db.Column(db.DateTime, nullable=True)
  440. created_at = db.Column(db.DateTime, nullable=False, server_default=db.text("CURRENT_TIMESTAMP(0)"))
  441. @property
  442. def app(self):
  443. app = db.session.query(App).filter(App.id == self.app_id).first()
  444. return app
  445. @property
  446. def tenant(self):
  447. tenant = db.session.query(Tenant).filter(Tenant.id == self.tenant_id).first()
  448. return tenant
  449. class Conversation(Base):
  450. __tablename__ = "conversations"
  451. __table_args__ = (
  452. db.PrimaryKeyConstraint("id", name="conversation_pkey"),
  453. db.Index("conversation_app_from_user_idx", "app_id", "from_source", "from_end_user_id"),
  454. )
  455. id = db.Column(StringUUID, server_default=db.text("uuid_generate_v4()"))
  456. app_id = db.Column(StringUUID, nullable=False)
  457. app_model_config_id = db.Column(StringUUID, nullable=True)
  458. model_provider = db.Column(db.String(255), nullable=True)
  459. override_model_configs = db.Column(db.Text)
  460. model_id = db.Column(db.String(255), nullable=True)
  461. mode = db.Column(db.String(255), nullable=False)
  462. name = db.Column(db.String(255), nullable=False)
  463. summary = db.Column(db.Text)
  464. inputs = db.Column(db.JSON)
  465. introduction = db.Column(db.Text)
  466. system_instruction = db.Column(db.Text)
  467. system_instruction_tokens = db.Column(db.Integer, nullable=False, server_default=db.text("0"))
  468. status = db.Column(db.String(255), nullable=False)
  469. invoke_from = db.Column(db.String(255), nullable=True)
  470. from_source = db.Column(db.String(255), nullable=False)
  471. from_end_user_id = db.Column(StringUUID)
  472. from_account_id = db.Column(StringUUID)
  473. read_at = db.Column(db.DateTime)
  474. read_account_id = db.Column(StringUUID)
  475. dialogue_count: Mapped[int] = mapped_column(default=0)
  476. created_at = db.Column(db.DateTime, nullable=False, server_default=db.text("CURRENT_TIMESTAMP(0)"))
  477. updated_at = db.Column(db.DateTime, nullable=False, server_default=db.text("CURRENT_TIMESTAMP(0)"))
  478. messages = db.relationship("Message", backref="conversation", lazy="select", passive_deletes="all")
  479. message_annotations = db.relationship(
  480. "MessageAnnotation", backref="conversation", lazy="select", passive_deletes="all"
  481. )
  482. is_deleted = db.Column(db.Boolean, nullable=False, server_default=db.text("false"))
  483. @property
  484. def model_config(self):
  485. model_config = {}
  486. if self.mode == AppMode.ADVANCED_CHAT.value:
  487. if self.override_model_configs:
  488. override_model_configs = json.loads(self.override_model_configs)
  489. model_config = override_model_configs
  490. else:
  491. if self.override_model_configs:
  492. override_model_configs = json.loads(self.override_model_configs)
  493. if "model" in override_model_configs:
  494. app_model_config = AppModelConfig()
  495. app_model_config = app_model_config.from_model_config_dict(override_model_configs)
  496. model_config = app_model_config.to_dict()
  497. else:
  498. model_config["configs"] = override_model_configs
  499. else:
  500. app_model_config = (
  501. db.session.query(AppModelConfig).filter(AppModelConfig.id == self.app_model_config_id).first()
  502. )
  503. if not app_model_config:
  504. return {}
  505. model_config = app_model_config.to_dict()
  506. model_config["model_id"] = self.model_id
  507. model_config["provider"] = self.model_provider
  508. return model_config
  509. @property
  510. def summary_or_query(self):
  511. if self.summary:
  512. return self.summary
  513. else:
  514. first_message = self.first_message
  515. if first_message:
  516. return first_message.query
  517. else:
  518. return ""
  519. @property
  520. def annotated(self):
  521. return db.session.query(MessageAnnotation).filter(MessageAnnotation.conversation_id == self.id).count() > 0
  522. @property
  523. def annotation(self):
  524. return db.session.query(MessageAnnotation).filter(MessageAnnotation.conversation_id == self.id).first()
  525. @property
  526. def message_count(self):
  527. return db.session.query(Message).filter(Message.conversation_id == self.id).count()
  528. @property
  529. def user_feedback_stats(self):
  530. like = (
  531. db.session.query(MessageFeedback)
  532. .filter(
  533. MessageFeedback.conversation_id == self.id,
  534. MessageFeedback.from_source == "user",
  535. MessageFeedback.rating == "like",
  536. )
  537. .count()
  538. )
  539. dislike = (
  540. db.session.query(MessageFeedback)
  541. .filter(
  542. MessageFeedback.conversation_id == self.id,
  543. MessageFeedback.from_source == "user",
  544. MessageFeedback.rating == "dislike",
  545. )
  546. .count()
  547. )
  548. return {"like": like, "dislike": dislike}
  549. @property
  550. def admin_feedback_stats(self):
  551. like = (
  552. db.session.query(MessageFeedback)
  553. .filter(
  554. MessageFeedback.conversation_id == self.id,
  555. MessageFeedback.from_source == "admin",
  556. MessageFeedback.rating == "like",
  557. )
  558. .count()
  559. )
  560. dislike = (
  561. db.session.query(MessageFeedback)
  562. .filter(
  563. MessageFeedback.conversation_id == self.id,
  564. MessageFeedback.from_source == "admin",
  565. MessageFeedback.rating == "dislike",
  566. )
  567. .count()
  568. )
  569. return {"like": like, "dislike": dislike}
  570. @property
  571. def first_message(self):
  572. return db.session.query(Message).filter(Message.conversation_id == self.id).first()
  573. @property
  574. def app(self):
  575. return db.session.query(App).filter(App.id == self.app_id).first()
  576. @property
  577. def from_end_user_session_id(self):
  578. if self.from_end_user_id:
  579. end_user = db.session.query(EndUser).filter(EndUser.id == self.from_end_user_id).first()
  580. if end_user:
  581. return end_user.session_id
  582. return None
  583. @property
  584. def from_account_name(self):
  585. if self.from_account_id:
  586. account = db.session.query(Account).filter(Account.id == self.from_account_id).first()
  587. if account:
  588. return account.name
  589. return None
  590. @property
  591. def in_debug_mode(self):
  592. return self.override_model_configs is not None
  593. class Message(Base):
  594. __tablename__ = "messages"
  595. __table_args__ = (
  596. PrimaryKeyConstraint("id", name="message_pkey"),
  597. Index("message_app_id_idx", "app_id", "created_at"),
  598. Index("message_conversation_id_idx", "conversation_id"),
  599. Index("message_end_user_idx", "app_id", "from_source", "from_end_user_id"),
  600. Index("message_account_idx", "app_id", "from_source", "from_account_id"),
  601. Index("message_workflow_run_id_idx", "conversation_id", "workflow_run_id"),
  602. )
  603. id = db.Column(StringUUID, server_default=db.text("uuid_generate_v4()"))
  604. app_id = db.Column(StringUUID, nullable=False)
  605. model_provider = db.Column(db.String(255), nullable=True)
  606. model_id = db.Column(db.String(255), nullable=True)
  607. override_model_configs = db.Column(db.Text)
  608. conversation_id = db.Column(StringUUID, db.ForeignKey("conversations.id"), nullable=False)
  609. inputs = db.Column(db.JSON)
  610. query = db.Column(db.Text, nullable=False)
  611. message = db.Column(db.JSON, nullable=False)
  612. message_tokens = db.Column(db.Integer, nullable=False, server_default=db.text("0"))
  613. message_unit_price = db.Column(db.Numeric(10, 4), nullable=False)
  614. message_price_unit = db.Column(db.Numeric(10, 7), nullable=False, server_default=db.text("0.001"))
  615. answer = db.Column(db.Text, nullable=False)
  616. answer_tokens = db.Column(db.Integer, nullable=False, server_default=db.text("0"))
  617. answer_unit_price = db.Column(db.Numeric(10, 4), nullable=False)
  618. answer_price_unit = db.Column(db.Numeric(10, 7), nullable=False, server_default=db.text("0.001"))
  619. parent_message_id = db.Column(StringUUID, nullable=True)
  620. provider_response_latency = db.Column(db.Float, nullable=False, server_default=db.text("0"))
  621. total_price = db.Column(db.Numeric(10, 7))
  622. currency = db.Column(db.String(255), nullable=False)
  623. status = db.Column(db.String(255), nullable=False, server_default=db.text("'normal'::character varying"))
  624. error = db.Column(db.Text)
  625. message_metadata = db.Column(db.Text)
  626. invoke_from = db.Column(db.String(255), nullable=True)
  627. from_source = db.Column(db.String(255), nullable=False)
  628. from_end_user_id = db.Column(StringUUID)
  629. from_account_id = db.Column(StringUUID)
  630. created_at = db.Column(db.DateTime, nullable=False, server_default=db.text("CURRENT_TIMESTAMP(0)"))
  631. updated_at = db.Column(db.DateTime, nullable=False, server_default=db.text("CURRENT_TIMESTAMP(0)"))
  632. agent_based = db.Column(db.Boolean, nullable=False, server_default=db.text("false"))
  633. workflow_run_id = db.Column(StringUUID)
  634. @property
  635. def re_sign_file_url_answer(self) -> str:
  636. if not self.answer:
  637. return self.answer
  638. pattern = r"\[!?.*?\]\((((http|https):\/\/.+)?\/files\/(tools\/)?[\w-]+.*?timestamp=.*&nonce=.*&sign=.*)\)"
  639. matches = re.findall(pattern, self.answer)
  640. if not matches:
  641. return self.answer
  642. urls = [match[0] for match in matches]
  643. # remove duplicate urls
  644. urls = list(set(urls))
  645. if not urls:
  646. return self.answer
  647. re_sign_file_url_answer = self.answer
  648. for url in urls:
  649. if "files/tools" in url:
  650. # get tool file id
  651. tool_file_id_pattern = r"\/files\/tools\/([\.\w-]+)?\?timestamp="
  652. result = re.search(tool_file_id_pattern, url)
  653. if not result:
  654. continue
  655. tool_file_id = result.group(1)
  656. # get extension
  657. if "." in tool_file_id:
  658. split_result = tool_file_id.split(".")
  659. extension = f".{split_result[-1]}"
  660. if len(extension) > 10:
  661. extension = ".bin"
  662. tool_file_id = split_result[0]
  663. else:
  664. extension = ".bin"
  665. if not tool_file_id:
  666. continue
  667. sign_url = ToolFileParser.get_tool_file_manager().sign_file(
  668. tool_file_id=tool_file_id, extension=extension
  669. )
  670. else:
  671. # get upload file id
  672. upload_file_id_pattern = r"\/files\/([\w-]+)\/image-preview?\?timestamp="
  673. result = re.search(upload_file_id_pattern, url)
  674. if not result:
  675. continue
  676. upload_file_id = result.group(1)
  677. if not upload_file_id:
  678. continue
  679. sign_url = UploadFileParser.get_signed_temp_image_url(upload_file_id)
  680. re_sign_file_url_answer = re_sign_file_url_answer.replace(url, sign_url)
  681. return re_sign_file_url_answer
  682. @property
  683. def user_feedback(self):
  684. feedback = (
  685. db.session.query(MessageFeedback)
  686. .filter(MessageFeedback.message_id == self.id, MessageFeedback.from_source == "user")
  687. .first()
  688. )
  689. return feedback
  690. @property
  691. def admin_feedback(self):
  692. feedback = (
  693. db.session.query(MessageFeedback)
  694. .filter(MessageFeedback.message_id == self.id, MessageFeedback.from_source == "admin")
  695. .first()
  696. )
  697. return feedback
  698. @property
  699. def feedbacks(self):
  700. feedbacks = db.session.query(MessageFeedback).filter(MessageFeedback.message_id == self.id).all()
  701. return feedbacks
  702. @property
  703. def annotation(self):
  704. annotation = db.session.query(MessageAnnotation).filter(MessageAnnotation.message_id == self.id).first()
  705. return annotation
  706. @property
  707. def annotation_hit_history(self):
  708. annotation_history = (
  709. db.session.query(AppAnnotationHitHistory).filter(AppAnnotationHitHistory.message_id == self.id).first()
  710. )
  711. if annotation_history:
  712. annotation = (
  713. db.session.query(MessageAnnotation)
  714. .filter(MessageAnnotation.id == annotation_history.annotation_id)
  715. .first()
  716. )
  717. return annotation
  718. return None
  719. @property
  720. def app_model_config(self):
  721. conversation = db.session.query(Conversation).filter(Conversation.id == self.conversation_id).first()
  722. if conversation:
  723. return (
  724. db.session.query(AppModelConfig).filter(AppModelConfig.id == conversation.app_model_config_id).first()
  725. )
  726. return None
  727. @property
  728. def in_debug_mode(self):
  729. return self.override_model_configs is not None
  730. @property
  731. def message_metadata_dict(self) -> dict:
  732. return json.loads(self.message_metadata) if self.message_metadata else {}
  733. @property
  734. def agent_thoughts(self):
  735. return (
  736. db.session.query(MessageAgentThought)
  737. .filter(MessageAgentThought.message_id == self.id)
  738. .order_by(MessageAgentThought.position.asc())
  739. .all()
  740. )
  741. @property
  742. def retriever_resources(self):
  743. return (
  744. db.session.query(DatasetRetrieverResource)
  745. .filter(DatasetRetrieverResource.message_id == self.id)
  746. .order_by(DatasetRetrieverResource.position.asc())
  747. .all()
  748. )
  749. @property
  750. def message_files(self):
  751. return db.session.query(MessageFile).filter(MessageFile.message_id == self.id).all()
  752. @property
  753. def files(self):
  754. message_files = self.message_files
  755. files = []
  756. for message_file in message_files:
  757. url = message_file.url
  758. if message_file.type == "image":
  759. if message_file.transfer_method == "local_file":
  760. upload_file = (
  761. db.session.query(UploadFile).filter(UploadFile.id == message_file.upload_file_id).first()
  762. )
  763. url = UploadFileParser.get_image_data(upload_file=upload_file, force_url=True)
  764. if message_file.transfer_method == "tool_file":
  765. # get tool file id
  766. tool_file_id = message_file.url.split("/")[-1]
  767. # trim extension
  768. tool_file_id = tool_file_id.split(".")[0]
  769. # get extension
  770. if "." in message_file.url:
  771. extension = f'.{message_file.url.split(".")[-1]}'
  772. if len(extension) > 10:
  773. extension = ".bin"
  774. else:
  775. extension = ".bin"
  776. # add sign url
  777. url = ToolFileParser.get_tool_file_manager().sign_file(
  778. tool_file_id=tool_file_id, extension=extension
  779. )
  780. files.append(
  781. {
  782. "id": message_file.id,
  783. "type": message_file.type,
  784. "url": url,
  785. "belongs_to": message_file.belongs_to or "user",
  786. }
  787. )
  788. return files
  789. @property
  790. def workflow_run(self):
  791. if self.workflow_run_id:
  792. from .workflow import WorkflowRun
  793. return db.session.query(WorkflowRun).filter(WorkflowRun.id == self.workflow_run_id).first()
  794. return None
  795. def to_dict(self) -> dict:
  796. return {
  797. "id": self.id,
  798. "app_id": self.app_id,
  799. "conversation_id": self.conversation_id,
  800. "inputs": self.inputs,
  801. "query": self.query,
  802. "message": self.message,
  803. "answer": self.answer,
  804. "status": self.status,
  805. "error": self.error,
  806. "message_metadata": self.message_metadata_dict,
  807. "from_source": self.from_source,
  808. "from_end_user_id": self.from_end_user_id,
  809. "from_account_id": self.from_account_id,
  810. "created_at": self.created_at.isoformat(),
  811. "updated_at": self.updated_at.isoformat(),
  812. "agent_based": self.agent_based,
  813. "workflow_run_id": self.workflow_run_id,
  814. }
  815. @classmethod
  816. def from_dict(cls, data: dict):
  817. return cls(
  818. id=data["id"],
  819. app_id=data["app_id"],
  820. conversation_id=data["conversation_id"],
  821. inputs=data["inputs"],
  822. query=data["query"],
  823. message=data["message"],
  824. answer=data["answer"],
  825. status=data["status"],
  826. error=data["error"],
  827. message_metadata=json.dumps(data["message_metadata"]),
  828. from_source=data["from_source"],
  829. from_end_user_id=data["from_end_user_id"],
  830. from_account_id=data["from_account_id"],
  831. created_at=data["created_at"],
  832. updated_at=data["updated_at"],
  833. agent_based=data["agent_based"],
  834. workflow_run_id=data["workflow_run_id"],
  835. )
  836. class MessageFeedback(Base):
  837. __tablename__ = "message_feedbacks"
  838. __table_args__ = (
  839. db.PrimaryKeyConstraint("id", name="message_feedback_pkey"),
  840. db.Index("message_feedback_app_idx", "app_id"),
  841. db.Index("message_feedback_message_idx", "message_id", "from_source"),
  842. db.Index("message_feedback_conversation_idx", "conversation_id", "from_source", "rating"),
  843. )
  844. id = db.Column(StringUUID, server_default=db.text("uuid_generate_v4()"))
  845. app_id = db.Column(StringUUID, nullable=False)
  846. conversation_id = db.Column(StringUUID, nullable=False)
  847. message_id = db.Column(StringUUID, nullable=False)
  848. rating = db.Column(db.String(255), nullable=False)
  849. content = db.Column(db.Text)
  850. from_source = db.Column(db.String(255), nullable=False)
  851. from_end_user_id = db.Column(StringUUID)
  852. from_account_id = db.Column(StringUUID)
  853. created_at = db.Column(db.DateTime, nullable=False, server_default=db.text("CURRENT_TIMESTAMP(0)"))
  854. updated_at = db.Column(db.DateTime, nullable=False, server_default=db.text("CURRENT_TIMESTAMP(0)"))
  855. @property
  856. def from_account(self):
  857. account = db.session.query(Account).filter(Account.id == self.from_account_id).first()
  858. return account
  859. class MessageFile(Base):
  860. __tablename__ = "message_files"
  861. __table_args__ = (
  862. db.PrimaryKeyConstraint("id", name="message_file_pkey"),
  863. db.Index("message_file_message_idx", "message_id"),
  864. db.Index("message_file_created_by_idx", "created_by"),
  865. )
  866. id = db.Column(StringUUID, server_default=db.text("uuid_generate_v4()"))
  867. message_id = db.Column(StringUUID, nullable=False)
  868. type = db.Column(db.String(255), nullable=False)
  869. transfer_method = db.Column(db.String(255), nullable=False)
  870. url = db.Column(db.Text, nullable=True)
  871. belongs_to = db.Column(db.String(255), nullable=True)
  872. upload_file_id = db.Column(StringUUID, nullable=True)
  873. created_by_role = db.Column(db.String(255), nullable=False)
  874. created_by = db.Column(StringUUID, nullable=False)
  875. created_at = db.Column(db.DateTime, nullable=False, server_default=db.text("CURRENT_TIMESTAMP(0)"))
  876. class MessageAnnotation(Base):
  877. __tablename__ = "message_annotations"
  878. __table_args__ = (
  879. db.PrimaryKeyConstraint("id", name="message_annotation_pkey"),
  880. db.Index("message_annotation_app_idx", "app_id"),
  881. db.Index("message_annotation_conversation_idx", "conversation_id"),
  882. db.Index("message_annotation_message_idx", "message_id"),
  883. )
  884. id = db.Column(StringUUID, server_default=db.text("uuid_generate_v4()"))
  885. app_id = db.Column(StringUUID, nullable=False)
  886. conversation_id = db.Column(StringUUID, db.ForeignKey("conversations.id"), nullable=True)
  887. message_id = db.Column(StringUUID, nullable=True)
  888. question = db.Column(db.Text, nullable=True)
  889. content = db.Column(db.Text, nullable=False)
  890. hit_count = db.Column(db.Integer, nullable=False, server_default=db.text("0"))
  891. account_id = db.Column(StringUUID, nullable=False)
  892. created_at = db.Column(db.DateTime, nullable=False, server_default=db.text("CURRENT_TIMESTAMP(0)"))
  893. updated_at = db.Column(db.DateTime, nullable=False, server_default=db.text("CURRENT_TIMESTAMP(0)"))
  894. @property
  895. def account(self):
  896. account = db.session.query(Account).filter(Account.id == self.account_id).first()
  897. return account
  898. @property
  899. def annotation_create_account(self):
  900. account = db.session.query(Account).filter(Account.id == self.account_id).first()
  901. return account
  902. class AppAnnotationHitHistory(Base):
  903. __tablename__ = "app_annotation_hit_histories"
  904. __table_args__ = (
  905. db.PrimaryKeyConstraint("id", name="app_annotation_hit_histories_pkey"),
  906. db.Index("app_annotation_hit_histories_app_idx", "app_id"),
  907. db.Index("app_annotation_hit_histories_account_idx", "account_id"),
  908. db.Index("app_annotation_hit_histories_annotation_idx", "annotation_id"),
  909. db.Index("app_annotation_hit_histories_message_idx", "message_id"),
  910. )
  911. id = db.Column(StringUUID, server_default=db.text("uuid_generate_v4()"))
  912. app_id = db.Column(StringUUID, nullable=False)
  913. annotation_id = db.Column(StringUUID, nullable=False)
  914. source = db.Column(db.Text, nullable=False)
  915. question = db.Column(db.Text, nullable=False)
  916. account_id = db.Column(StringUUID, nullable=False)
  917. created_at = db.Column(db.DateTime, nullable=False, server_default=db.text("CURRENT_TIMESTAMP(0)"))
  918. score = db.Column(Float, nullable=False, server_default=db.text("0"))
  919. message_id = db.Column(StringUUID, nullable=False)
  920. annotation_question = db.Column(db.Text, nullable=False)
  921. annotation_content = db.Column(db.Text, nullable=False)
  922. @property
  923. def account(self):
  924. account = (
  925. db.session.query(Account)
  926. .join(MessageAnnotation, MessageAnnotation.account_id == Account.id)
  927. .filter(MessageAnnotation.id == self.annotation_id)
  928. .first()
  929. )
  930. return account
  931. @property
  932. def annotation_create_account(self):
  933. account = db.session.query(Account).filter(Account.id == self.account_id).first()
  934. return account
  935. class AppAnnotationSetting(Base):
  936. __tablename__ = "app_annotation_settings"
  937. __table_args__ = (
  938. db.PrimaryKeyConstraint("id", name="app_annotation_settings_pkey"),
  939. db.Index("app_annotation_settings_app_idx", "app_id"),
  940. )
  941. id = db.Column(StringUUID, server_default=db.text("uuid_generate_v4()"))
  942. app_id = db.Column(StringUUID, nullable=False)
  943. score_threshold = db.Column(Float, nullable=False, server_default=db.text("0"))
  944. collection_binding_id = db.Column(StringUUID, nullable=False)
  945. created_user_id = db.Column(StringUUID, nullable=False)
  946. created_at = db.Column(db.DateTime, nullable=False, server_default=db.text("CURRENT_TIMESTAMP(0)"))
  947. updated_user_id = db.Column(StringUUID, nullable=False)
  948. updated_at = db.Column(db.DateTime, nullable=False, server_default=db.text("CURRENT_TIMESTAMP(0)"))
  949. @property
  950. def created_account(self):
  951. account = (
  952. db.session.query(Account)
  953. .join(AppAnnotationSetting, AppAnnotationSetting.created_user_id == Account.id)
  954. .filter(AppAnnotationSetting.id == self.annotation_id)
  955. .first()
  956. )
  957. return account
  958. @property
  959. def updated_account(self):
  960. account = (
  961. db.session.query(Account)
  962. .join(AppAnnotationSetting, AppAnnotationSetting.updated_user_id == Account.id)
  963. .filter(AppAnnotationSetting.id == self.annotation_id)
  964. .first()
  965. )
  966. return account
  967. @property
  968. def collection_binding_detail(self):
  969. from .dataset import DatasetCollectionBinding
  970. collection_binding_detail = (
  971. db.session.query(DatasetCollectionBinding)
  972. .filter(DatasetCollectionBinding.id == self.collection_binding_id)
  973. .first()
  974. )
  975. return collection_binding_detail
  976. class OperationLog(Base):
  977. __tablename__ = "operation_logs"
  978. __table_args__ = (
  979. db.PrimaryKeyConstraint("id", name="operation_log_pkey"),
  980. db.Index("operation_log_account_action_idx", "tenant_id", "account_id", "action"),
  981. )
  982. id = db.Column(StringUUID, server_default=db.text("uuid_generate_v4()"))
  983. tenant_id = db.Column(StringUUID, nullable=False)
  984. account_id = db.Column(StringUUID, nullable=False)
  985. action = db.Column(db.String(255), nullable=False)
  986. content = db.Column(db.JSON)
  987. created_at = db.Column(db.DateTime, nullable=False, server_default=db.text("CURRENT_TIMESTAMP(0)"))
  988. created_ip = db.Column(db.String(255), nullable=False)
  989. updated_at = db.Column(db.DateTime, nullable=False, server_default=db.text("CURRENT_TIMESTAMP(0)"))
  990. class EndUser(UserMixin, Base):
  991. __tablename__ = "end_users"
  992. __table_args__ = (
  993. db.PrimaryKeyConstraint("id", name="end_user_pkey"),
  994. db.Index("end_user_session_id_idx", "session_id", "type"),
  995. db.Index("end_user_tenant_session_id_idx", "tenant_id", "session_id", "type"),
  996. )
  997. id = db.Column(StringUUID, server_default=db.text("uuid_generate_v4()"))
  998. tenant_id = db.Column(StringUUID, nullable=False)
  999. app_id = db.Column(StringUUID, nullable=True)
  1000. type = db.Column(db.String(255), nullable=False)
  1001. external_user_id = db.Column(db.String(255), nullable=True)
  1002. name = db.Column(db.String(255))
  1003. is_anonymous = db.Column(db.Boolean, nullable=False, server_default=db.text("true"))
  1004. session_id = db.Column(db.String(255), nullable=False)
  1005. created_at = db.Column(db.DateTime, nullable=False, server_default=db.text("CURRENT_TIMESTAMP(0)"))
  1006. updated_at = db.Column(db.DateTime, nullable=False, server_default=db.text("CURRENT_TIMESTAMP(0)"))
  1007. class Site(Base):
  1008. __tablename__ = "sites"
  1009. __table_args__ = (
  1010. db.PrimaryKeyConstraint("id", name="site_pkey"),
  1011. db.Index("site_app_id_idx", "app_id"),
  1012. db.Index("site_code_idx", "code", "status"),
  1013. )
  1014. id = db.Column(StringUUID, server_default=db.text("uuid_generate_v4()"))
  1015. app_id = db.Column(StringUUID, nullable=False)
  1016. title = db.Column(db.String(255), nullable=False)
  1017. icon_type = db.Column(db.String(255), nullable=True)
  1018. icon = db.Column(db.String(255))
  1019. icon_background = db.Column(db.String(255))
  1020. description = db.Column(db.Text)
  1021. default_language = db.Column(db.String(255), nullable=False)
  1022. chat_color_theme = db.Column(db.String(255))
  1023. chat_color_theme_inverted = db.Column(db.Boolean, nullable=False, server_default=db.text("false"))
  1024. copyright = db.Column(db.String(255))
  1025. privacy_policy = db.Column(db.String(255))
  1026. show_workflow_steps = db.Column(db.Boolean, nullable=False, server_default=db.text("true"))
  1027. use_icon_as_answer_icon = db.Column(db.Boolean, nullable=False, server_default=db.text("false"))
  1028. custom_disclaimer = db.Column(db.String(255), nullable=True)
  1029. customize_domain = db.Column(db.String(255))
  1030. customize_token_strategy = db.Column(db.String(255), nullable=False)
  1031. prompt_public = db.Column(db.Boolean, nullable=False, server_default=db.text("false"))
  1032. status = db.Column(db.String(255), nullable=False, server_default=db.text("'normal'::character varying"))
  1033. created_by = db.Column(StringUUID, nullable=True)
  1034. created_at = db.Column(db.DateTime, nullable=False, server_default=db.text("CURRENT_TIMESTAMP(0)"))
  1035. updated_by = db.Column(StringUUID, nullable=True)
  1036. updated_at = db.Column(db.DateTime, nullable=False, server_default=db.text("CURRENT_TIMESTAMP(0)"))
  1037. code = db.Column(db.String(255))
  1038. @staticmethod
  1039. def generate_code(n):
  1040. while True:
  1041. result = generate_string(n)
  1042. while db.session.query(Site).filter(Site.code == result).count() > 0:
  1043. result = generate_string(n)
  1044. return result
  1045. @property
  1046. def app_base_url(self):
  1047. return dify_config.APP_WEB_URL or request.url_root.rstrip("/")
  1048. class ApiToken(Base):
  1049. __tablename__ = "api_tokens"
  1050. __table_args__ = (
  1051. db.PrimaryKeyConstraint("id", name="api_token_pkey"),
  1052. db.Index("api_token_app_id_type_idx", "app_id", "type"),
  1053. db.Index("api_token_token_idx", "token", "type"),
  1054. db.Index("api_token_tenant_idx", "tenant_id", "type"),
  1055. )
  1056. id = db.Column(StringUUID, server_default=db.text("uuid_generate_v4()"))
  1057. app_id = db.Column(StringUUID, nullable=True)
  1058. tenant_id = db.Column(StringUUID, nullable=True)
  1059. type = db.Column(db.String(16), nullable=False)
  1060. token = db.Column(db.String(255), nullable=False)
  1061. last_used_at = db.Column(db.DateTime, nullable=True)
  1062. created_at = db.Column(db.DateTime, nullable=False, server_default=db.text("CURRENT_TIMESTAMP(0)"))
  1063. @staticmethod
  1064. def generate_api_key(prefix, n):
  1065. while True:
  1066. result = prefix + generate_string(n)
  1067. while db.session.query(ApiToken).filter(ApiToken.token == result).count() > 0:
  1068. result = prefix + generate_string(n)
  1069. return result
  1070. class UploadFile(Base):
  1071. __tablename__ = "upload_files"
  1072. __table_args__ = (
  1073. db.PrimaryKeyConstraint("id", name="upload_file_pkey"),
  1074. db.Index("upload_file_tenant_idx", "tenant_id"),
  1075. )
  1076. id = db.Column(StringUUID, server_default=db.text("uuid_generate_v4()"))
  1077. tenant_id = db.Column(StringUUID, nullable=False)
  1078. storage_type = db.Column(db.String(255), nullable=False)
  1079. key = db.Column(db.String(255), nullable=False)
  1080. name = db.Column(db.String(255), nullable=False)
  1081. size = db.Column(db.Integer, nullable=False)
  1082. extension = db.Column(db.String(255), nullable=False)
  1083. mime_type = db.Column(db.String(255), nullable=True)
  1084. created_by_role = db.Column(db.String(255), nullable=False, server_default=db.text("'account'::character varying"))
  1085. created_by = db.Column(StringUUID, nullable=False)
  1086. created_at = db.Column(db.DateTime, nullable=False, server_default=db.text("CURRENT_TIMESTAMP(0)"))
  1087. used = db.Column(db.Boolean, nullable=False, server_default=db.text("false"))
  1088. used_by = db.Column(StringUUID, nullable=True)
  1089. used_at = db.Column(db.DateTime, nullable=True)
  1090. hash = db.Column(db.String(255), nullable=True)
  1091. class ApiRequest(Base):
  1092. __tablename__ = "api_requests"
  1093. __table_args__ = (
  1094. db.PrimaryKeyConstraint("id", name="api_request_pkey"),
  1095. db.Index("api_request_token_idx", "tenant_id", "api_token_id"),
  1096. )
  1097. id = db.Column(StringUUID, nullable=False, server_default=db.text("uuid_generate_v4()"))
  1098. tenant_id = db.Column(StringUUID, nullable=False)
  1099. api_token_id = db.Column(StringUUID, nullable=False)
  1100. path = db.Column(db.String(255), nullable=False)
  1101. request = db.Column(db.Text, nullable=True)
  1102. response = db.Column(db.Text, nullable=True)
  1103. ip = db.Column(db.String(255), nullable=False)
  1104. created_at = db.Column(db.DateTime, nullable=False, server_default=db.text("CURRENT_TIMESTAMP(0)"))
  1105. class MessageChain(Base):
  1106. __tablename__ = "message_chains"
  1107. __table_args__ = (
  1108. db.PrimaryKeyConstraint("id", name="message_chain_pkey"),
  1109. db.Index("message_chain_message_id_idx", "message_id"),
  1110. )
  1111. id = db.Column(StringUUID, nullable=False, server_default=db.text("uuid_generate_v4()"))
  1112. message_id = db.Column(StringUUID, nullable=False)
  1113. type = db.Column(db.String(255), nullable=False)
  1114. input = db.Column(db.Text, nullable=True)
  1115. output = db.Column(db.Text, nullable=True)
  1116. created_at = db.Column(db.DateTime, nullable=False, server_default=db.func.current_timestamp())
  1117. class MessageAgentThought(Base):
  1118. __tablename__ = "message_agent_thoughts"
  1119. __table_args__ = (
  1120. db.PrimaryKeyConstraint("id", name="message_agent_thought_pkey"),
  1121. db.Index("message_agent_thought_message_id_idx", "message_id"),
  1122. db.Index("message_agent_thought_message_chain_id_idx", "message_chain_id"),
  1123. )
  1124. id = db.Column(StringUUID, nullable=False, server_default=db.text("uuid_generate_v4()"))
  1125. message_id = db.Column(StringUUID, nullable=False)
  1126. message_chain_id = db.Column(StringUUID, nullable=True)
  1127. position = db.Column(db.Integer, nullable=False)
  1128. thought = db.Column(db.Text, nullable=True)
  1129. tool = db.Column(db.Text, nullable=True)
  1130. tool_labels_str = db.Column(db.Text, nullable=False, server_default=db.text("'{}'::text"))
  1131. tool_meta_str = db.Column(db.Text, nullable=False, server_default=db.text("'{}'::text"))
  1132. tool_input = db.Column(db.Text, nullable=True)
  1133. observation = db.Column(db.Text, nullable=True)
  1134. # plugin_id = db.Column(StringUUID, nullable=True) ## for future design
  1135. tool_process_data = db.Column(db.Text, nullable=True)
  1136. message = db.Column(db.Text, nullable=True)
  1137. message_token = db.Column(db.Integer, nullable=True)
  1138. message_unit_price = db.Column(db.Numeric, nullable=True)
  1139. message_price_unit = db.Column(db.Numeric(10, 7), nullable=False, server_default=db.text("0.001"))
  1140. message_files = db.Column(db.Text, nullable=True)
  1141. answer = db.Column(db.Text, nullable=True)
  1142. answer_token = db.Column(db.Integer, nullable=True)
  1143. answer_unit_price = db.Column(db.Numeric, nullable=True)
  1144. answer_price_unit = db.Column(db.Numeric(10, 7), nullable=False, server_default=db.text("0.001"))
  1145. tokens = db.Column(db.Integer, nullable=True)
  1146. total_price = db.Column(db.Numeric, nullable=True)
  1147. currency = db.Column(db.String, nullable=True)
  1148. latency = db.Column(db.Float, nullable=True)
  1149. created_by_role = db.Column(db.String, nullable=False)
  1150. created_by = db.Column(StringUUID, nullable=False)
  1151. created_at = db.Column(db.DateTime, nullable=False, server_default=db.func.current_timestamp())
  1152. @property
  1153. def files(self) -> list:
  1154. if self.message_files:
  1155. return json.loads(self.message_files)
  1156. else:
  1157. return []
  1158. @property
  1159. def tools(self) -> list[str]:
  1160. return self.tool.split(";") if self.tool else []
  1161. @property
  1162. def tool_labels(self) -> dict:
  1163. try:
  1164. if self.tool_labels_str:
  1165. return json.loads(self.tool_labels_str)
  1166. else:
  1167. return {}
  1168. except Exception as e:
  1169. return {}
  1170. @property
  1171. def tool_meta(self) -> dict:
  1172. try:
  1173. if self.tool_meta_str:
  1174. return json.loads(self.tool_meta_str)
  1175. else:
  1176. return {}
  1177. except Exception as e:
  1178. return {}
  1179. @property
  1180. def tool_inputs_dict(self) -> dict:
  1181. tools = self.tools
  1182. try:
  1183. if self.tool_input:
  1184. data = json.loads(self.tool_input)
  1185. result = {}
  1186. for tool in tools:
  1187. if tool in data:
  1188. result[tool] = data[tool]
  1189. else:
  1190. if len(tools) == 1:
  1191. result[tool] = data
  1192. else:
  1193. result[tool] = {}
  1194. return result
  1195. else:
  1196. return {tool: {} for tool in tools}
  1197. except Exception as e:
  1198. return {}
  1199. @property
  1200. def tool_outputs_dict(self):
  1201. tools = self.tools
  1202. try:
  1203. if self.observation:
  1204. data = json.loads(self.observation)
  1205. result = {}
  1206. for tool in tools:
  1207. if tool in data:
  1208. result[tool] = data[tool]
  1209. else:
  1210. if len(tools) == 1:
  1211. result[tool] = data
  1212. else:
  1213. result[tool] = {}
  1214. return result
  1215. else:
  1216. return {tool: {} for tool in tools}
  1217. except Exception as e:
  1218. if self.observation:
  1219. return dict.fromkeys(tools, self.observation)
  1220. class DatasetRetrieverResource(Base):
  1221. __tablename__ = "dataset_retriever_resources"
  1222. __table_args__ = (
  1223. db.PrimaryKeyConstraint("id", name="dataset_retriever_resource_pkey"),
  1224. db.Index("dataset_retriever_resource_message_id_idx", "message_id"),
  1225. )
  1226. id = db.Column(StringUUID, nullable=False, server_default=db.text("uuid_generate_v4()"))
  1227. message_id = db.Column(StringUUID, nullable=False)
  1228. position = db.Column(db.Integer, nullable=False)
  1229. dataset_id = db.Column(StringUUID, nullable=False)
  1230. dataset_name = db.Column(db.Text, nullable=False)
  1231. document_id = db.Column(StringUUID, nullable=False)
  1232. document_name = db.Column(db.Text, nullable=False)
  1233. data_source_type = db.Column(db.Text, nullable=False)
  1234. segment_id = db.Column(StringUUID, nullable=False)
  1235. score = db.Column(db.Float, nullable=True)
  1236. content = db.Column(db.Text, nullable=False)
  1237. hit_count = db.Column(db.Integer, nullable=True)
  1238. word_count = db.Column(db.Integer, nullable=True)
  1239. segment_position = db.Column(db.Integer, nullable=True)
  1240. index_node_hash = db.Column(db.Text, nullable=True)
  1241. retriever_from = db.Column(db.Text, nullable=False)
  1242. created_by = db.Column(StringUUID, nullable=False)
  1243. created_at = db.Column(db.DateTime, nullable=False, server_default=db.func.current_timestamp())
  1244. class Tag(Base):
  1245. __tablename__ = "tags"
  1246. __table_args__ = (
  1247. db.PrimaryKeyConstraint("id", name="tag_pkey"),
  1248. db.Index("tag_type_idx", "type"),
  1249. db.Index("tag_name_idx", "name"),
  1250. )
  1251. TAG_TYPE_LIST = ["knowledge", "app"]
  1252. id = db.Column(StringUUID, server_default=db.text("uuid_generate_v4()"))
  1253. tenant_id = db.Column(StringUUID, nullable=True)
  1254. type = db.Column(db.String(16), nullable=False)
  1255. name = db.Column(db.String(255), nullable=False)
  1256. created_by = db.Column(StringUUID, nullable=False)
  1257. created_at = db.Column(db.DateTime, nullable=False, server_default=db.text("CURRENT_TIMESTAMP(0)"))
  1258. class TagBinding(Base):
  1259. __tablename__ = "tag_bindings"
  1260. __table_args__ = (
  1261. db.PrimaryKeyConstraint("id", name="tag_binding_pkey"),
  1262. db.Index("tag_bind_target_id_idx", "target_id"),
  1263. db.Index("tag_bind_tag_id_idx", "tag_id"),
  1264. )
  1265. id = db.Column(StringUUID, server_default=db.text("uuid_generate_v4()"))
  1266. tenant_id = db.Column(StringUUID, nullable=True)
  1267. tag_id = db.Column(StringUUID, nullable=True)
  1268. target_id = db.Column(StringUUID, nullable=True)
  1269. created_by = db.Column(StringUUID, nullable=False)
  1270. created_at = db.Column(db.DateTime, nullable=False, server_default=db.text("CURRENT_TIMESTAMP(0)"))
  1271. class TraceAppConfig(Base):
  1272. __tablename__ = "trace_app_config"
  1273. __table_args__ = (
  1274. db.PrimaryKeyConstraint("id", name="tracing_app_config_pkey"),
  1275. db.Index("trace_app_config_app_id_idx", "app_id"),
  1276. )
  1277. id = db.Column(StringUUID, server_default=db.text("uuid_generate_v4()"))
  1278. app_id = db.Column(StringUUID, nullable=False)
  1279. tracing_provider = db.Column(db.String(255), nullable=True)
  1280. tracing_config = db.Column(db.JSON, nullable=True)
  1281. created_at = db.Column(db.DateTime, nullable=False, server_default=func.now())
  1282. updated_at = db.Column(db.DateTime, nullable=False, server_default=func.now(), onupdate=func.now())
  1283. is_active = db.Column(db.Boolean, nullable=False, server_default=db.text("true"))
  1284. @property
  1285. def tracing_config_dict(self):
  1286. return self.tracing_config or {}
  1287. @property
  1288. def tracing_config_str(self):
  1289. return json.dumps(self.tracing_config_dict)
  1290. def to_dict(self):
  1291. return {
  1292. "id": self.id,
  1293. "app_id": self.app_id,
  1294. "tracing_provider": self.tracing_provider,
  1295. "tracing_config": self.tracing_config_dict,
  1296. "is_active": self.is_active,
  1297. "created_at": str(self.created_at) if self.created_at else None,
  1298. "updated_at": str(self.updated_at) if self.updated_at else None,
  1299. }