model.py 54 KB

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