model.py 58 KB

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