model.py 56 KB

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