model.py 34 KB

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