model.py 58 KB

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