import json from sqlalchemy import ForeignKey from core.tools.entities.common_entities import I18nObject from core.tools.entities.tool_bundle import ApiBasedToolBundle from core.tools.entities.tool_entities import ApiProviderSchemaType from extensions.ext_database import db from models import StringUUID from models.model import Account, App, Tenant class BuiltinToolProvider(db.Model): """ This table stores the tool provider information for built-in tools for each tenant. """ __tablename__ = 'tool_builtin_providers' __table_args__ = ( db.PrimaryKeyConstraint('id', name='tool_builtin_provider_pkey'), # one tenant can only have one tool provider with the same name db.UniqueConstraint('tenant_id', 'provider', name='unique_builtin_tool_provider') ) # id of the tool provider id = db.Column(StringUUID, server_default=db.text('uuid_generate_v4()')) # id of the tenant tenant_id = db.Column(StringUUID, nullable=True) # who created this tool provider user_id = db.Column(StringUUID, nullable=False) # name of the tool provider provider = db.Column(db.String(40), nullable=False) # credential of the tool provider encrypted_credentials = db.Column(db.Text, nullable=True) created_at = db.Column(db.DateTime, nullable=False, server_default=db.text('CURRENT_TIMESTAMP(0)')) updated_at = db.Column(db.DateTime, nullable=False, server_default=db.text('CURRENT_TIMESTAMP(0)')) @property def credentials(self) -> dict: return json.loads(self.encrypted_credentials) class PublishedAppTool(db.Model): """ The table stores the apps published as a tool for each person. """ __tablename__ = 'tool_published_apps' __table_args__ = ( db.PrimaryKeyConstraint('id', name='published_app_tool_pkey'), db.UniqueConstraint('app_id', 'user_id', name='unique_published_app_tool') ) # id of the tool provider id = db.Column(StringUUID, server_default=db.text('uuid_generate_v4()')) # id of the app app_id = db.Column(StringUUID, ForeignKey('apps.id'), nullable=False) # who published this tool user_id = db.Column(StringUUID, nullable=False) # description of the tool, stored in i18n format, for human description = db.Column(db.Text, nullable=False) # llm_description of the tool, for LLM llm_description = db.Column(db.Text, nullable=False) # query description, query will be seem as a parameter of the tool, to describe this parameter to llm, we need this field query_description = db.Column(db.Text, nullable=False) # query name, the name of the query parameter query_name = db.Column(db.String(40), nullable=False) # name of the tool provider tool_name = db.Column(db.String(40), nullable=False) # author author = db.Column(db.String(40), nullable=False) created_at = db.Column(db.DateTime, nullable=False, server_default=db.text('CURRENT_TIMESTAMP(0)')) updated_at = db.Column(db.DateTime, nullable=False, server_default=db.text('CURRENT_TIMESTAMP(0)')) @property def description_i18n(self) -> I18nObject: return I18nObject(**json.loads(self.description)) @property def app(self) -> App: return db.session.query(App).filter(App.id == self.app_id).first() class ApiToolProvider(db.Model): """ The table stores the api providers. """ __tablename__ = 'tool_api_providers' __table_args__ = ( db.PrimaryKeyConstraint('id', name='tool_api_provider_pkey'), db.UniqueConstraint('name', 'tenant_id', name='unique_api_tool_provider') ) id = db.Column(StringUUID, server_default=db.text('uuid_generate_v4()')) # name of the api provider name = db.Column(db.String(40), nullable=False) # icon icon = db.Column(db.String(255), nullable=False) # original schema schema = db.Column(db.Text, nullable=False) schema_type_str = db.Column(db.String(40), nullable=False) # who created this tool user_id = db.Column(StringUUID, nullable=False) # tenant id tenant_id = db.Column(StringUUID, nullable=False) # description of the provider description = db.Column(db.Text, nullable=False) # json format tools tools_str = db.Column(db.Text, nullable=False) # json format credentials credentials_str = db.Column(db.Text, nullable=False) # privacy policy privacy_policy = db.Column(db.String(255), nullable=True) # custom_disclaimer custom_disclaimer = db.Column(db.String(255), nullable=True) created_at = db.Column(db.DateTime, nullable=False, server_default=db.text('CURRENT_TIMESTAMP(0)')) updated_at = db.Column(db.DateTime, nullable=False, server_default=db.text('CURRENT_TIMESTAMP(0)')) @property def schema_type(self) -> ApiProviderSchemaType: return ApiProviderSchemaType.value_of(self.schema_type_str) @property def tools(self) -> list[ApiBasedToolBundle]: return [ApiBasedToolBundle(**tool) for tool in json.loads(self.tools_str)] @property def credentials(self) -> dict: return json.loads(self.credentials_str) @property def user(self) -> Account: return db.session.query(Account).filter(Account.id == self.user_id).first() @property def tenant(self) -> Tenant: return db.session.query(Tenant).filter(Tenant.id == self.tenant_id).first() class ToolModelInvoke(db.Model): """ store the invoke logs from tool invoke """ __tablename__ = "tool_model_invokes" __table_args__ = ( db.PrimaryKeyConstraint('id', name='tool_model_invoke_pkey'), ) id = db.Column(StringUUID, server_default=db.text('uuid_generate_v4()')) # who invoke this tool user_id = db.Column(StringUUID, nullable=False) # tenant id tenant_id = db.Column(StringUUID, nullable=False) # provider provider = db.Column(db.String(40), nullable=False) # type tool_type = db.Column(db.String(40), nullable=False) # tool name tool_name = db.Column(db.String(40), nullable=False) # invoke parameters model_parameters = db.Column(db.Text, nullable=False) # prompt messages prompt_messages = db.Column(db.Text, nullable=False) # invoke response model_response = db.Column(db.Text, nullable=False) prompt_tokens = db.Column(db.Integer, nullable=False, server_default=db.text('0')) answer_tokens = db.Column(db.Integer, nullable=False, server_default=db.text('0')) answer_unit_price = db.Column(db.Numeric(10, 4), nullable=False) answer_price_unit = db.Column(db.Numeric(10, 7), nullable=False, server_default=db.text('0.001')) provider_response_latency = db.Column(db.Float, nullable=False, server_default=db.text('0')) total_price = db.Column(db.Numeric(10, 7)) currency = db.Column(db.String(255), nullable=False) created_at = db.Column(db.DateTime, nullable=False, server_default=db.text('CURRENT_TIMESTAMP(0)')) updated_at = db.Column(db.DateTime, nullable=False, server_default=db.text('CURRENT_TIMESTAMP(0)')) class ToolConversationVariables(db.Model): """ store the conversation variables from tool invoke """ __tablename__ = "tool_conversation_variables" __table_args__ = ( db.PrimaryKeyConstraint('id', name='tool_conversation_variables_pkey'), # add index for user_id and conversation_id db.Index('user_id_idx', 'user_id'), db.Index('conversation_id_idx', 'conversation_id'), ) id = db.Column(StringUUID, server_default=db.text('uuid_generate_v4()')) # conversation user id user_id = db.Column(StringUUID, nullable=False) # tenant id tenant_id = db.Column(StringUUID, nullable=False) # conversation id conversation_id = db.Column(StringUUID, nullable=False) # variables pool variables_str = db.Column(db.Text, nullable=False) created_at = db.Column(db.DateTime, nullable=False, server_default=db.text('CURRENT_TIMESTAMP(0)')) updated_at = db.Column(db.DateTime, nullable=False, server_default=db.text('CURRENT_TIMESTAMP(0)')) @property def variables(self) -> dict: return json.loads(self.variables_str) class ToolFile(db.Model): """ store the file created by agent """ __tablename__ = "tool_files" __table_args__ = ( db.PrimaryKeyConstraint('id', name='tool_file_pkey'), # add index for conversation_id db.Index('tool_file_conversation_id_idx', 'conversation_id'), ) id = db.Column(StringUUID, server_default=db.text('uuid_generate_v4()')) # conversation user id user_id = db.Column(StringUUID, nullable=False) # tenant id tenant_id = db.Column(StringUUID, nullable=False) # conversation id conversation_id = db.Column(StringUUID, nullable=True) # file key file_key = db.Column(db.String(255), nullable=False) # mime type mimetype = db.Column(db.String(255), nullable=False) # original url original_url = db.Column(db.String(255), nullable=True)