model.py 59 KB

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