model.py 55 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329
  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) -> Optional['Workflow']:
  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. custom_disclaimer = db.Column(db.String(255), nullable=True)
  377. category = db.Column(db.String(255), nullable=False)
  378. position = db.Column(db.Integer, nullable=False, default=0)
  379. is_listed = db.Column(db.Boolean, nullable=False, default=True)
  380. install_count = db.Column(db.Integer, nullable=False, default=0)
  381. language = db.Column(db.String(255), nullable=False, server_default=db.text("'en-US'::character varying"))
  382. created_at = db.Column(db.DateTime, nullable=False, server_default=db.text('CURRENT_TIMESTAMP(0)'))
  383. updated_at = db.Column(db.DateTime, nullable=False, server_default=db.text('CURRENT_TIMESTAMP(0)'))
  384. @property
  385. def app(self):
  386. app = db.session.query(App).filter(App.id == self.app_id).first()
  387. return app
  388. class InstalledApp(db.Model):
  389. __tablename__ = 'installed_apps'
  390. __table_args__ = (
  391. db.PrimaryKeyConstraint('id', name='installed_app_pkey'),
  392. db.Index('installed_app_tenant_id_idx', 'tenant_id'),
  393. db.Index('installed_app_app_id_idx', 'app_id'),
  394. db.UniqueConstraint('tenant_id', 'app_id', name='unique_tenant_app')
  395. )
  396. id = db.Column(StringUUID, server_default=db.text('uuid_generate_v4()'))
  397. tenant_id = db.Column(StringUUID, nullable=False)
  398. app_id = db.Column(StringUUID, nullable=False)
  399. app_owner_tenant_id = db.Column(StringUUID, nullable=False)
  400. position = db.Column(db.Integer, nullable=False, default=0)
  401. is_pinned = db.Column(db.Boolean, nullable=False, server_default=db.text('false'))
  402. last_used_at = db.Column(db.DateTime, nullable=True)
  403. created_at = db.Column(db.DateTime, nullable=False, server_default=db.text('CURRENT_TIMESTAMP(0)'))
  404. @property
  405. def app(self):
  406. app = db.session.query(App).filter(App.id == self.app_id).first()
  407. return app
  408. @property
  409. def tenant(self):
  410. tenant = db.session.query(Tenant).filter(Tenant.id == self.tenant_id).first()
  411. return tenant
  412. class Conversation(db.Model):
  413. __tablename__ = 'conversations'
  414. __table_args__ = (
  415. db.PrimaryKeyConstraint('id', name='conversation_pkey'),
  416. db.Index('conversation_app_from_user_idx', 'app_id', 'from_source', 'from_end_user_id')
  417. )
  418. id = db.Column(StringUUID, server_default=db.text('uuid_generate_v4()'))
  419. app_id = db.Column(StringUUID, nullable=False)
  420. app_model_config_id = db.Column(StringUUID, nullable=True)
  421. model_provider = db.Column(db.String(255), nullable=True)
  422. override_model_configs = db.Column(db.Text)
  423. model_id = db.Column(db.String(255), nullable=True)
  424. mode = db.Column(db.String(255), nullable=False)
  425. name = db.Column(db.String(255), nullable=False)
  426. summary = db.Column(db.Text)
  427. inputs = db.Column(db.JSON)
  428. introduction = db.Column(db.Text)
  429. system_instruction = db.Column(db.Text)
  430. system_instruction_tokens = db.Column(db.Integer, nullable=False, server_default=db.text('0'))
  431. status = db.Column(db.String(255), nullable=False)
  432. invoke_from = db.Column(db.String(255), nullable=True)
  433. from_source = db.Column(db.String(255), nullable=False)
  434. from_end_user_id = db.Column(StringUUID)
  435. from_account_id = db.Column(StringUUID)
  436. read_at = db.Column(db.DateTime)
  437. read_account_id = db.Column(StringUUID)
  438. created_at = db.Column(db.DateTime, nullable=False, server_default=db.text('CURRENT_TIMESTAMP(0)'))
  439. updated_at = db.Column(db.DateTime, nullable=False, server_default=db.text('CURRENT_TIMESTAMP(0)'))
  440. messages = db.relationship("Message", backref="conversation", lazy='select', passive_deletes="all")
  441. message_annotations = db.relationship("MessageAnnotation", backref="conversation", lazy='select',
  442. passive_deletes="all")
  443. is_deleted = db.Column(db.Boolean, nullable=False, server_default=db.text('false'))
  444. @property
  445. def model_config(self):
  446. model_config = {}
  447. if self.mode == AppMode.ADVANCED_CHAT.value:
  448. if self.override_model_configs:
  449. override_model_configs = json.loads(self.override_model_configs)
  450. model_config = override_model_configs
  451. else:
  452. if self.override_model_configs:
  453. override_model_configs = json.loads(self.override_model_configs)
  454. if 'model' in override_model_configs:
  455. app_model_config = AppModelConfig()
  456. app_model_config = app_model_config.from_model_config_dict(override_model_configs)
  457. model_config = app_model_config.to_dict()
  458. else:
  459. model_config['configs'] = override_model_configs
  460. else:
  461. app_model_config = db.session.query(AppModelConfig).filter(
  462. AppModelConfig.id == self.app_model_config_id).first()
  463. model_config = app_model_config.to_dict()
  464. model_config['model_id'] = self.model_id
  465. model_config['provider'] = self.model_provider
  466. return model_config
  467. @property
  468. def summary_or_query(self):
  469. if self.summary:
  470. return self.summary
  471. else:
  472. first_message = self.first_message
  473. if first_message:
  474. return first_message.query
  475. else:
  476. return ''
  477. @property
  478. def annotated(self):
  479. return db.session.query(MessageAnnotation).filter(MessageAnnotation.conversation_id == self.id).count() > 0
  480. @property
  481. def annotation(self):
  482. return db.session.query(MessageAnnotation).filter(MessageAnnotation.conversation_id == self.id).first()
  483. @property
  484. def message_count(self):
  485. return db.session.query(Message).filter(Message.conversation_id == self.id).count()
  486. @property
  487. def user_feedback_stats(self):
  488. like = db.session.query(MessageFeedback) \
  489. .filter(MessageFeedback.conversation_id == self.id,
  490. MessageFeedback.from_source == 'user',
  491. MessageFeedback.rating == 'like').count()
  492. dislike = db.session.query(MessageFeedback) \
  493. .filter(MessageFeedback.conversation_id == self.id,
  494. MessageFeedback.from_source == 'user',
  495. MessageFeedback.rating == 'dislike').count()
  496. return {'like': like, 'dislike': dislike}
  497. @property
  498. def admin_feedback_stats(self):
  499. like = db.session.query(MessageFeedback) \
  500. .filter(MessageFeedback.conversation_id == self.id,
  501. MessageFeedback.from_source == 'admin',
  502. MessageFeedback.rating == 'like').count()
  503. dislike = db.session.query(MessageFeedback) \
  504. .filter(MessageFeedback.conversation_id == self.id,
  505. MessageFeedback.from_source == 'admin',
  506. MessageFeedback.rating == 'dislike').count()
  507. return {'like': like, 'dislike': dislike}
  508. @property
  509. def first_message(self):
  510. return db.session.query(Message).filter(Message.conversation_id == self.id).first()
  511. @property
  512. def app(self):
  513. return db.session.query(App).filter(App.id == self.app_id).first()
  514. @property
  515. def from_end_user_session_id(self):
  516. if self.from_end_user_id:
  517. end_user = db.session.query(EndUser).filter(EndUser.id == self.from_end_user_id).first()
  518. if end_user:
  519. return end_user.session_id
  520. return None
  521. @property
  522. def in_debug_mode(self):
  523. return self.override_model_configs is not None
  524. class Message(db.Model):
  525. __tablename__ = 'messages'
  526. __table_args__ = (
  527. db.PrimaryKeyConstraint('id', name='message_pkey'),
  528. db.Index('message_app_id_idx', 'app_id', 'created_at'),
  529. db.Index('message_conversation_id_idx', 'conversation_id'),
  530. db.Index('message_end_user_idx', 'app_id', 'from_source', 'from_end_user_id'),
  531. db.Index('message_account_idx', 'app_id', 'from_source', 'from_account_id'),
  532. )
  533. id = db.Column(StringUUID, server_default=db.text('uuid_generate_v4()'))
  534. app_id = db.Column(StringUUID, nullable=False)
  535. model_provider = db.Column(db.String(255), nullable=True)
  536. model_id = db.Column(db.String(255), nullable=True)
  537. override_model_configs = db.Column(db.Text)
  538. conversation_id = db.Column(StringUUID, db.ForeignKey('conversations.id'), nullable=False)
  539. inputs = db.Column(db.JSON)
  540. query = db.Column(db.Text, nullable=False)
  541. message = db.Column(db.JSON, nullable=False)
  542. message_tokens = db.Column(db.Integer, nullable=False, server_default=db.text('0'))
  543. message_unit_price = db.Column(db.Numeric(10, 4), nullable=False)
  544. message_price_unit = db.Column(db.Numeric(10, 7), nullable=False, server_default=db.text('0.001'))
  545. answer = db.Column(db.Text, nullable=False)
  546. answer_tokens = db.Column(db.Integer, nullable=False, server_default=db.text('0'))
  547. answer_unit_price = db.Column(db.Numeric(10, 4), nullable=False)
  548. answer_price_unit = db.Column(db.Numeric(10, 7), nullable=False, server_default=db.text('0.001'))
  549. provider_response_latency = db.Column(db.Float, nullable=False, server_default=db.text('0'))
  550. total_price = db.Column(db.Numeric(10, 7))
  551. currency = db.Column(db.String(255), nullable=False)
  552. status = db.Column(db.String(255), nullable=False, server_default=db.text("'normal'::character varying"))
  553. error = db.Column(db.Text)
  554. message_metadata = db.Column(db.Text)
  555. invoke_from = db.Column(db.String(255), nullable=True)
  556. from_source = db.Column(db.String(255), nullable=False)
  557. from_end_user_id = db.Column(StringUUID)
  558. from_account_id = db.Column(StringUUID)
  559. created_at = db.Column(db.DateTime, nullable=False, server_default=db.text('CURRENT_TIMESTAMP(0)'))
  560. updated_at = db.Column(db.DateTime, nullable=False, server_default=db.text('CURRENT_TIMESTAMP(0)'))
  561. agent_based = db.Column(db.Boolean, nullable=False, server_default=db.text('false'))
  562. workflow_run_id = db.Column(StringUUID)
  563. @property
  564. def re_sign_file_url_answer(self) -> str:
  565. if not self.answer:
  566. return self.answer
  567. pattern = r'\[!?.*?\]\((((http|https):\/\/.+)?\/files\/(tools\/)?[\w-]+.*?timestamp=.*&nonce=.*&sign=.*)\)'
  568. matches = re.findall(pattern, self.answer)
  569. if not matches:
  570. return self.answer
  571. urls = [match[0] for match in matches]
  572. # remove duplicate urls
  573. urls = list(set(urls))
  574. if not urls:
  575. return self.answer
  576. re_sign_file_url_answer = self.answer
  577. for url in urls:
  578. if 'files/tools' in url:
  579. # get tool file id
  580. tool_file_id_pattern = r'\/files\/tools\/([\.\w-]+)?\?timestamp='
  581. result = re.search(tool_file_id_pattern, url)
  582. if not result:
  583. continue
  584. tool_file_id = result.group(1)
  585. # get extension
  586. if '.' in tool_file_id:
  587. split_result = tool_file_id.split('.')
  588. extension = f'.{split_result[-1]}'
  589. if len(extension) > 10:
  590. extension = '.bin'
  591. tool_file_id = split_result[0]
  592. else:
  593. extension = '.bin'
  594. if not tool_file_id:
  595. continue
  596. sign_url = ToolFileParser.get_tool_file_manager().sign_file(
  597. tool_file_id=tool_file_id,
  598. extension=extension
  599. )
  600. else:
  601. # get upload file id
  602. upload_file_id_pattern = r'\/files\/([\w-]+)\/image-preview?\?timestamp='
  603. result = re.search(upload_file_id_pattern, url)
  604. if not result:
  605. continue
  606. upload_file_id = result.group(1)
  607. if not upload_file_id:
  608. continue
  609. sign_url = UploadFileParser.get_signed_temp_image_url(upload_file_id)
  610. re_sign_file_url_answer = re_sign_file_url_answer.replace(url, sign_url)
  611. return re_sign_file_url_answer
  612. @property
  613. def user_feedback(self):
  614. feedback = db.session.query(MessageFeedback).filter(MessageFeedback.message_id == self.id,
  615. MessageFeedback.from_source == 'user').first()
  616. return feedback
  617. @property
  618. def admin_feedback(self):
  619. feedback = db.session.query(MessageFeedback).filter(MessageFeedback.message_id == self.id,
  620. MessageFeedback.from_source == 'admin').first()
  621. return feedback
  622. @property
  623. def feedbacks(self):
  624. feedbacks = db.session.query(MessageFeedback).filter(MessageFeedback.message_id == self.id).all()
  625. return feedbacks
  626. @property
  627. def annotation(self):
  628. annotation = db.session.query(MessageAnnotation).filter(MessageAnnotation.message_id == self.id).first()
  629. return annotation
  630. @property
  631. def annotation_hit_history(self):
  632. annotation_history = (db.session.query(AppAnnotationHitHistory)
  633. .filter(AppAnnotationHitHistory.message_id == self.id).first())
  634. if annotation_history:
  635. annotation = (db.session.query(MessageAnnotation).
  636. filter(MessageAnnotation.id == annotation_history.annotation_id).first())
  637. return annotation
  638. return None
  639. @property
  640. def app_model_config(self):
  641. conversation = db.session.query(Conversation).filter(Conversation.id == self.conversation_id).first()
  642. if conversation:
  643. return db.session.query(AppModelConfig).filter(
  644. AppModelConfig.id == conversation.app_model_config_id).first()
  645. return None
  646. @property
  647. def in_debug_mode(self):
  648. return self.override_model_configs is not None
  649. @property
  650. def message_metadata_dict(self) -> dict:
  651. return json.loads(self.message_metadata) if self.message_metadata else {}
  652. @property
  653. def agent_thoughts(self):
  654. return db.session.query(MessageAgentThought).filter(MessageAgentThought.message_id == self.id) \
  655. .order_by(MessageAgentThought.position.asc()).all()
  656. @property
  657. def retriever_resources(self):
  658. return db.session.query(DatasetRetrieverResource).filter(DatasetRetrieverResource.message_id == self.id) \
  659. .order_by(DatasetRetrieverResource.position.asc()).all()
  660. @property
  661. def message_files(self):
  662. return db.session.query(MessageFile).filter(MessageFile.message_id == self.id).all()
  663. @property
  664. def files(self):
  665. message_files = self.message_files
  666. files = []
  667. for message_file in message_files:
  668. url = message_file.url
  669. if message_file.type == 'image':
  670. if message_file.transfer_method == 'local_file':
  671. upload_file = (db.session.query(UploadFile)
  672. .filter(
  673. UploadFile.id == message_file.upload_file_id
  674. ).first())
  675. url = UploadFileParser.get_image_data(
  676. upload_file=upload_file,
  677. force_url=True
  678. )
  679. if message_file.transfer_method == 'tool_file':
  680. # get tool file id
  681. tool_file_id = message_file.url.split('/')[-1]
  682. # trim extension
  683. tool_file_id = tool_file_id.split('.')[0]
  684. # get extension
  685. if '.' in message_file.url:
  686. extension = f'.{message_file.url.split(".")[-1]}'
  687. if len(extension) > 10:
  688. extension = '.bin'
  689. else:
  690. extension = '.bin'
  691. # add sign url
  692. url = ToolFileParser.get_tool_file_manager().sign_file(tool_file_id=tool_file_id, extension=extension)
  693. files.append({
  694. 'id': message_file.id,
  695. 'type': message_file.type,
  696. 'url': url,
  697. 'belongs_to': message_file.belongs_to if message_file.belongs_to else 'user'
  698. })
  699. return files
  700. @property
  701. def workflow_run(self):
  702. if self.workflow_run_id:
  703. from .workflow import WorkflowRun
  704. return db.session.query(WorkflowRun).filter(WorkflowRun.id == self.workflow_run_id).first()
  705. return None
  706. class MessageFeedback(db.Model):
  707. __tablename__ = 'message_feedbacks'
  708. __table_args__ = (
  709. db.PrimaryKeyConstraint('id', name='message_feedback_pkey'),
  710. db.Index('message_feedback_app_idx', 'app_id'),
  711. db.Index('message_feedback_message_idx', 'message_id', 'from_source'),
  712. db.Index('message_feedback_conversation_idx', 'conversation_id', 'from_source', 'rating')
  713. )
  714. id = db.Column(StringUUID, server_default=db.text('uuid_generate_v4()'))
  715. app_id = db.Column(StringUUID, nullable=False)
  716. conversation_id = db.Column(StringUUID, nullable=False)
  717. message_id = db.Column(StringUUID, nullable=False)
  718. rating = db.Column(db.String(255), nullable=False)
  719. content = db.Column(db.Text)
  720. from_source = db.Column(db.String(255), nullable=False)
  721. from_end_user_id = db.Column(StringUUID)
  722. from_account_id = db.Column(StringUUID)
  723. created_at = db.Column(db.DateTime, nullable=False, server_default=db.text('CURRENT_TIMESTAMP(0)'))
  724. updated_at = db.Column(db.DateTime, nullable=False, server_default=db.text('CURRENT_TIMESTAMP(0)'))
  725. @property
  726. def from_account(self):
  727. account = db.session.query(Account).filter(Account.id == self.from_account_id).first()
  728. return account
  729. class MessageFile(db.Model):
  730. __tablename__ = 'message_files'
  731. __table_args__ = (
  732. db.PrimaryKeyConstraint('id', name='message_file_pkey'),
  733. db.Index('message_file_message_idx', 'message_id'),
  734. db.Index('message_file_created_by_idx', 'created_by')
  735. )
  736. id = db.Column(StringUUID, server_default=db.text('uuid_generate_v4()'))
  737. message_id = db.Column(StringUUID, nullable=False)
  738. type = db.Column(db.String(255), nullable=False)
  739. transfer_method = db.Column(db.String(255), nullable=False)
  740. url = db.Column(db.Text, nullable=True)
  741. belongs_to = db.Column(db.String(255), nullable=True)
  742. upload_file_id = db.Column(StringUUID, nullable=True)
  743. created_by_role = db.Column(db.String(255), nullable=False)
  744. created_by = db.Column(StringUUID, nullable=False)
  745. created_at = db.Column(db.DateTime, nullable=False, server_default=db.text('CURRENT_TIMESTAMP(0)'))
  746. class MessageAnnotation(db.Model):
  747. __tablename__ = 'message_annotations'
  748. __table_args__ = (
  749. db.PrimaryKeyConstraint('id', name='message_annotation_pkey'),
  750. db.Index('message_annotation_app_idx', 'app_id'),
  751. db.Index('message_annotation_conversation_idx', 'conversation_id'),
  752. db.Index('message_annotation_message_idx', 'message_id')
  753. )
  754. id = db.Column(StringUUID, server_default=db.text('uuid_generate_v4()'))
  755. app_id = db.Column(StringUUID, nullable=False)
  756. conversation_id = db.Column(StringUUID, db.ForeignKey('conversations.id'), nullable=True)
  757. message_id = db.Column(StringUUID, nullable=True)
  758. question = db.Column(db.Text, nullable=True)
  759. content = db.Column(db.Text, nullable=False)
  760. hit_count = db.Column(db.Integer, nullable=False, server_default=db.text('0'))
  761. account_id = db.Column(StringUUID, nullable=False)
  762. created_at = db.Column(db.DateTime, nullable=False, server_default=db.text('CURRENT_TIMESTAMP(0)'))
  763. updated_at = db.Column(db.DateTime, nullable=False, server_default=db.text('CURRENT_TIMESTAMP(0)'))
  764. @property
  765. def account(self):
  766. account = db.session.query(Account).filter(Account.id == self.account_id).first()
  767. return account
  768. @property
  769. def annotation_create_account(self):
  770. account = db.session.query(Account).filter(Account.id == self.account_id).first()
  771. return account
  772. class AppAnnotationHitHistory(db.Model):
  773. __tablename__ = 'app_annotation_hit_histories'
  774. __table_args__ = (
  775. db.PrimaryKeyConstraint('id', name='app_annotation_hit_histories_pkey'),
  776. db.Index('app_annotation_hit_histories_app_idx', 'app_id'),
  777. db.Index('app_annotation_hit_histories_account_idx', 'account_id'),
  778. db.Index('app_annotation_hit_histories_annotation_idx', 'annotation_id'),
  779. db.Index('app_annotation_hit_histories_message_idx', 'message_id'),
  780. )
  781. id = db.Column(StringUUID, server_default=db.text('uuid_generate_v4()'))
  782. app_id = db.Column(StringUUID, nullable=False)
  783. annotation_id = db.Column(StringUUID, nullable=False)
  784. source = db.Column(db.Text, nullable=False)
  785. question = db.Column(db.Text, nullable=False)
  786. account_id = db.Column(StringUUID, nullable=False)
  787. created_at = db.Column(db.DateTime, nullable=False, server_default=db.text('CURRENT_TIMESTAMP(0)'))
  788. score = db.Column(Float, nullable=False, server_default=db.text('0'))
  789. message_id = db.Column(StringUUID, nullable=False)
  790. annotation_question = db.Column(db.Text, nullable=False)
  791. annotation_content = db.Column(db.Text, nullable=False)
  792. @property
  793. def account(self):
  794. account = (db.session.query(Account)
  795. .join(MessageAnnotation, MessageAnnotation.account_id == Account.id)
  796. .filter(MessageAnnotation.id == self.annotation_id).first())
  797. return account
  798. @property
  799. def annotation_create_account(self):
  800. account = db.session.query(Account).filter(Account.id == self.account_id).first()
  801. return account
  802. class AppAnnotationSetting(db.Model):
  803. __tablename__ = 'app_annotation_settings'
  804. __table_args__ = (
  805. db.PrimaryKeyConstraint('id', name='app_annotation_settings_pkey'),
  806. db.Index('app_annotation_settings_app_idx', 'app_id')
  807. )
  808. id = db.Column(StringUUID, server_default=db.text('uuid_generate_v4()'))
  809. app_id = db.Column(StringUUID, nullable=False)
  810. score_threshold = db.Column(Float, nullable=False, server_default=db.text('0'))
  811. collection_binding_id = db.Column(StringUUID, nullable=False)
  812. created_user_id = db.Column(StringUUID, nullable=False)
  813. created_at = db.Column(db.DateTime, nullable=False, server_default=db.text('CURRENT_TIMESTAMP(0)'))
  814. updated_user_id = db.Column(StringUUID, nullable=False)
  815. updated_at = db.Column(db.DateTime, nullable=False, server_default=db.text('CURRENT_TIMESTAMP(0)'))
  816. @property
  817. def created_account(self):
  818. account = (db.session.query(Account)
  819. .join(AppAnnotationSetting, AppAnnotationSetting.created_user_id == Account.id)
  820. .filter(AppAnnotationSetting.id == self.annotation_id).first())
  821. return account
  822. @property
  823. def updated_account(self):
  824. account = (db.session.query(Account)
  825. .join(AppAnnotationSetting, AppAnnotationSetting.updated_user_id == Account.id)
  826. .filter(AppAnnotationSetting.id == self.annotation_id).first())
  827. return account
  828. @property
  829. def collection_binding_detail(self):
  830. from .dataset import DatasetCollectionBinding
  831. collection_binding_detail = (db.session.query(DatasetCollectionBinding)
  832. .filter(DatasetCollectionBinding.id == self.collection_binding_id).first())
  833. return collection_binding_detail
  834. class OperationLog(db.Model):
  835. __tablename__ = 'operation_logs'
  836. __table_args__ = (
  837. db.PrimaryKeyConstraint('id', name='operation_log_pkey'),
  838. db.Index('operation_log_account_action_idx', 'tenant_id', 'account_id', 'action')
  839. )
  840. id = db.Column(StringUUID, server_default=db.text('uuid_generate_v4()'))
  841. tenant_id = db.Column(StringUUID, nullable=False)
  842. account_id = db.Column(StringUUID, nullable=False)
  843. action = db.Column(db.String(255), nullable=False)
  844. content = db.Column(db.JSON)
  845. created_at = db.Column(db.DateTime, nullable=False, server_default=db.text('CURRENT_TIMESTAMP(0)'))
  846. created_ip = db.Column(db.String(255), nullable=False)
  847. updated_at = db.Column(db.DateTime, nullable=False, server_default=db.text('CURRENT_TIMESTAMP(0)'))
  848. class EndUser(UserMixin, db.Model):
  849. __tablename__ = 'end_users'
  850. __table_args__ = (
  851. db.PrimaryKeyConstraint('id', name='end_user_pkey'),
  852. db.Index('end_user_session_id_idx', 'session_id', 'type'),
  853. db.Index('end_user_tenant_session_id_idx', 'tenant_id', 'session_id', 'type'),
  854. )
  855. id = db.Column(StringUUID, server_default=db.text('uuid_generate_v4()'))
  856. tenant_id = db.Column(StringUUID, nullable=False)
  857. app_id = db.Column(StringUUID, nullable=True)
  858. type = db.Column(db.String(255), nullable=False)
  859. external_user_id = db.Column(db.String(255), nullable=True)
  860. name = db.Column(db.String(255))
  861. is_anonymous = db.Column(db.Boolean, nullable=False, server_default=db.text('true'))
  862. session_id = db.Column(db.String(255), nullable=False)
  863. created_at = db.Column(db.DateTime, nullable=False, server_default=db.text('CURRENT_TIMESTAMP(0)'))
  864. updated_at = db.Column(db.DateTime, nullable=False, server_default=db.text('CURRENT_TIMESTAMP(0)'))
  865. class Site(db.Model):
  866. __tablename__ = 'sites'
  867. __table_args__ = (
  868. db.PrimaryKeyConstraint('id', name='site_pkey'),
  869. db.Index('site_app_id_idx', 'app_id'),
  870. db.Index('site_code_idx', 'code', 'status')
  871. )
  872. id = db.Column(StringUUID, server_default=db.text('uuid_generate_v4()'))
  873. app_id = db.Column(StringUUID, nullable=False)
  874. title = db.Column(db.String(255), nullable=False)
  875. icon = db.Column(db.String(255))
  876. icon_background = db.Column(db.String(255))
  877. description = db.Column(db.Text)
  878. default_language = db.Column(db.String(255), nullable=False)
  879. copyright = db.Column(db.String(255))
  880. privacy_policy = db.Column(db.String(255))
  881. custom_disclaimer = db.Column(db.String(255), nullable=True)
  882. customize_domain = db.Column(db.String(255))
  883. customize_token_strategy = db.Column(db.String(255), nullable=False)
  884. prompt_public = db.Column(db.Boolean, nullable=False, server_default=db.text('false'))
  885. status = db.Column(db.String(255), nullable=False, server_default=db.text("'normal'::character varying"))
  886. created_at = db.Column(db.DateTime, nullable=False, server_default=db.text('CURRENT_TIMESTAMP(0)'))
  887. updated_at = db.Column(db.DateTime, nullable=False, server_default=db.text('CURRENT_TIMESTAMP(0)'))
  888. code = db.Column(db.String(255))
  889. @staticmethod
  890. def generate_code(n):
  891. while True:
  892. result = generate_string(n)
  893. while db.session.query(Site).filter(Site.code == result).count() > 0:
  894. result = generate_string(n)
  895. return result
  896. @property
  897. def app_base_url(self):
  898. return (
  899. current_app.config['APP_WEB_URL'] if current_app.config['APP_WEB_URL'] else request.host_url.rstrip('/'))
  900. class ApiToken(db.Model):
  901. __tablename__ = 'api_tokens'
  902. __table_args__ = (
  903. db.PrimaryKeyConstraint('id', name='api_token_pkey'),
  904. db.Index('api_token_app_id_type_idx', 'app_id', 'type'),
  905. db.Index('api_token_token_idx', 'token', 'type'),
  906. db.Index('api_token_tenant_idx', 'tenant_id', 'type')
  907. )
  908. id = db.Column(StringUUID, server_default=db.text('uuid_generate_v4()'))
  909. app_id = db.Column(StringUUID, nullable=True)
  910. tenant_id = db.Column(StringUUID, nullable=True)
  911. type = db.Column(db.String(16), nullable=False)
  912. token = db.Column(db.String(255), nullable=False)
  913. last_used_at = db.Column(db.DateTime, nullable=True)
  914. created_at = db.Column(db.DateTime, nullable=False, server_default=db.text('CURRENT_TIMESTAMP(0)'))
  915. @staticmethod
  916. def generate_api_key(prefix, n):
  917. while True:
  918. result = prefix + generate_string(n)
  919. while db.session.query(ApiToken).filter(ApiToken.token == result).count() > 0:
  920. result = prefix + generate_string(n)
  921. return result
  922. class UploadFile(db.Model):
  923. __tablename__ = 'upload_files'
  924. __table_args__ = (
  925. db.PrimaryKeyConstraint('id', name='upload_file_pkey'),
  926. db.Index('upload_file_tenant_idx', 'tenant_id')
  927. )
  928. id = db.Column(StringUUID, server_default=db.text('uuid_generate_v4()'))
  929. tenant_id = db.Column(StringUUID, nullable=False)
  930. storage_type = db.Column(db.String(255), nullable=False)
  931. key = db.Column(db.String(255), nullable=False)
  932. name = db.Column(db.String(255), nullable=False)
  933. size = db.Column(db.Integer, nullable=False)
  934. extension = db.Column(db.String(255), nullable=False)
  935. mime_type = db.Column(db.String(255), nullable=True)
  936. created_by_role = db.Column(db.String(255), nullable=False, server_default=db.text("'account'::character varying"))
  937. created_by = db.Column(StringUUID, nullable=False)
  938. created_at = db.Column(db.DateTime, nullable=False, server_default=db.text('CURRENT_TIMESTAMP(0)'))
  939. used = db.Column(db.Boolean, nullable=False, server_default=db.text('false'))
  940. used_by = db.Column(StringUUID, nullable=True)
  941. used_at = db.Column(db.DateTime, nullable=True)
  942. hash = db.Column(db.String(255), nullable=True)
  943. class ApiRequest(db.Model):
  944. __tablename__ = 'api_requests'
  945. __table_args__ = (
  946. db.PrimaryKeyConstraint('id', name='api_request_pkey'),
  947. db.Index('api_request_token_idx', 'tenant_id', 'api_token_id')
  948. )
  949. id = db.Column(StringUUID, nullable=False, server_default=db.text('uuid_generate_v4()'))
  950. tenant_id = db.Column(StringUUID, nullable=False)
  951. api_token_id = db.Column(StringUUID, nullable=False)
  952. path = db.Column(db.String(255), nullable=False)
  953. request = db.Column(db.Text, nullable=True)
  954. response = db.Column(db.Text, nullable=True)
  955. ip = db.Column(db.String(255), nullable=False)
  956. created_at = db.Column(db.DateTime, nullable=False, server_default=db.text('CURRENT_TIMESTAMP(0)'))
  957. class MessageChain(db.Model):
  958. __tablename__ = 'message_chains'
  959. __table_args__ = (
  960. db.PrimaryKeyConstraint('id', name='message_chain_pkey'),
  961. db.Index('message_chain_message_id_idx', 'message_id')
  962. )
  963. id = db.Column(StringUUID, nullable=False, server_default=db.text('uuid_generate_v4()'))
  964. message_id = db.Column(StringUUID, nullable=False)
  965. type = db.Column(db.String(255), nullable=False)
  966. input = db.Column(db.Text, nullable=True)
  967. output = db.Column(db.Text, nullable=True)
  968. created_at = db.Column(db.DateTime, nullable=False, server_default=db.func.current_timestamp())
  969. class MessageAgentThought(db.Model):
  970. __tablename__ = 'message_agent_thoughts'
  971. __table_args__ = (
  972. db.PrimaryKeyConstraint('id', name='message_agent_thought_pkey'),
  973. db.Index('message_agent_thought_message_id_idx', 'message_id'),
  974. db.Index('message_agent_thought_message_chain_id_idx', 'message_chain_id'),
  975. )
  976. id = db.Column(StringUUID, nullable=False, server_default=db.text('uuid_generate_v4()'))
  977. message_id = db.Column(StringUUID, nullable=False)
  978. message_chain_id = db.Column(StringUUID, nullable=True)
  979. position = db.Column(db.Integer, nullable=False)
  980. thought = db.Column(db.Text, nullable=True)
  981. tool = db.Column(db.Text, nullable=True)
  982. tool_labels_str = db.Column(db.Text, nullable=False, server_default=db.text("'{}'::text"))
  983. tool_meta_str = db.Column(db.Text, nullable=False, server_default=db.text("'{}'::text"))
  984. tool_input = db.Column(db.Text, nullable=True)
  985. observation = db.Column(db.Text, nullable=True)
  986. # plugin_id = db.Column(StringUUID, nullable=True) ## for future design
  987. tool_process_data = db.Column(db.Text, nullable=True)
  988. message = db.Column(db.Text, nullable=True)
  989. message_token = db.Column(db.Integer, nullable=True)
  990. message_unit_price = db.Column(db.Numeric, nullable=True)
  991. message_price_unit = db.Column(db.Numeric(10, 7), nullable=False, server_default=db.text('0.001'))
  992. message_files = db.Column(db.Text, nullable=True)
  993. answer = db.Column(db.Text, nullable=True)
  994. answer_token = db.Column(db.Integer, nullable=True)
  995. answer_unit_price = db.Column(db.Numeric, nullable=True)
  996. answer_price_unit = db.Column(db.Numeric(10, 7), nullable=False, server_default=db.text('0.001'))
  997. tokens = db.Column(db.Integer, nullable=True)
  998. total_price = db.Column(db.Numeric, nullable=True)
  999. currency = db.Column(db.String, nullable=True)
  1000. latency = db.Column(db.Float, nullable=True)
  1001. created_by_role = db.Column(db.String, nullable=False)
  1002. created_by = db.Column(StringUUID, nullable=False)
  1003. created_at = db.Column(db.DateTime, nullable=False, server_default=db.func.current_timestamp())
  1004. @property
  1005. def files(self) -> list:
  1006. if self.message_files:
  1007. return json.loads(self.message_files)
  1008. else:
  1009. return []
  1010. @property
  1011. def tools(self) -> list[str]:
  1012. return self.tool.split(";") if self.tool else []
  1013. @property
  1014. def tool_labels(self) -> dict:
  1015. try:
  1016. if self.tool_labels_str:
  1017. return json.loads(self.tool_labels_str)
  1018. else:
  1019. return {}
  1020. except Exception as e:
  1021. return {}
  1022. @property
  1023. def tool_meta(self) -> dict:
  1024. try:
  1025. if self.tool_meta_str:
  1026. return json.loads(self.tool_meta_str)
  1027. else:
  1028. return {}
  1029. except Exception as e:
  1030. return {}
  1031. @property
  1032. def tool_inputs_dict(self) -> dict:
  1033. tools = self.tools
  1034. try:
  1035. if self.tool_input:
  1036. data = json.loads(self.tool_input)
  1037. result = {}
  1038. for tool in tools:
  1039. if tool in data:
  1040. result[tool] = data[tool]
  1041. else:
  1042. if len(tools) == 1:
  1043. result[tool] = data
  1044. else:
  1045. result[tool] = {}
  1046. return result
  1047. else:
  1048. return {
  1049. tool: {} for tool in tools
  1050. }
  1051. except Exception as e:
  1052. return {}
  1053. @property
  1054. def tool_outputs_dict(self) -> dict:
  1055. tools = self.tools
  1056. try:
  1057. if self.observation:
  1058. data = json.loads(self.observation)
  1059. result = {}
  1060. for tool in tools:
  1061. if tool in data:
  1062. result[tool] = data[tool]
  1063. else:
  1064. if len(tools) == 1:
  1065. result[tool] = data
  1066. else:
  1067. result[tool] = {}
  1068. return result
  1069. else:
  1070. return {
  1071. tool: {} for tool in tools
  1072. }
  1073. except Exception as e:
  1074. if self.observation:
  1075. return {
  1076. tool: self.observation for tool in tools
  1077. }
  1078. class DatasetRetrieverResource(db.Model):
  1079. __tablename__ = 'dataset_retriever_resources'
  1080. __table_args__ = (
  1081. db.PrimaryKeyConstraint('id', name='dataset_retriever_resource_pkey'),
  1082. db.Index('dataset_retriever_resource_message_id_idx', 'message_id'),
  1083. )
  1084. id = db.Column(StringUUID, nullable=False, server_default=db.text('uuid_generate_v4()'))
  1085. message_id = db.Column(StringUUID, nullable=False)
  1086. position = db.Column(db.Integer, nullable=False)
  1087. dataset_id = db.Column(StringUUID, nullable=False)
  1088. dataset_name = db.Column(db.Text, nullable=False)
  1089. document_id = db.Column(StringUUID, nullable=False)
  1090. document_name = db.Column(db.Text, nullable=False)
  1091. data_source_type = db.Column(db.Text, nullable=False)
  1092. segment_id = db.Column(StringUUID, nullable=False)
  1093. score = db.Column(db.Float, nullable=True)
  1094. content = db.Column(db.Text, nullable=False)
  1095. hit_count = db.Column(db.Integer, nullable=True)
  1096. word_count = db.Column(db.Integer, nullable=True)
  1097. segment_position = db.Column(db.Integer, nullable=True)
  1098. index_node_hash = db.Column(db.Text, nullable=True)
  1099. retriever_from = db.Column(db.Text, nullable=False)
  1100. created_by = db.Column(StringUUID, nullable=False)
  1101. created_at = db.Column(db.DateTime, nullable=False, server_default=db.func.current_timestamp())
  1102. class Tag(db.Model):
  1103. __tablename__ = 'tags'
  1104. __table_args__ = (
  1105. db.PrimaryKeyConstraint('id', name='tag_pkey'),
  1106. db.Index('tag_type_idx', 'type'),
  1107. db.Index('tag_name_idx', 'name'),
  1108. )
  1109. TAG_TYPE_LIST = ['knowledge', 'app']
  1110. id = db.Column(StringUUID, server_default=db.text('uuid_generate_v4()'))
  1111. tenant_id = db.Column(StringUUID, nullable=True)
  1112. type = db.Column(db.String(16), nullable=False)
  1113. name = db.Column(db.String(255), nullable=False)
  1114. created_by = db.Column(StringUUID, nullable=False)
  1115. created_at = db.Column(db.DateTime, nullable=False, server_default=db.text('CURRENT_TIMESTAMP(0)'))
  1116. class TagBinding(db.Model):
  1117. __tablename__ = 'tag_bindings'
  1118. __table_args__ = (
  1119. db.PrimaryKeyConstraint('id', name='tag_binding_pkey'),
  1120. db.Index('tag_bind_target_id_idx', 'target_id'),
  1121. db.Index('tag_bind_tag_id_idx', 'tag_id'),
  1122. )
  1123. id = db.Column(StringUUID, server_default=db.text('uuid_generate_v4()'))
  1124. tenant_id = db.Column(StringUUID, nullable=True)
  1125. tag_id = db.Column(StringUUID, nullable=True)
  1126. target_id = db.Column(StringUUID, nullable=True)
  1127. created_by = db.Column(StringUUID, nullable=False)
  1128. created_at = db.Column(db.DateTime, nullable=False, server_default=db.text('CURRENT_TIMESTAMP(0)'))