model.py 58 KB

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