model.py 58 KB

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