v1.0

assets/schema/upgrade/v0_6_0/upgrade_to_v0.6.0.sql

+USE dbgpt;
+-- chat_history
+ALTER TABLE  chat_history ADD COLUMN `app_code` varchar(255) DEFAULT NULL COMMENT 'App unique code' after `message_ids`;
+
+-- gpts_app
+ALTER TABLE  gpts_app ADD COLUMN `published` varchar(64) DEFAULT 'false' COMMENT 'Has it been published?';
+ALTER TABLE  gpts_app ADD COLUMN `param_need` text DEFAULT NULL COMMENT 'Parameter information supported by the application';
+ALTER TABLE  gpts_app ADD COLUMN `admins` text DEFAULT NULL COMMENT 'administrator';
+
+
+-- connect_config
+ALTER TABLE  connect_config ADD COLUMN `user_name` varchar(255) DEFAULT NULL COMMENT 'user name';
+ALTER TABLE  connect_config ADD COLUMN `user_id` varchar(255) DEFAULT NULL COMMENT 'user id';
+
+-- document_chunk
+ALTER TABLE  document_chunk ADD COLUMN `questions` text DEFAULT NULL COMMENT 'chunk related questions';
+
+-- knowledge_document
+ALTER TABLE  knowledge_document ADD COLUMN `doc_token` varchar(100) DEFAULT NULL COMMENT 'doc token';
+ALTER TABLE  knowledge_document ADD COLUMN `questions` text DEFAULT NULL COMMENT 'document related questions';
+
+-- gpts_messages
+ALTER TABLE  gpts_messages ADD COLUMN `is_success` int(4)  NULL DEFAULT 0 COMMENT 'agent message is success';
+ALTER TABLE  gpts_messages ADD COLUMN `app_code` varchar(255) NOT NULL COMMENT 'Current AI assistant code';
+ALTER TABLE  gpts_messages ADD COLUMN `app_name` varchar(255) NOT NULL COMMENT 'Current AI assistant name';
+ALTER TABLE  gpts_messages ADD COLUMN `resource_info` text DEFAULT NULL  COMMENT 'Current conversation resource info';
+
+-- prompt_manage
+ALTER TABLE  prompt_manage ADD COLUMN `prompt_code` varchar(255) NULL COMMENT 'Prompt code';
+ALTER TABLE  prompt_manage ADD COLUMN `response_schema` text  NULL COMMENT 'Prompt response schema';
+ALTER TABLE  prompt_manage ADD COLUMN `user_code` varchar(128)  NULL COMMENT 'User code';
+
+-- chat_feed_back
+ALTER TABLE  chat_feed_back ADD COLUMN `message_id` varchar(255)  NULL COMMENT 'Message id';
+ALTER TABLE  chat_feed_back ADD COLUMN `feedback_type` varchar(50)  NULL COMMENT 'Feedback type like or unlike';
+ALTER TABLE  chat_feed_back ADD COLUMN `reason_types` varchar(255)  NULL COMMENT 'Feedback reason categories';
+ALTER TABLE  chat_feed_back ADD COLUMN `user_code` varchar(128)  NULL COMMENT 'User code';
+ALTER TABLE  chat_feed_back ADD COLUMN `remark` text NULL COMMENT 'Feedback remark';
+
+-- dbgpt_serve_flow
+ALTER TABLE dbgpt_serve_flow ADD COLUMN `variables` text DEFAULT NULL COMMENT 'Flow variables, JSON format';
+
+-- dbgpt.recommend_question definition
+CREATE TABLE `recommend_question` (
+  `id` bigint(20) unsigned NOT NULL AUTO_INCREMENT COMMENT 'autoincrement id',
+  `gmt_create` timestamp NOT NULL DEFAULT CURRENT_TIMESTAMP COMMENT 'create time',
+  `gmt_modified` timestamp NOT NULL DEFAULT CURRENT_TIMESTAMP ON UPDATE CURRENT_TIMESTAMP COMMENT 'last update time',
+  `app_code` varchar(255) DEFAULT NULL COMMENT 'Current AI assistant code',
+  `question` text DEFAULT NULL COMMENT 'question',
+  `user_code` int(11) DEFAULT NULL COMMENT 'user code',
+  `sys_code` varchar(255) DEFAULT NULL COMMENT 'system app code',
+  `valid` varchar(10) DEFAULT 'true' COMMENT 'is it effective，true/false',
+  `chat_mode` varchar(255) DEFAULT NULL COMMENT 'Conversation scene mode，chat_knowledge...',
+  `params` text DEFAULT NULL COMMENT 'question param',
+  `is_hot_question` varchar(10) DEFAULT 'false' COMMENT 'Is it a popular recommendation question?',
+  PRIMARY KEY (`id`),
+  KEY `idx_rec_q_app_code` (`app_code`)
+) ENGINE=InnoDB AUTO_INCREMENT=1 DEFAULT CHARSET=utf8mb4 COLLATE=utf8mb4_unicode_ci COMMENT="AI application related recommendation issues";
+
+-- dbgpt.user_recent_apps definition
+CREATE TABLE `user_recent_apps` (
+  `id` bigint(20) unsigned NOT NULL AUTO_INCREMENT COMMENT 'autoincrement id',
+  `gmt_create` timestamp NOT NULL DEFAULT CURRENT_TIMESTAMP COMMENT 'create time',
+  `gmt_modified` timestamp NOT NULL DEFAULT CURRENT_TIMESTAMP ON UPDATE CURRENT_TIMESTAMP COMMENT 'last update time',
+  `app_code` varchar(255) DEFAULT NULL COMMENT 'AI assistant code',
+  `last_accessed` timestamp NULL DEFAULT NULL COMMENT 'User recent usage time',
+  `user_code` varchar(255) DEFAULT NULL COMMENT 'user code',
+  `sys_code` varchar(255) DEFAULT NULL COMMENT 'system app code',
+  PRIMARY KEY (`id`),
+  KEY `idx_user_r_app_code` (`app_code`),
+  KEY `idx_last_accessed` (`last_accessed`),
+  KEY `idx_user_code` (`user_code`)
+) ENGINE=InnoDB AUTO_INCREMENT=1 DEFAULT CHARSET=utf8mb4 COLLATE=utf8mb4_unicode_ci COMMENT='User recently used apps';
+
+-- dbgpt.dbgpt_serve_file definition
+CREATE TABLE `dbgpt_serve_file` (
+  `id` int NOT NULL AUTO_INCREMENT COMMENT 'Auto increment id',
+  `bucket` varchar(255) NOT NULL COMMENT 'Bucket name',
+  `file_id` varchar(255) NOT NULL COMMENT 'File id',
+  `file_name` varchar(256) NOT NULL COMMENT 'File name',
+  `file_size` int DEFAULT NULL COMMENT 'File size',
+  `storage_type` varchar(32) NOT NULL COMMENT 'Storage type',
+  `storage_path` varchar(512) NOT NULL COMMENT 'Storage path',
+  `uri` varchar(512) NOT NULL COMMENT 'File URI',
+  `custom_metadata` text DEFAULT NULL COMMENT 'Custom metadata, JSON format',
+  `file_hash` varchar(128) DEFAULT NULL COMMENT 'File hash',
+  `user_name` varchar(128) DEFAULT NULL COMMENT 'User name',
+  `sys_code` varchar(128) DEFAULT NULL COMMENT 'System code',
+  `gmt_created` datetime DEFAULT CURRENT_TIMESTAMP COMMENT 'Record creation time',
+  `gmt_modified` datetime DEFAULT CURRENT_TIMESTAMP ON UPDATE CURRENT_TIMESTAMP COMMENT 'Record update time',
+  PRIMARY KEY (`id`),
+  UNIQUE KEY `uk_bucket_file_id` (`bucket`, `file_id`)
+) ENGINE=InnoDB AUTO_INCREMENT=1 DEFAULT CHARSET=utf8mb4 COLLATE=utf8mb4_unicode_ci;
+
+-- dbgpt.dbgpt_serve_variables definition
+CREATE TABLE `dbgpt_serve_variables` (
+  `id` int NOT NULL AUTO_INCREMENT COMMENT 'Auto increment id',
+  `key` varchar(128) NOT NULL COMMENT 'Variable key',
+  `name` varchar(128) DEFAULT NULL COMMENT 'Variable name',
+  `label` varchar(128) DEFAULT NULL COMMENT 'Variable label',
+  `value` text DEFAULT NULL COMMENT 'Variable value, JSON format',
+  `value_type` varchar(32) DEFAULT NULL COMMENT 'Variable value type(string, int, float, bool)',
+  `category` varchar(32) DEFAULT 'common' COMMENT 'Variable category(common or secret)',
+  `encryption_method` varchar(32) DEFAULT NULL COMMENT 'Variable encryption method(fernet, simple, rsa, aes)',
+  `salt` varchar(128) DEFAULT NULL COMMENT 'Variable salt',
+  `scope` varchar(32) DEFAULT 'global' COMMENT 'Variable scope(global,flow,app,agent,datasource,flow_priv,agent_priv, ""etc)',
+  `scope_key` varchar(256) DEFAULT NULL COMMENT 'Variable scope key, default is empty, for scope is "flow_priv", the scope_key is dag id of flow',
+  `enabled` int DEFAULT 1 COMMENT 'Variable enabled, 0: disabled, 1: enabled',
+  `description` text DEFAULT NULL COMMENT 'Variable description',
+  `user_name` varchar(128) DEFAULT NULL COMMENT 'User name',
+  `sys_code` varchar(128) DEFAULT NULL COMMENT 'System code',
+  `gmt_created` datetime DEFAULT CURRENT_TIMESTAMP COMMENT 'Record creation time',
+  `gmt_modified` datetime DEFAULT CURRENT_TIMESTAMP ON UPDATE CURRENT_TIMESTAMP COMMENT 'Record update time',
+  PRIMARY KEY (`id`),
+  KEY `ix_your_table_name_key` (`key`),
+  KEY `ix_your_table_name_name` (`name`)
+) ENGINE=InnoDB AUTO_INCREMENT=1 DEFAULT CHARSET=utf8mb4 COLLATE=utf8mb4_unicode_ci;
+
+-- dbgpt.dbgpt_serve_dbgpts_my definition
+CREATE TABLE `dbgpt_serve_dbgpts_my` (
+  `id` int NOT NULL AUTO_INCREMENT COMMENT 'autoincrement id',
+  `name` varchar(255)  NOT NULL COMMENT 'plugin name',
+  `user_name` varchar(255)  DEFAULT NULL COMMENT 'user name',
+  `file_name` varchar(255)  NOT NULL COMMENT 'plugin package file name',
+  `type` varchar(255)  DEFAULT NULL COMMENT 'plugin type',
+  `version` varchar(255)  DEFAULT NULL COMMENT 'plugin version',
+  `use_count` int DEFAULT NULL COMMENT 'plugin total use count',
+  `succ_count` int DEFAULT NULL COMMENT 'plugin total success count',
+  `sys_code` varchar(128) DEFAULT NULL COMMENT 'System code',
+  `gmt_created` TIMESTAMP DEFAULT CURRENT_TIMESTAMP COMMENT 'plugin install time',
+  `gmt_modified` TIMESTAMP DEFAULT CURRENT_TIMESTAMP ON UPDATE CURRENT_TIMESTAMP COMMENT 'update time',
+  PRIMARY KEY (`id`),
+  UNIQUE KEY `name` (`name`, `user_name`),
+  KEY `ix_my_plugin_sys_code` (`sys_code`)
+) ENGINE=InnoDB AUTO_INCREMENT=1 DEFAULT CHARSET=utf8mb4 COLLATE=utf8mb4_unicode_ci;
+
+-- dbgpt.dbgpt_serve_dbgpts_hub definition
+CREATE TABLE `dbgpt_serve_dbgpts_hub` (
+  `id` int NOT NULL AUTO_INCREMENT COMMENT 'autoincrement id',
+  `name` varchar(255) NOT NULL COMMENT 'plugin name',
+  `description` varchar(255)  NULL COMMENT 'plugin description',
+  `author` varchar(255) DEFAULT NULL COMMENT 'plugin author',
+  `email` varchar(255) DEFAULT NULL COMMENT 'plugin author email',
+  `type` varchar(255) DEFAULT NULL COMMENT 'plugin type',
+  `version` varchar(255) DEFAULT NULL COMMENT 'plugin version',
+  `storage_channel` varchar(255) DEFAULT NULL COMMENT 'plugin storage channel',
+  `storage_url` varchar(255) DEFAULT NULL COMMENT 'plugin download url',
+  `download_param` varchar(255) DEFAULT NULL COMMENT 'plugin download param',
+  `gmt_created` TIMESTAMP DEFAULT CURRENT_TIMESTAMP COMMENT 'plugin upload time',
+  `gmt_modified` TIMESTAMP    DEFAULT CURRENT_TIMESTAMP ON UPDATE CURRENT_TIMESTAMP COMMENT 'update time',
+  `installed` int DEFAULT NULL COMMENT 'plugin already installed count',
+  PRIMARY KEY (`id`),
+  UNIQUE KEY `name` (`name`)
+) ENGINE=InnoDB AUTO_INCREMENT=1 DEFAULT CHARSET=utf8mb4 COLLATE=utf8mb4_unicode_ci;
+

assets/schema/upgrade/v0_6_1/upgrade_to_0.6.1.sql

+USE dbgpt;
+
+-- Modify doc_token column to be nullable in knowledge_document table
+ALTER TABLE `knowledge_document`
+MODIFY COLUMN `doc_token` varchar(100) NULL COMMENT 'doc token';
+
+-- Change meta_info column type from varchar(200) to text in document_chunk table
+ALTER TABLE `document_chunk`
+MODIFY COLUMN `meta_info` text NOT NULL COMMENT 'metadata info';
+
+-- Change message_detail column type from text to longtext in chat_history_message table
+ALTER TABLE `chat_history_message`
+MODIFY COLUMN `message_detail` longtext COLLATE utf8mb4_unicode_ci COMMENT 'Message details, json format';
\ No newline at end of file

assets/schema/upgrade/v0_6_2/upgrade_to_0.6.2.sql

+USE dbgpt;
+
+-- Modify sys_code column to be nullable in gpts_app_collection table
+ALTER TABLE `gpts_app_collection`
+MODIFY COLUMN `sys_code` varchar(255) NULL COMMENT 'system app code';
+
+-- Change app_code to NOT NULL and sys_code to nullable in recommend_question table
+ALTER TABLE `recommend_question`
+MODIFY COLUMN `app_code` varchar(255) NOT NULL COMMENT 'Current AI assistant code',
+MODIFY COLUMN `sys_code` varchar(255) NULL COMMENT 'system app code';
+
+-- Change app_code to NOT NULL in user_recent_apps table
+ALTER TABLE `user_recent_apps`
+MODIFY COLUMN `app_code` varchar(255) NOT NULL COMMENT 'AI assistant code';
\ No newline at end of file

assets/schema/upgrade/v0_6_3/upgrade_to_0.6.3.sql

+-- There are no changes from 0.6.2 to 0.6.3
\ No newline at end of file

assets/schema/upgrade/v0_7_0/upgrade_to_v0.7.0.sql

+-- From 0.6.3 to 0.7.0, we have the following changes:
+USE dbgpt;
+
+-- connect_config
+ALTER TABLE `connect_config`
+    ADD COLUMN `gmt_created` datetime DEFAULT CURRENT_TIMESTAMP COMMENT 'Record creation time',
+    ADD COLUMN `gmt_modified` datetime DEFAULT CURRENT_TIMESTAMP ON UPDATE CURRENT_TIMESTAMP COMMENT 'Record update time',
+    ADD COLUMN `ext_config` text COMMENT 'Extended configuration, json format';
+
+-- dbgpt_serve_model, Store the model information of the model worker
+CREATE TABLE `dbgpt_serve_model` (
+  `id` int NOT NULL AUTO_INCREMENT COMMENT 'Auto increment id',
+  `host` varchar(255) NOT NULL COMMENT 'The model worker host',
+  `port` int NOT NULL COMMENT 'The model worker port',
+  `model` varchar(255) NOT NULL COMMENT 'The model name',
+  `provider` varchar(255) NOT NULL COMMENT 'The model provider',
+  `worker_type` varchar(255) NOT NULL COMMENT 'The worker type',
+  `params` text NOT NULL COMMENT 'The model parameters, JSON format',
+  `enabled` int DEFAULT 1 COMMENT 'Whether the model is enabled, if it is enabled, it will be started when the system starts, 1 is enabled, 0 is disabled',
+  `worker_name` varchar(255) DEFAULT NULL COMMENT 'The worker name',
+  `description` text DEFAULT NULL COMMENT 'The model description',
+  `user_name` varchar(128) DEFAULT NULL COMMENT 'User name',
+  `sys_code` varchar(128) DEFAULT NULL COMMENT 'System code',
+  `gmt_created` datetime DEFAULT CURRENT_TIMESTAMP COMMENT 'Record creation time',
+  `gmt_modified` datetime DEFAULT CURRENT_TIMESTAMP ON UPDATE CURRENT_TIMESTAMP COMMENT 'Record update time',
+  PRIMARY KEY (`id`),
+  KEY `idx_user_name` (`user_name`),
+  KEY `idx_sys_code` (`sys_code`),
+  UNIQUE KEY `uk_model_provider_type` (`model`, `provider`, `worker_type`)
+) ENGINE=InnoDB AUTO_INCREMENT=1 DEFAULT CHARSET=utf8mb4 COLLATE=utf8mb4_unicode_ci COMMENT='Model persistence table';
+
+ALTER TABLE `recommend_question`
+MODIFY COLUMN `user_code` varchar(255) NULL COMMENT 'user code';
+

assets/schema/upgrade/v0_7_1/upgrade_to_v0.7.1.sql

+-- From 0.7.0 to 0.7.1, we have the following changes:
+USE dbgpt;
+
+-- Change message_detail column type from text to longtext in chat_history_message table
+ALTER TABLE `gpts_messages`
+    MODIFY COLUMN `action_report` longtext COMMENT 'Current conversation action report';

configs/dbgpt-app-config.example.toml

+[system]
+# Load language from environment variable(It is set by the hook)
+language = "${env:DBGPT_LANG:-zh}"
+log_level = "INFO"
+api_keys = []
+encrypt_key = "your_secret_key"
+
+# Server Configurations
+[service.web]
+host = "0.0.0.0"
+port = 5670
+
+[service.web.database]
+type = "sqlite"
+path = "pilot/meta_data/dbgpt.db"
+
+[app]
+temperature = 0.6
+
+[[app.configs]]
+name = "chat_excel"
+temperature = 0.1
+duckdb_extensions_dir = []
+force_install = true
+
+[[app.configs]]
+name = "chat_normal"
+memory = {type="token", max_token_limit=20000}
+
+[[app.configs]]
+name = "chat_with_db_qa"
+schema_retrieve_top_k = 50
+memory = {type="token", max_token_limit=20000}
+
+# Model Configurations
+[models]
+[[models.llms]]
+name = "${env:LLM_MODEL_NAME:-gpt-4o}"
+provider = "${env:LLM_MODEL_PROVIDER:-proxy/openai}"
+api_base = "${env:OPENAI_API_BASE:-https://api.openai.com/v1}"
+api_key = "${env:OPENAI_API_KEY}"
+
+[[models.embeddings]]
+name = "${env:EMBEDDING_MODEL_NAME:-text-embedding-3-small}"
+provider = "${env:EMBEDDING_MODEL_PROVIDER:-proxy/openai}"
+api_url = "${env:EMBEDDING_MODEL_API_URL:-https://api.openai.com/v1/embeddings}"
+api_key = "${env:OPENAI_API_KEY}"

configs/dbgpt-bm25-rag.toml

+[system]
+# Load language from environment variable(It is set by the hook)
+language = "${env:DBGPT_LANG:-zh}"
+log_level = "INFO"
+api_keys = []
+encrypt_key = "your_secret_key"
+
+# Server Configurations
+[service.web]
+host = "0.0.0.0"
+port = 5670
+
+[service.web.database]
+type = "sqlite"
+path = "pilot/meta_data/dbgpt.db"
+
+
+[rag]
+chunk_size=1000
+chunk_overlap=100
+similarity_top_k=5
+similarity_score_threshold=0.0
+max_chunks_once_load=10
+max_threads=1
+rerank_top_k=3
+
+[rag.storage]
+[rag.storage.vector]
+type = "chroma"
+persist_path = "pilot/data"
+
+[rag.storage.full_text]
+type = "elasticsearch"
+host="127.0.0.1"
+port=9200
+
+
+# Model Configurations
+[models]
+[[models.llms]]
+name = "${env:LLM_MODEL_NAME:-gpt-4o}"
+provider = "${env:LLM_MODEL_PROVIDER:-proxy/openai}"
+api_base = "${env:OPENAI_API_BASE:-https://api.openai.com/v1}"
+api_key = "${env:OPENAI_API_KEY}"
+
+[[models.embeddings]]
+name = "${env:EMBEDDING_MODEL_NAME:-text-embedding-3-small}"
+provider = "${env:EMBEDDING_MODEL_PROVIDER:-proxy/openai}"
+api_url = "${env:EMBEDDING_MODEL_API_URL:-https://api.openai.com/v1/embeddings}"
+api_key = "${env:OPENAI_API_KEY}"

configs/dbgpt-local-glm.toml

+[system]
+# Load language from environment variable(It is set by the hook)
+language = "${env:DBGPT_LANG:-zh}"
+api_keys = []
+encrypt_key = "your_secret_key"
+
+# Server Configurations
+[service.web]
+host = "0.0.0.0"
+port = 5670
+
+[service.web.database]
+type = "sqlite"
+path = "pilot/meta_data/dbgpt.db"
+
+[rag.storage]
+[rag.storage.vector]
+type = "chroma"
+persist_path = "pilot/data"
+
+# Model Configurations
+[models]
+[[models.llms]]
+name = "THUDM/glm-4-9b-chat"
+provider = "hf"
+# If not provided, the model will be downloaded from the Hugging Face model hub
+# uncomment the following line to specify the model path in the local file system
+# path = "the-model-path-in-the-local-file-system"
+path = "models/THUDM/glm-4-9b-chat"
+
+[[models.embeddings]]
+name = "BAAI/bge-large-zh-v1.5"
+provider = "hf"
+# If not provided, the model will be downloaded from the Hugging Face model hub
+# uncomment the following line to specify the model path in the local file system
+# path = "the-model-path-in-the-local-file-system"
+path = "models/BAAI/bge-large-zh-v1.5"