model.py 36 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852
  1. import json
  2. from flask import current_app, request
  3. from flask_login import UserMixin
  4. from sqlalchemy.dialects.postgresql import UUID
  5. from core.file.upload_file_parser import UploadFileParser
  6. from libs.helper import generate_string
  7. from extensions.ext_database import db
  8. from .account import Account, Tenant
  9. class DifySetup(db.Model):
  10. __tablename__ = 'dify_setups'
  11. __table_args__ = (
  12. db.PrimaryKeyConstraint('version', name='dify_setup_pkey'),
  13. )
  14. version = db.Column(db.String(255), nullable=False)
  15. setup_at = db.Column(db.DateTime, nullable=False, server_default=db.text('CURRENT_TIMESTAMP(0)'))
  16. class App(db.Model):
  17. __tablename__ = 'apps'
  18. __table_args__ = (
  19. db.PrimaryKeyConstraint('id', name='app_pkey'),
  20. db.Index('app_tenant_id_idx', 'tenant_id')
  21. )
  22. id = db.Column(UUID, server_default=db.text('uuid_generate_v4()'))
  23. tenant_id = db.Column(UUID, nullable=False)
  24. name = db.Column(db.String(255), nullable=False)
  25. mode = db.Column(db.String(255), nullable=False)
  26. icon = db.Column(db.String(255))
  27. icon_background = db.Column(db.String(255))
  28. app_model_config_id = db.Column(UUID, nullable=True)
  29. status = db.Column(db.String(255), nullable=False, server_default=db.text("'normal'::character varying"))
  30. enable_site = db.Column(db.Boolean, nullable=False)
  31. enable_api = db.Column(db.Boolean, nullable=False)
  32. api_rpm = db.Column(db.Integer, nullable=False)
  33. api_rph = db.Column(db.Integer, nullable=False)
  34. is_demo = db.Column(db.Boolean, nullable=False, server_default=db.text('false'))
  35. is_public = db.Column(db.Boolean, nullable=False, server_default=db.text('false'))
  36. is_universal = db.Column(db.Boolean, nullable=False, server_default=db.text('false'))
  37. created_at = db.Column(db.DateTime, nullable=False, server_default=db.text('CURRENT_TIMESTAMP(0)'))
  38. updated_at = db.Column(db.DateTime, nullable=False, server_default=db.text('CURRENT_TIMESTAMP(0)'))
  39. @property
  40. def site(self):
  41. site = db.session.query(Site).filter(Site.app_id == self.id).first()
  42. return site
  43. @property
  44. def app_model_config(self):
  45. app_model_config = db.session.query(AppModelConfig).filter(
  46. AppModelConfig.id == self.app_model_config_id).first()
  47. return app_model_config
  48. @property
  49. def api_base_url(self):
  50. return (current_app.config['SERVICE_API_URL'] if current_app.config['SERVICE_API_URL']
  51. else request.host_url.rstrip('/')) + '/v1'
  52. @property
  53. def tenant(self):
  54. tenant = db.session.query(Tenant).filter(Tenant.id == self.tenant_id).first()
  55. return tenant
  56. class AppModelConfig(db.Model):
  57. __tablename__ = 'app_model_configs'
  58. __table_args__ = (
  59. db.PrimaryKeyConstraint('id', name='app_model_config_pkey'),
  60. db.Index('app_app_id_idx', 'app_id')
  61. )
  62. id = db.Column(UUID, server_default=db.text('uuid_generate_v4()'))
  63. app_id = db.Column(UUID, nullable=False)
  64. provider = db.Column(db.String(255), nullable=False)
  65. model_id = db.Column(db.String(255), nullable=False)
  66. configs = db.Column(db.JSON, nullable=False)
  67. created_at = db.Column(db.DateTime, nullable=False, server_default=db.text('CURRENT_TIMESTAMP(0)'))
  68. updated_at = db.Column(db.DateTime, nullable=False, server_default=db.text('CURRENT_TIMESTAMP(0)'))
  69. opening_statement = db.Column(db.Text)
  70. suggested_questions = db.Column(db.Text)
  71. suggested_questions_after_answer = db.Column(db.Text)
  72. speech_to_text = db.Column(db.Text)
  73. more_like_this = db.Column(db.Text)
  74. model = db.Column(db.Text)
  75. user_input_form = db.Column(db.Text)
  76. dataset_query_variable = db.Column(db.String(255))
  77. pre_prompt = db.Column(db.Text)
  78. agent_mode = db.Column(db.Text)
  79. sensitive_word_avoidance = db.Column(db.Text)
  80. retriever_resource = db.Column(db.Text)
  81. prompt_type = db.Column(db.String(255), nullable=False, default='simple')
  82. chat_prompt_config = db.Column(db.Text)
  83. completion_prompt_config = db.Column(db.Text)
  84. dataset_configs = db.Column(db.Text)
  85. external_data_tools = db.Column(db.Text)
  86. file_upload = db.Column(db.Text)
  87. @property
  88. def app(self):
  89. app = db.session.query(App).filter(App.id == self.app_id).first()
  90. return app
  91. @property
  92. def model_dict(self) -> dict:
  93. return json.loads(self.model) if self.model else None
  94. @property
  95. def suggested_questions_list(self) -> list:
  96. return json.loads(self.suggested_questions) if self.suggested_questions else []
  97. @property
  98. def suggested_questions_after_answer_dict(self) -> dict:
  99. return json.loads(self.suggested_questions_after_answer) if self.suggested_questions_after_answer \
  100. else {"enabled": False}
  101. @property
  102. def speech_to_text_dict(self) -> dict:
  103. return json.loads(self.speech_to_text) if self.speech_to_text \
  104. else {"enabled": False}
  105. @property
  106. def retriever_resource_dict(self) -> dict:
  107. return json.loads(self.retriever_resource) if self.retriever_resource \
  108. else {"enabled": False}
  109. @property
  110. def more_like_this_dict(self) -> dict:
  111. return json.loads(self.more_like_this) if self.more_like_this else {"enabled": False}
  112. @property
  113. def sensitive_word_avoidance_dict(self) -> dict:
  114. return json.loads(self.sensitive_word_avoidance) if self.sensitive_word_avoidance \
  115. else {"enabled": False, "type": "", "configs": []}
  116. @property
  117. def external_data_tools_list(self) -> list[dict]:
  118. return json.loads(self.external_data_tools) if self.external_data_tools \
  119. else []
  120. @property
  121. def user_input_form_list(self) -> dict:
  122. return json.loads(self.user_input_form) if self.user_input_form else []
  123. @property
  124. def agent_mode_dict(self) -> dict:
  125. return json.loads(self.agent_mode) if self.agent_mode else {"enabled": False, "strategy": None, "tools": []}
  126. @property
  127. def chat_prompt_config_dict(self) -> dict:
  128. return json.loads(self.chat_prompt_config) if self.chat_prompt_config else {}
  129. @property
  130. def completion_prompt_config_dict(self) -> dict:
  131. return json.loads(self.completion_prompt_config) if self.completion_prompt_config else {}
  132. @property
  133. def dataset_configs_dict(self) -> dict:
  134. if self.dataset_configs:
  135. dataset_configs = json.loads(self.dataset_configs)
  136. if 'retrieval_model' not in dataset_configs:
  137. return {'retrieval_model': 'single'}
  138. else:
  139. return dataset_configs
  140. return {'retrieval_model': 'single'}
  141. @property
  142. def file_upload_dict(self) -> dict:
  143. return json.loads(self.file_upload) if self.file_upload else {"image": {"enabled": False, "number_limits": 3, "detail": "high", "transfer_methods": ["remote_url", "local_file"]}}
  144. def to_dict(self) -> dict:
  145. return {
  146. "provider": "",
  147. "model_id": "",
  148. "configs": {},
  149. "opening_statement": self.opening_statement,
  150. "suggested_questions": self.suggested_questions_list,
  151. "suggested_questions_after_answer": self.suggested_questions_after_answer_dict,
  152. "speech_to_text": self.speech_to_text_dict,
  153. "retriever_resource": self.retriever_resource_dict,
  154. "more_like_this": self.more_like_this_dict,
  155. "sensitive_word_avoidance": self.sensitive_word_avoidance_dict,
  156. "external_data_tools": self.external_data_tools_list,
  157. "model": self.model_dict,
  158. "user_input_form": self.user_input_form_list,
  159. "dataset_query_variable": self.dataset_query_variable,
  160. "pre_prompt": self.pre_prompt,
  161. "agent_mode": self.agent_mode_dict,
  162. "prompt_type": self.prompt_type,
  163. "chat_prompt_config": self.chat_prompt_config_dict,
  164. "completion_prompt_config": self.completion_prompt_config_dict,
  165. "dataset_configs": self.dataset_configs_dict,
  166. "file_upload": self.file_upload_dict
  167. }
  168. def from_model_config_dict(self, model_config: dict):
  169. self.provider = ""
  170. self.model_id = ""
  171. self.configs = {}
  172. self.opening_statement = model_config['opening_statement']
  173. self.suggested_questions = json.dumps(model_config['suggested_questions'])
  174. self.suggested_questions_after_answer = json.dumps(model_config['suggested_questions_after_answer'])
  175. self.speech_to_text = json.dumps(model_config['speech_to_text']) \
  176. if model_config.get('speech_to_text') else None
  177. self.more_like_this = json.dumps(model_config['more_like_this'])
  178. self.sensitive_word_avoidance = json.dumps(model_config['sensitive_word_avoidance']) \
  179. if model_config.get('sensitive_word_avoidance') else None
  180. self.external_data_tools = json.dumps(model_config['external_data_tools']) \
  181. if model_config.get('external_data_tools') else None
  182. self.model = json.dumps(model_config['model'])
  183. self.user_input_form = json.dumps(model_config['user_input_form'])
  184. self.dataset_query_variable = model_config.get('dataset_query_variable')
  185. self.pre_prompt = model_config['pre_prompt']
  186. self.agent_mode = json.dumps(model_config['agent_mode'])
  187. self.retriever_resource = json.dumps(model_config['retriever_resource']) \
  188. if model_config.get('retriever_resource') else None
  189. self.prompt_type = model_config.get('prompt_type', 'simple')
  190. self.chat_prompt_config = json.dumps(model_config.get('chat_prompt_config')) \
  191. if model_config.get('chat_prompt_config') else None
  192. self.completion_prompt_config = json.dumps(model_config.get('completion_prompt_config')) \
  193. if model_config.get('completion_prompt_config') else None
  194. self.dataset_configs = json.dumps(model_config.get('dataset_configs')) \
  195. if model_config.get('dataset_configs') else None
  196. self.file_upload = json.dumps(model_config.get('file_upload')) \
  197. if model_config.get('file_upload') else None
  198. return self
  199. def copy(self):
  200. new_app_model_config = AppModelConfig(
  201. id=self.id,
  202. app_id=self.app_id,
  203. provider="",
  204. model_id="",
  205. configs={},
  206. opening_statement=self.opening_statement,
  207. suggested_questions=self.suggested_questions,
  208. suggested_questions_after_answer=self.suggested_questions_after_answer,
  209. speech_to_text=self.speech_to_text,
  210. more_like_this=self.more_like_this,
  211. sensitive_word_avoidance=self.sensitive_word_avoidance,
  212. external_data_tools=self.external_data_tools,
  213. model=self.model,
  214. user_input_form=self.user_input_form,
  215. dataset_query_variable=self.dataset_query_variable,
  216. pre_prompt=self.pre_prompt,
  217. agent_mode=self.agent_mode,
  218. retriever_resource=self.retriever_resource,
  219. prompt_type=self.prompt_type,
  220. chat_prompt_config=self.chat_prompt_config,
  221. completion_prompt_config=self.completion_prompt_config,
  222. dataset_configs=self.dataset_configs,
  223. file_upload=self.file_upload
  224. )
  225. return new_app_model_config
  226. class RecommendedApp(db.Model):
  227. __tablename__ = 'recommended_apps'
  228. __table_args__ = (
  229. db.PrimaryKeyConstraint('id', name='recommended_app_pkey'),
  230. db.Index('recommended_app_app_id_idx', 'app_id'),
  231. db.Index('recommended_app_is_listed_idx', 'is_listed', 'language')
  232. )
  233. id = db.Column(UUID, primary_key=True, server_default=db.text('uuid_generate_v4()'))
  234. app_id = db.Column(UUID, nullable=False)
  235. description = db.Column(db.JSON, nullable=False)
  236. copyright = db.Column(db.String(255), nullable=False)
  237. privacy_policy = db.Column(db.String(255), nullable=False)
  238. category = db.Column(db.String(255), nullable=False)
  239. position = db.Column(db.Integer, nullable=False, default=0)
  240. is_listed = db.Column(db.Boolean, nullable=False, default=True)
  241. install_count = db.Column(db.Integer, nullable=False, default=0)
  242. language = db.Column(db.String(255), nullable=False, server_default=db.text("'en-US'::character varying"))
  243. created_at = db.Column(db.DateTime, nullable=False, server_default=db.text('CURRENT_TIMESTAMP(0)'))
  244. updated_at = db.Column(db.DateTime, nullable=False, server_default=db.text('CURRENT_TIMESTAMP(0)'))
  245. @property
  246. def app(self):
  247. app = db.session.query(App).filter(App.id == self.app_id).first()
  248. return app
  249. class InstalledApp(db.Model):
  250. __tablename__ = 'installed_apps'
  251. __table_args__ = (
  252. db.PrimaryKeyConstraint('id', name='installed_app_pkey'),
  253. db.Index('installed_app_tenant_id_idx', 'tenant_id'),
  254. db.Index('installed_app_app_id_idx', 'app_id'),
  255. db.UniqueConstraint('tenant_id', 'app_id', name='unique_tenant_app')
  256. )
  257. id = db.Column(UUID, server_default=db.text('uuid_generate_v4()'))
  258. tenant_id = db.Column(UUID, nullable=False)
  259. app_id = db.Column(UUID, nullable=False)
  260. app_owner_tenant_id = db.Column(UUID, nullable=False)
  261. position = db.Column(db.Integer, nullable=False, default=0)
  262. is_pinned = db.Column(db.Boolean, nullable=False, server_default=db.text('false'))
  263. last_used_at = db.Column(db.DateTime, nullable=True)
  264. created_at = db.Column(db.DateTime, nullable=False, server_default=db.text('CURRENT_TIMESTAMP(0)'))
  265. @property
  266. def app(self):
  267. app = db.session.query(App).filter(App.id == self.app_id).first()
  268. return app
  269. @property
  270. def tenant(self):
  271. tenant = db.session.query(Tenant).filter(Tenant.id == self.tenant_id).first()
  272. return tenant
  273. class Conversation(db.Model):
  274. __tablename__ = 'conversations'
  275. __table_args__ = (
  276. db.PrimaryKeyConstraint('id', name='conversation_pkey'),
  277. db.Index('conversation_app_from_user_idx', 'app_id', 'from_source', 'from_end_user_id')
  278. )
  279. id = db.Column(UUID, server_default=db.text('uuid_generate_v4()'))
  280. app_id = db.Column(UUID, nullable=False)
  281. app_model_config_id = db.Column(UUID, nullable=False)
  282. model_provider = db.Column(db.String(255), nullable=False)
  283. override_model_configs = db.Column(db.Text)
  284. model_id = db.Column(db.String(255), nullable=False)
  285. mode = db.Column(db.String(255), nullable=False)
  286. name = db.Column(db.String(255), nullable=False)
  287. summary = db.Column(db.Text)
  288. inputs = db.Column(db.JSON)
  289. introduction = db.Column(db.Text)
  290. system_instruction = db.Column(db.Text)
  291. system_instruction_tokens = db.Column(db.Integer, nullable=False, server_default=db.text('0'))
  292. status = db.Column(db.String(255), nullable=False)
  293. from_source = db.Column(db.String(255), nullable=False)
  294. from_end_user_id = db.Column(UUID)
  295. from_account_id = db.Column(UUID)
  296. read_at = db.Column(db.DateTime)
  297. read_account_id = db.Column(UUID)
  298. created_at = db.Column(db.DateTime, nullable=False, server_default=db.text('CURRENT_TIMESTAMP(0)'))
  299. updated_at = db.Column(db.DateTime, nullable=False, server_default=db.text('CURRENT_TIMESTAMP(0)'))
  300. messages = db.relationship("Message", backref="conversation", lazy='select', passive_deletes="all")
  301. message_annotations = db.relationship("MessageAnnotation", backref="conversation", lazy='select',
  302. passive_deletes="all")
  303. is_deleted = db.Column(db.Boolean, nullable=False, server_default=db.text('false'))
  304. @property
  305. def model_config(self):
  306. model_config = {}
  307. if self.override_model_configs:
  308. override_model_configs = json.loads(self.override_model_configs)
  309. if 'model' in override_model_configs:
  310. app_model_config = AppModelConfig()
  311. app_model_config = app_model_config.from_model_config_dict(override_model_configs)
  312. model_config = app_model_config.to_dict()
  313. else:
  314. model_config['configs'] = override_model_configs
  315. else:
  316. app_model_config = db.session.query(AppModelConfig).filter(
  317. AppModelConfig.id == self.app_model_config_id).first()
  318. model_config = app_model_config.to_dict()
  319. model_config['model_id'] = self.model_id
  320. model_config['provider'] = self.model_provider
  321. return model_config
  322. @property
  323. def summary_or_query(self):
  324. if self.summary:
  325. return self.summary
  326. else:
  327. first_message = self.first_message
  328. if first_message:
  329. return first_message.query
  330. else:
  331. return ''
  332. @property
  333. def annotated(self):
  334. return db.session.query(MessageAnnotation).filter(MessageAnnotation.conversation_id == self.id).count() > 0
  335. @property
  336. def annotation(self):
  337. return db.session.query(MessageAnnotation).filter(MessageAnnotation.conversation_id == self.id).first()
  338. @property
  339. def message_count(self):
  340. return db.session.query(Message).filter(Message.conversation_id == self.id).count()
  341. @property
  342. def user_feedback_stats(self):
  343. like = db.session.query(MessageFeedback) \
  344. .filter(MessageFeedback.conversation_id == self.id,
  345. MessageFeedback.from_source == 'user',
  346. MessageFeedback.rating == 'like').count()
  347. dislike = db.session.query(MessageFeedback) \
  348. .filter(MessageFeedback.conversation_id == self.id,
  349. MessageFeedback.from_source == 'user',
  350. MessageFeedback.rating == 'dislike').count()
  351. return {'like': like, 'dislike': dislike}
  352. @property
  353. def admin_feedback_stats(self):
  354. like = db.session.query(MessageFeedback) \
  355. .filter(MessageFeedback.conversation_id == self.id,
  356. MessageFeedback.from_source == 'admin',
  357. MessageFeedback.rating == 'like').count()
  358. dislike = db.session.query(MessageFeedback) \
  359. .filter(MessageFeedback.conversation_id == self.id,
  360. MessageFeedback.from_source == 'admin',
  361. MessageFeedback.rating == 'dislike').count()
  362. return {'like': like, 'dislike': dislike}
  363. @property
  364. def first_message(self):
  365. return db.session.query(Message).filter(Message.conversation_id == self.id).first()
  366. @property
  367. def app(self):
  368. return db.session.query(App).filter(App.id == self.app_id).first()
  369. @property
  370. def from_end_user_session_id(self):
  371. if self.from_end_user_id:
  372. end_user = db.session.query(EndUser).filter(EndUser.id == self.from_end_user_id).first()
  373. if end_user:
  374. return end_user.session_id
  375. return None
  376. @property
  377. def in_debug_mode(self):
  378. return self.override_model_configs is not None
  379. class Message(db.Model):
  380. __tablename__ = 'messages'
  381. __table_args__ = (
  382. db.PrimaryKeyConstraint('id', name='message_pkey'),
  383. db.Index('message_app_id_idx', 'app_id', 'created_at'),
  384. db.Index('message_conversation_id_idx', 'conversation_id'),
  385. db.Index('message_end_user_idx', 'app_id', 'from_source', 'from_end_user_id'),
  386. db.Index('message_account_idx', 'app_id', 'from_source', 'from_account_id'),
  387. )
  388. id = db.Column(UUID, server_default=db.text('uuid_generate_v4()'))
  389. app_id = db.Column(UUID, nullable=False)
  390. model_provider = db.Column(db.String(255), nullable=False)
  391. model_id = db.Column(db.String(255), nullable=False)
  392. override_model_configs = db.Column(db.Text)
  393. conversation_id = db.Column(UUID, db.ForeignKey('conversations.id'), nullable=False)
  394. inputs = db.Column(db.JSON)
  395. query = db.Column(db.Text, nullable=False)
  396. message = db.Column(db.JSON, nullable=False)
  397. message_tokens = db.Column(db.Integer, nullable=False, server_default=db.text('0'))
  398. message_unit_price = db.Column(db.Numeric(10, 4), nullable=False)
  399. message_price_unit = db.Column(db.Numeric(10, 7), nullable=False, server_default=db.text('0.001'))
  400. answer = db.Column(db.Text, nullable=False)
  401. answer_tokens = db.Column(db.Integer, nullable=False, server_default=db.text('0'))
  402. answer_unit_price = db.Column(db.Numeric(10, 4), nullable=False)
  403. answer_price_unit = db.Column(db.Numeric(10, 7), nullable=False, server_default=db.text('0.001'))
  404. provider_response_latency = db.Column(db.Float, nullable=False, server_default=db.text('0'))
  405. total_price = db.Column(db.Numeric(10, 7))
  406. currency = db.Column(db.String(255), nullable=False)
  407. from_source = db.Column(db.String(255), nullable=False)
  408. from_end_user_id = db.Column(UUID)
  409. from_account_id = db.Column(UUID)
  410. created_at = db.Column(db.DateTime, nullable=False, server_default=db.text('CURRENT_TIMESTAMP(0)'))
  411. updated_at = db.Column(db.DateTime, nullable=False, server_default=db.text('CURRENT_TIMESTAMP(0)'))
  412. agent_based = db.Column(db.Boolean, nullable=False, server_default=db.text('false'))
  413. @property
  414. def user_feedback(self):
  415. feedback = db.session.query(MessageFeedback).filter(MessageFeedback.message_id == self.id,
  416. MessageFeedback.from_source == 'user').first()
  417. return feedback
  418. @property
  419. def admin_feedback(self):
  420. feedback = db.session.query(MessageFeedback).filter(MessageFeedback.message_id == self.id,
  421. MessageFeedback.from_source == 'admin').first()
  422. return feedback
  423. @property
  424. def feedbacks(self):
  425. feedbacks = db.session.query(MessageFeedback).filter(MessageFeedback.message_id == self.id).all()
  426. return feedbacks
  427. @property
  428. def annotation(self):
  429. annotation = db.session.query(MessageAnnotation).filter(MessageAnnotation.message_id == self.id).first()
  430. return annotation
  431. @property
  432. def app_model_config(self):
  433. conversation = db.session.query(Conversation).filter(Conversation.id == self.conversation_id).first()
  434. if conversation:
  435. return db.session.query(AppModelConfig).filter(
  436. AppModelConfig.id == conversation.app_model_config_id).first()
  437. return None
  438. @property
  439. def in_debug_mode(self):
  440. return self.override_model_configs is not None
  441. @property
  442. def agent_thoughts(self):
  443. return db.session.query(MessageAgentThought).filter(MessageAgentThought.message_id == self.id) \
  444. .order_by(MessageAgentThought.position.asc()).all()
  445. @property
  446. def retriever_resources(self):
  447. return db.session.query(DatasetRetrieverResource).filter(DatasetRetrieverResource.message_id == self.id) \
  448. .order_by(DatasetRetrieverResource.position.asc()).all()
  449. @property
  450. def message_files(self):
  451. return db.session.query(MessageFile).filter(MessageFile.message_id == self.id).all()
  452. @property
  453. def files(self):
  454. message_files = self.message_files
  455. files = []
  456. for message_file in message_files:
  457. url = message_file.url
  458. if message_file.type == 'image':
  459. if message_file.transfer_method == 'local_file':
  460. upload_file = (db.session.query(UploadFile)
  461. .filter(
  462. UploadFile.id == message_file.upload_file_id
  463. ).first())
  464. url = UploadFileParser.get_image_data(
  465. upload_file=upload_file,
  466. force_url=True
  467. )
  468. files.append({
  469. 'id': message_file.id,
  470. 'type': message_file.type,
  471. 'url': url
  472. })
  473. return files
  474. class MessageFeedback(db.Model):
  475. __tablename__ = 'message_feedbacks'
  476. __table_args__ = (
  477. db.PrimaryKeyConstraint('id', name='message_feedback_pkey'),
  478. db.Index('message_feedback_app_idx', 'app_id'),
  479. db.Index('message_feedback_message_idx', 'message_id', 'from_source'),
  480. db.Index('message_feedback_conversation_idx', 'conversation_id', 'from_source', 'rating')
  481. )
  482. id = db.Column(UUID, server_default=db.text('uuid_generate_v4()'))
  483. app_id = db.Column(UUID, nullable=False)
  484. conversation_id = db.Column(UUID, nullable=False)
  485. message_id = db.Column(UUID, nullable=False)
  486. rating = db.Column(db.String(255), nullable=False)
  487. content = db.Column(db.Text)
  488. from_source = db.Column(db.String(255), nullable=False)
  489. from_end_user_id = db.Column(UUID)
  490. from_account_id = db.Column(UUID)
  491. created_at = db.Column(db.DateTime, nullable=False, server_default=db.text('CURRENT_TIMESTAMP(0)'))
  492. updated_at = db.Column(db.DateTime, nullable=False, server_default=db.text('CURRENT_TIMESTAMP(0)'))
  493. @property
  494. def from_account(self):
  495. account = db.session.query(Account).filter(Account.id == self.from_account_id).first()
  496. return account
  497. class MessageFile(db.Model):
  498. __tablename__ = 'message_files'
  499. __table_args__ = (
  500. db.PrimaryKeyConstraint('id', name='message_file_pkey'),
  501. db.Index('message_file_message_idx', 'message_id'),
  502. db.Index('message_file_created_by_idx', 'created_by')
  503. )
  504. id = db.Column(UUID, server_default=db.text('uuid_generate_v4()'))
  505. message_id = db.Column(UUID, nullable=False)
  506. type = db.Column(db.String(255), nullable=False)
  507. transfer_method = db.Column(db.String(255), nullable=False)
  508. url = db.Column(db.Text, nullable=True)
  509. upload_file_id = db.Column(UUID, nullable=True)
  510. created_by_role = db.Column(db.String(255), nullable=False)
  511. created_by = db.Column(UUID, nullable=False)
  512. created_at = db.Column(db.DateTime, nullable=False, server_default=db.text('CURRENT_TIMESTAMP(0)'))
  513. class MessageAnnotation(db.Model):
  514. __tablename__ = 'message_annotations'
  515. __table_args__ = (
  516. db.PrimaryKeyConstraint('id', name='message_annotation_pkey'),
  517. db.Index('message_annotation_app_idx', 'app_id'),
  518. db.Index('message_annotation_conversation_idx', 'conversation_id'),
  519. db.Index('message_annotation_message_idx', 'message_id')
  520. )
  521. id = db.Column(UUID, server_default=db.text('uuid_generate_v4()'))
  522. app_id = db.Column(UUID, nullable=False)
  523. conversation_id = db.Column(UUID, db.ForeignKey('conversations.id'), nullable=False)
  524. message_id = db.Column(UUID, nullable=False)
  525. content = db.Column(db.Text, nullable=False)
  526. account_id = db.Column(UUID, nullable=False)
  527. created_at = db.Column(db.DateTime, nullable=False, server_default=db.text('CURRENT_TIMESTAMP(0)'))
  528. updated_at = db.Column(db.DateTime, nullable=False, server_default=db.text('CURRENT_TIMESTAMP(0)'))
  529. @property
  530. def account(self):
  531. account = db.session.query(Account).filter(Account.id == self.account_id).first()
  532. return account
  533. class OperationLog(db.Model):
  534. __tablename__ = 'operation_logs'
  535. __table_args__ = (
  536. db.PrimaryKeyConstraint('id', name='operation_log_pkey'),
  537. db.Index('operation_log_account_action_idx', 'tenant_id', 'account_id', 'action')
  538. )
  539. id = db.Column(UUID, server_default=db.text('uuid_generate_v4()'))
  540. tenant_id = db.Column(UUID, nullable=False)
  541. account_id = db.Column(UUID, nullable=False)
  542. action = db.Column(db.String(255), nullable=False)
  543. content = db.Column(db.JSON)
  544. created_at = db.Column(db.DateTime, nullable=False, server_default=db.text('CURRENT_TIMESTAMP(0)'))
  545. created_ip = db.Column(db.String(255), nullable=False)
  546. updated_at = db.Column(db.DateTime, nullable=False, server_default=db.text('CURRENT_TIMESTAMP(0)'))
  547. class EndUser(UserMixin, db.Model):
  548. __tablename__ = 'end_users'
  549. __table_args__ = (
  550. db.PrimaryKeyConstraint('id', name='end_user_pkey'),
  551. db.Index('end_user_session_id_idx', 'session_id', 'type'),
  552. db.Index('end_user_tenant_session_id_idx', 'tenant_id', 'session_id', 'type'),
  553. )
  554. id = db.Column(UUID, server_default=db.text('uuid_generate_v4()'))
  555. tenant_id = db.Column(UUID, nullable=False)
  556. app_id = db.Column(UUID, nullable=True)
  557. type = db.Column(db.String(255), nullable=False)
  558. external_user_id = db.Column(db.String(255), nullable=True)
  559. name = db.Column(db.String(255))
  560. is_anonymous = db.Column(db.Boolean, nullable=False, server_default=db.text('true'))
  561. session_id = db.Column(db.String(255), nullable=False)
  562. created_at = db.Column(db.DateTime, nullable=False, server_default=db.text('CURRENT_TIMESTAMP(0)'))
  563. updated_at = db.Column(db.DateTime, nullable=False, server_default=db.text('CURRENT_TIMESTAMP(0)'))
  564. class Site(db.Model):
  565. __tablename__ = 'sites'
  566. __table_args__ = (
  567. db.PrimaryKeyConstraint('id', name='site_pkey'),
  568. db.Index('site_app_id_idx', 'app_id'),
  569. db.Index('site_code_idx', 'code', 'status')
  570. )
  571. id = db.Column(UUID, server_default=db.text('uuid_generate_v4()'))
  572. app_id = db.Column(UUID, nullable=False)
  573. title = db.Column(db.String(255), nullable=False)
  574. icon = db.Column(db.String(255))
  575. icon_background = db.Column(db.String(255))
  576. description = db.Column(db.String(255))
  577. default_language = db.Column(db.String(255), nullable=False)
  578. copyright = db.Column(db.String(255))
  579. privacy_policy = db.Column(db.String(255))
  580. customize_domain = db.Column(db.String(255))
  581. customize_token_strategy = db.Column(db.String(255), nullable=False)
  582. prompt_public = db.Column(db.Boolean, nullable=False, server_default=db.text('false'))
  583. status = db.Column(db.String(255), nullable=False, server_default=db.text("'normal'::character varying"))
  584. created_at = db.Column(db.DateTime, nullable=False, server_default=db.text('CURRENT_TIMESTAMP(0)'))
  585. updated_at = db.Column(db.DateTime, nullable=False, server_default=db.text('CURRENT_TIMESTAMP(0)'))
  586. code = db.Column(db.String(255))
  587. @staticmethod
  588. def generate_code(n):
  589. while True:
  590. result = generate_string(n)
  591. while db.session.query(Site).filter(Site.code == result).count() > 0:
  592. result = generate_string(n)
  593. return result
  594. @property
  595. def app_base_url(self):
  596. return (
  597. current_app.config['APP_WEB_URL'] if current_app.config['APP_WEB_URL'] else request.host_url.rstrip('/'))
  598. class ApiToken(db.Model):
  599. __tablename__ = 'api_tokens'
  600. __table_args__ = (
  601. db.PrimaryKeyConstraint('id', name='api_token_pkey'),
  602. db.Index('api_token_app_id_type_idx', 'app_id', 'type'),
  603. db.Index('api_token_token_idx', 'token', 'type'),
  604. db.Index('api_token_tenant_idx', 'tenant_id', 'type')
  605. )
  606. id = db.Column(UUID, server_default=db.text('uuid_generate_v4()'))
  607. app_id = db.Column(UUID, nullable=True)
  608. tenant_id = db.Column(UUID, nullable=True)
  609. type = db.Column(db.String(16), nullable=False)
  610. token = db.Column(db.String(255), nullable=False)
  611. last_used_at = db.Column(db.DateTime, nullable=True)
  612. created_at = db.Column(db.DateTime, nullable=False, server_default=db.text('CURRENT_TIMESTAMP(0)'))
  613. @staticmethod
  614. def generate_api_key(prefix, n):
  615. while True:
  616. result = prefix + generate_string(n)
  617. while db.session.query(ApiToken).filter(ApiToken.token == result).count() > 0:
  618. result = prefix + generate_string(n)
  619. return result
  620. class UploadFile(db.Model):
  621. __tablename__ = 'upload_files'
  622. __table_args__ = (
  623. db.PrimaryKeyConstraint('id', name='upload_file_pkey'),
  624. db.Index('upload_file_tenant_idx', 'tenant_id')
  625. )
  626. id = db.Column(UUID, server_default=db.text('uuid_generate_v4()'))
  627. tenant_id = db.Column(UUID, nullable=False)
  628. storage_type = db.Column(db.String(255), nullable=False)
  629. key = db.Column(db.String(255), nullable=False)
  630. name = db.Column(db.String(255), nullable=False)
  631. size = db.Column(db.Integer, nullable=False)
  632. extension = db.Column(db.String(255), nullable=False)
  633. mime_type = db.Column(db.String(255), nullable=True)
  634. created_by_role = db.Column(db.String(255), nullable=False, server_default=db.text("'account'::character varying"))
  635. created_by = db.Column(UUID, nullable=False)
  636. created_at = db.Column(db.DateTime, nullable=False, server_default=db.text('CURRENT_TIMESTAMP(0)'))
  637. used = db.Column(db.Boolean, nullable=False, server_default=db.text('false'))
  638. used_by = db.Column(UUID, nullable=True)
  639. used_at = db.Column(db.DateTime, nullable=True)
  640. hash = db.Column(db.String(255), nullable=True)
  641. class ApiRequest(db.Model):
  642. __tablename__ = 'api_requests'
  643. __table_args__ = (
  644. db.PrimaryKeyConstraint('id', name='api_request_pkey'),
  645. db.Index('api_request_token_idx', 'tenant_id', 'api_token_id')
  646. )
  647. id = db.Column(UUID, nullable=False, server_default=db.text('uuid_generate_v4()'))
  648. tenant_id = db.Column(UUID, nullable=False)
  649. api_token_id = db.Column(UUID, nullable=False)
  650. path = db.Column(db.String(255), nullable=False)
  651. request = db.Column(db.Text, nullable=True)
  652. response = db.Column(db.Text, nullable=True)
  653. ip = db.Column(db.String(255), nullable=False)
  654. created_at = db.Column(db.DateTime, nullable=False, server_default=db.text('CURRENT_TIMESTAMP(0)'))
  655. class MessageChain(db.Model):
  656. __tablename__ = 'message_chains'
  657. __table_args__ = (
  658. db.PrimaryKeyConstraint('id', name='message_chain_pkey'),
  659. db.Index('message_chain_message_id_idx', 'message_id')
  660. )
  661. id = db.Column(UUID, nullable=False, server_default=db.text('uuid_generate_v4()'))
  662. message_id = db.Column(UUID, nullable=False)
  663. type = db.Column(db.String(255), nullable=False)
  664. input = db.Column(db.Text, nullable=True)
  665. output = db.Column(db.Text, nullable=True)
  666. created_at = db.Column(db.DateTime, nullable=False, server_default=db.func.current_timestamp())
  667. class MessageAgentThought(db.Model):
  668. __tablename__ = 'message_agent_thoughts'
  669. __table_args__ = (
  670. db.PrimaryKeyConstraint('id', name='message_agent_thought_pkey'),
  671. db.Index('message_agent_thought_message_id_idx', 'message_id'),
  672. db.Index('message_agent_thought_message_chain_id_idx', 'message_chain_id'),
  673. )
  674. id = db.Column(UUID, nullable=False, server_default=db.text('uuid_generate_v4()'))
  675. message_id = db.Column(UUID, nullable=False)
  676. message_chain_id = db.Column(UUID, nullable=False)
  677. position = db.Column(db.Integer, nullable=False)
  678. thought = db.Column(db.Text, nullable=True)
  679. tool = db.Column(db.Text, nullable=True)
  680. tool_input = db.Column(db.Text, nullable=True)
  681. observation = db.Column(db.Text, nullable=True)
  682. # plugin_id = db.Column(UUID, nullable=True) ## for future design
  683. tool_process_data = db.Column(db.Text, nullable=True)
  684. message = db.Column(db.Text, nullable=True)
  685. message_token = db.Column(db.Integer, nullable=True)
  686. message_unit_price = db.Column(db.Numeric, nullable=True)
  687. message_price_unit = db.Column(db.Numeric(10, 7), nullable=False, server_default=db.text('0.001'))
  688. answer = db.Column(db.Text, nullable=True)
  689. answer_token = db.Column(db.Integer, nullable=True)
  690. answer_unit_price = db.Column(db.Numeric, nullable=True)
  691. answer_price_unit = db.Column(db.Numeric(10, 7), nullable=False, server_default=db.text('0.001'))
  692. tokens = db.Column(db.Integer, nullable=True)
  693. total_price = db.Column(db.Numeric, nullable=True)
  694. currency = db.Column(db.String, nullable=True)
  695. latency = db.Column(db.Float, nullable=True)
  696. created_by_role = db.Column(db.String, nullable=False)
  697. created_by = db.Column(UUID, nullable=False)
  698. created_at = db.Column(db.DateTime, nullable=False, server_default=db.func.current_timestamp())
  699. class DatasetRetrieverResource(db.Model):
  700. __tablename__ = 'dataset_retriever_resources'
  701. __table_args__ = (
  702. db.PrimaryKeyConstraint('id', name='dataset_retriever_resource_pkey'),
  703. db.Index('dataset_retriever_resource_message_id_idx', 'message_id'),
  704. )
  705. id = db.Column(UUID, nullable=False, server_default=db.text('uuid_generate_v4()'))
  706. message_id = db.Column(UUID, nullable=False)
  707. position = db.Column(db.Integer, nullable=False)
  708. dataset_id = db.Column(UUID, nullable=False)
  709. dataset_name = db.Column(db.Text, nullable=False)
  710. document_id = db.Column(UUID, nullable=False)
  711. document_name = db.Column(db.Text, nullable=False)
  712. data_source_type = db.Column(db.Text, nullable=False)
  713. segment_id = db.Column(UUID, nullable=False)
  714. score = db.Column(db.Float, nullable=True)
  715. content = db.Column(db.Text, nullable=False)
  716. hit_count = db.Column(db.Integer, nullable=True)
  717. word_count = db.Column(db.Integer, nullable=True)
  718. segment_position = db.Column(db.Integer, nullable=True)
  719. index_node_hash = db.Column(db.Text, nullable=True)
  720. retriever_from = db.Column(db.Text, nullable=False)
  721. created_by = db.Column(UUID, nullable=False)
  722. created_at = db.Column(db.DateTime, nullable=False, server_default=db.func.current_timestamp())