model.py 60 KB

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