model.py 55 KB

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