model.py 59 KB

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