Update operation guide in UI and config file.

666ghj
Commit 9d6e4946e8755d6bb90a56cfbac07086cd5aec51 9d6e4946 1 parent 403dbbd2
Showing 3 changed files with 47 additions and 54 deletions
.env.example
config.py
templates/index.html
--- a/.env.example
View file @9d6e494
+++ b/.env.example
View file @9d6e494
@@ -21,55 +21,43 @@ DB_CHARSET=utf8mb4
 DB_DIALECT=postgresql
 # ======================= LLM 相关 =======================
+# 您可以更改每个部分LLM使用的API，🚩只要兼容OpenAI请求格式都可以，定义好KEY、BASE_URL与MODEL_NAME即可正常使用。
+# 重要提醒：我们强烈推荐您先使用推荐的配置申请API，先跑通再进行您的更改！
 # 我们的LLM模型API赞助商有：https://share.302.ai/P66Qe3、https://aihubmix.com/?aff=8Ds9，提供了非常全面的模型api
-# Insight Agent（推荐Kimi，https://platform.moonshot.cn/）API密钥，用于主LLM
+# Insight Agent（推荐kimi-k2，官方申请地址：https://platform.moonshot.cn/）
 INSIGHT_ENGINE_API_KEY=
-# Insight Agent LLM接口BaseUrl，可自定义厂商API
 INSIGHT_ENGINE_BASE_URL=
-# Insight Agent LLM模型名称，如kimi-k2-0711-preview
 INSIGHT_ENGINE_MODEL_NAME=
-# Media Agent（推荐Gemini，推荐中转厂商 https://aihubmix.com/?aff=8Ds9）API密钥
+# Media Agent（推荐Gemini-2.5-pro，中转厂商申请地址：https://aihubmix.com/?aff=8Ds9）
 MEDIA_ENGINE_API_KEY=
-# Media Agent LLM接口BaseUrl
 MEDIA_ENGINE_BASE_URL=
-# Media Agent LLM模型名称，如gemini-2.5-pro
 MEDIA_ENGINE_MODEL_NAME=
-# MindSpider Agent API密钥（推荐Deepseek）
-MINDSPIDER_API_KEY=
-# MindSpider LLM接口BaseUrl
-MINDSPIDER_BASE_URL=
-# MindSpider LLM模型名称，如deepseek-chat
-MINDSPIDER_MODEL_NAME=
-
-# Query Agent（推荐DeepSeek，https://www.deepseek.com/）API密钥
+# Query Agent（推荐deepseek-chat，官方申请地址：https://platform.deepseek.com/）
 QUERY_ENGINE_API_KEY=
-# Query Agent LLM接口BaseUrl
 QUERY_ENGINE_BASE_URL=
-# Query Agent LLM模型，如deepseek-reasoner
 QUERY_ENGINE_MODEL_NAME=
-# Report Agent（推荐Gemini，推荐中转厂商 https://aihubmix.com/?aff=8Ds9）API密钥
+# Report Agent（推荐Gemini-2.5-pro，中转厂商申请地址：https://aihubmix.com/?aff=8Ds9）
 REPORT_ENGINE_API_KEY=
-# Report Agent LLM接口BaseUrl
 REPORT_ENGINE_BASE_URL=
-# Report Agent LLM模型，如gemini-2.5-pro
 REPORT_ENGINE_MODEL_NAME=
-# Forum Host LLM API密钥，Qwen3最新模型，推荐 https://cloud.siliconflow.cn/
+# MindSpider Agent（推荐deepseek-chat，官方申请地址：https://platform.deepseek.com/）
+MINDSPIDER_API_KEY=
+MINDSPIDER_BASE_URL=
+MINDSPIDER_MODEL_NAME=
+
+# 论坛主持人（推荐qwen-plus，官方申请地址：https://www.aliyun.com/product/bailian）
 FORUM_HOST_API_KEY=
-# Forum Host LLM BaseUrl
 FORUM_HOST_BASE_URL=
-# Forum Host LLM模型名，如Qwen/Qwen3-235B-A22B-Instruct-2507
 FORUM_HOST_MODEL_NAME=
-# SQL Keyword Optimizer LLM密钥，小参数Qwen3模型 https://cloud.siliconflow.cn/
+# SQL Keyword Optimizer（推荐qwen-plus，官方申请地址：https://www.aliyun.com/product/bailian）
 KEYWORD_OPTIMIZER_API_KEY=
-# Keyword Optimizer BaseUrl
 KEYWORD_OPTIMIZER_BASE_URL=
-# Keyword Optimizer LLM模型名称，如deepseek-chat
 KEYWORD_OPTIMIZER_MODEL_NAME=
 # ================== 网络工具配置 ====================
--- a/config.py
View file @9d6e494
+++ b/config.py
View file @9d6e494
@@ -26,12 +26,12 @@ class Settings(BaseSettings):
     变量名与原 config.py 大写一致，便于平滑过渡。
     """
     # ================== Flask 服务器配置 ====================
-    HOST: str = Field("0.0.0.0", description="Flask服务器主机地址，默认0.0.0.0（允许外部访问）")
+    HOST: str = Field("0.0.0.0", description="BETTAFISH 主机地址，例如 0.0.0.0 或 127.0.0.1")
     PORT: int = Field(5000, description="Flask服务器端口号，默认5000")
     # ====================== 数据库配置 ======================
-    DB_DIALECT: str = Field("mysql", description="数据库类型，例如 'mysql' 或 'postgresql'。用于支持多种数据库后端（如 SQLAlchemy，请与连接信息共同配置）")
-    DB_HOST: str = Field("your_db_host", description="数据库主机，例如localhost 或 127.0.0.1。我们也提供云数据库资源便捷配置，日均10w+数据，可免费申请，联系我们：670939375@qq.com NOTE：为进行数据合规性审查与服务升级，云数据库自2025年10月1日起暂停接收新的使用申请")
+    DB_DIALECT: str = Field("postgresql", description="数据库类型，可选 mysql 或 postgresql；请与其他连接信息同时配置")
+    DB_HOST: str = Field("your_db_host", description="数据库主机，例如localhost 或 127.0.0.1")
     DB_PORT: int = Field(3306, description="数据库端口号，默认为3306")
     DB_USER: str = Field("your_db_user", description="数据库用户名")
     DB_PASSWORD: str = Field("your_db_password", description="数据库密码")
@@ -42,34 +42,39 @@ class Settings(BaseSettings):
     # 我们的LLM模型API赞助商有：https://share.302.ai/P66Qe3、https://aihubmix.com/?aff=8Ds9，提供了非常全面的模型api
     # Insight Agent（推荐Kimi，申请地址：https://platform.moonshot.cn/）
-    INSIGHT_ENGINE_API_KEY: Optional[str] = Field(None, description="Insight Agent（推荐Kimi，https://platform.moonshot.cn/）API密钥，用于主LLM。您可以更改每个部分LLM使用的API，🚩只要兼容OpenAI请求格式都可以，定义好KEY、BASE_URL与MODEL_NAME即可正常使用。重要提醒：我们强烈推荐您先使用推荐的配置申请API，先跑通再进行您的更改！")
-    INSIGHT_ENGINE_BASE_URL: Optional[str] = Field("https://api.moonshot.cn/v1", description="Insight Agent LLM接口BaseUrl，可自定义厂商API")
-    INSIGHT_ENGINE_MODEL_NAME: str = Field("kimi-k2-0711-preview", description="Insight Agent LLM模型名称，如kimi-k2-0711-preview")
+    INSIGHT_ENGINE_API_KEY: Optional[str] = Field(None, description="Insight Agent（推荐 kimi-k2，官方申请地址：https://platform.moonshot.cn/）API 密钥，用于主 LLM。🚩请先按推荐配置申请并跑通，再根据需要调整 KEY、BASE_URL 与 MODEL_NAME。")
+    INSIGHT_ENGINE_BASE_URL: Optional[str] = Field("https://api.moonshot.cn/v1", description="Insight Agent LLM BaseUrl，可根据厂商自定义")
+    INSIGHT_ENGINE_MODEL_NAME: str = Field("kimi-k2-0711-preview", description="Insight Agent LLM 模型名称，例如 kimi-k2-0711-preview")
     # Media Agent（推荐Gemini，推荐中转厂商：https://aihubmix.com/?aff=8Ds9）
-    MEDIA_ENGINE_API_KEY: Optional[str] = Field(None, description="Media Agent（推荐Gemini，推荐中转api厂商：https://aihubmix.com/?aff=8Ds9")
-    MEDIA_ENGINE_BASE_URL: Optional[str] = Field("https://aihubmix.com/v1", description="Media Agent LLM接口BaseUrl")
-    MEDIA_ENGINE_MODEL_NAME: str = Field("gemini-2.5-pro", description="Media Agent LLM模型名称，如gemini-2.5-pro")
+    MEDIA_ENGINE_API_KEY: Optional[str] = Field(None, description="Media Agent（推荐 Gemini-2.5-pro，中转厂商申请地址：https://aihubmix.com/?aff=8Ds9）API 密钥")
+    MEDIA_ENGINE_BASE_URL: Optional[str] = Field("https://aihubmix.com/v1", description="Media Agent LLM BaseUrl，可根据中转服务调整")
+    MEDIA_ENGINE_MODEL_NAME: str = Field("gemini-2.5-pro", description="Media Agent LLM 模型名称，如 gemini-2.5-pro")
     # Query Agent（推荐DeepSeek，申请地址：https://www.deepseek.com/）
-    QUERY_ENGINE_API_KEY: Optional[str] = Field(None, description="Query Agent（推荐DeepSeek，https://www.deepseek.com/）API密钥")
-    QUERY_ENGINE_BASE_URL: Optional[str] = Field("https://api.deepseek.com", description="Query Agent LLM接口BaseUrl")
-    QUERY_ENGINE_MODEL_NAME: str = Field("deepseek-reasoner", description="Query Agent LLM模型，如deepseek-reasoner")
+    QUERY_ENGINE_API_KEY: Optional[str] = Field(None, description="Query Agent（推荐 DeepSeek，官方申请地址：https://platform.deepseek.com/）API 密钥")
+    QUERY_ENGINE_BASE_URL: Optional[str] = Field("https://api.deepseek.com", description="Query Agent LLM BaseUrl")
+    QUERY_ENGINE_MODEL_NAME: str = Field("deepseek-chat", description="Query Agent LLM 模型名称，如 deepseek-reasoner")
     # Report Agent（推荐Gemini，推荐中转厂商：https://aihubmix.com/?aff=8Ds9）
-    REPORT_ENGINE_API_KEY: Optional[str] = Field(None, description="Report Agent（推荐Gemini，推荐中转api厂商：https://aihubmix.com/?aff=8Ds9")
-    REPORT_ENGINE_BASE_URL: Optional[str] = Field("https://aihubmix.com/v1", description="Report Agent LLM接口BaseUrl")
-    REPORT_ENGINE_MODEL_NAME: str = Field("gemini-2.5-pro", description="Report Agent LLM模型，如gemini-2.5-pro")
+    REPORT_ENGINE_API_KEY: Optional[str] = Field(None, description="Report Agent（推荐 Gemini-2.5-pro，中转厂商申请地址：https://aihubmix.com/?aff=8Ds9）API 密钥")
+    REPORT_ENGINE_BASE_URL: Optional[str] = Field("https://aihubmix.com/v1", description="Report Agent LLM BaseUrl，可根据中转服务调整")
+    REPORT_ENGINE_MODEL_NAME: str = Field("gemini-2.5-pro", description="Report Agent LLM 模型名称，如 gemini-2.5-pro")
+
+    # MindSpider Agent（推荐Deepseek，官方申请地址：https://platform.deepseek.com/）
+    MINDSPIDER_API_KEY: Optional[str] = Field(None, description="MindSpider Agent（推荐 DeepSeek，官方申请地址：https://platform.deepseek.com/）API 密钥")
+    MINDSPIDER_BASE_URL: Optional[str] = Field(None, description="MindSpider Agent BaseUrl，可按所选服务配置")
+    MINDSPIDER_MODEL_NAME: Optional[str] = Field(None, description="MindSpider Agent 模型名称，例如 deepseek-reasoner")
     # Forum Host（Qwen3最新模型，这里我使用了硅基流动这个平台，申请地址：https://cloud.siliconflow.cn/）
-    FORUM_HOST_API_KEY: Optional[str] = Field(None, description="Forum Host（Qwen3最新模型，这里我使用了硅基流动这个平台，申请地址：https://cloud.siliconflow.cn/）API密钥")
-    FORUM_HOST_BASE_URL: Optional[str] = Field("https://api.siliconflow.cn/v1", description="Forum Host LLM BaseUrl")
-    FORUM_HOST_MODEL_NAME: str = Field("Qwen/Qwen3-235B-A22B-Instruct-2507", description="Forum Host LLM模型名，如Qwen/Qwen3-235B-A22B-Instruct-2507")
+    FORUM_HOST_API_KEY: Optional[str] = Field(None, description="Forum Host（推荐 qwen-plus，官方申请地址：https://www.aliyun.com/product/bailian）API 密钥")
+    FORUM_HOST_BASE_URL: Optional[str] = Field(None, description="Forum Host LLM BaseUrl，可按所选服务配置")
+    FORUM_HOST_MODEL_NAME: Optional[str] = Field(None, description="Forum Host LLM 模型名称，例如 qwen-plus")
     # SQL keyword Optimizer（小参数Qwen3模型，这里我使用了硅基流动这个平台，申请地址：https://cloud.siliconflow.cn/）
-    KEYWORD_OPTIMIZER_API_KEY: Optional[str] = Field(None, description="SQL keyword Optimizer（小参数Qwen3模型，这里我使用了硅基流动这个平台，申请地址：https://cloud.siliconflow.cn/）API密钥")
-    KEYWORD_OPTIMIZER_BASE_URL: Optional[str] = Field("https://api.siliconflow.cn/v1", description="Keyword Optimizer BaseUrl")
-    KEYWORD_OPTIMIZER_MODEL_NAME: str = Field("Qwen/Qwen3-30B-A3B-Instruct-2507", description="Keyword Optimizer LLM模型名称，如Qwen/Qwen3-30B-A3B-Instruct-2507")
+    KEYWORD_OPTIMIZER_API_KEY: Optional[str] = Field(None, description="SQL Keyword Optimizer（推荐 qwen-plus，官方申请地址：https://www.aliyun.com/product/bailian）API 密钥")
+    KEYWORD_OPTIMIZER_BASE_URL: Optional[str] = Field(None, description="Keyword Optimizer BaseUrl，可按所选服务配置")
+    KEYWORD_OPTIMIZER_MODEL_NAME: Optional[str] = Field(None, description="Keyword Optimizer LLM 模型名称，例如 qwen-plus")
     # ================== 网络工具配置 ====================
     # Tavily API（申请地址：https://www.tavily.com/）
--- a/templates/index.html
View file @9d6e494
+++ b/templates/index.html
View file @9d6e494
@@ -1174,7 +1174,7 @@
         const configFieldGroups = [
             {
                 title: '数据库连接',
-                subtitle: '用于连接业务数据库的基本配置',
+                subtitle: '用于连接社媒数据库的基本配置，注意数据库默认为空，需要单独部署MindSpider爬取数据',
                 fields: [
                     { key: 'DB_DIALECT', label: '数据库类型', type: 'select', options: ['mysql', 'postgresql'] },
                     { key: 'DB_HOST', label: '主机地址' },
@@ -1187,7 +1187,7 @@
             },
             {
                 title: 'Insight Agent',
-                subtitle: '负责洞察分析的模型配置',
+                subtitle: 'OpenAi接入格式，推荐LLM：kimi-k2',
                 fields: [
                     { key: 'INSIGHT_ENGINE_API_KEY', label: 'API Key', type: 'password' },
                     { key: 'INSIGHT_ENGINE_BASE_URL', label: 'Base URL' },
@@ -1196,7 +1196,7 @@
             },
             {
                 title: 'Media Agent',
-                subtitle: '媒体内容理解与生成模型',
+                subtitle: 'OpenAi接入格式，推荐LLM：gemini-2.5-pro',
                 fields: [
                     { key: 'MEDIA_ENGINE_API_KEY', label: 'API Key', type: 'password' },
                     { key: 'MEDIA_ENGINE_BASE_URL', label: 'Base URL' },
@@ -1205,7 +1205,7 @@
             },
             {
                 title: 'Query Agent',
-                subtitle: '负责搜索与信息汇总的模型配置',
+                subtitle: 'OpenAi接入格式，推荐LLM：deepseek-chat',
                 fields: [
                     { key: 'QUERY_ENGINE_API_KEY', label: 'API Key', type: 'password' },
                     { key: 'QUERY_ENGINE_BASE_URL', label: 'Base URL' },
@@ -1214,7 +1214,7 @@
             },
             {
                 title: 'Report Agent',
-                subtitle: '报告生成使用的模型配置',
+                subtitle: 'OpenAi接入格式，推荐LLM：gemini-2.5-pro',
                 fields: [
                     { key: 'REPORT_ENGINE_API_KEY', label: 'API Key', type: 'password' },
                     { key: 'REPORT_ENGINE_BASE_URL', label: 'Base URL' },
@@ -1223,7 +1223,7 @@
             },
             {
                 title: 'Forum Host',
-                subtitle: '多智能体协同使用的模型配置',
+                subtitle: 'OpenAi接入格式，推荐LLM：qwen-plus',
                 fields: [
                     { key: 'FORUM_HOST_API_KEY', label: 'API Key', type: 'password' },
                     { key: 'FORUM_HOST_BASE_URL', label: 'Base URL' },
@@ -1232,7 +1232,7 @@
             },
             {
                 title: 'Keyword Optimizer',
-                subtitle: 'SQL / 关键词优化模型配置',
+                subtitle: 'OpenAi接入格式，推荐LLM：qwen-plus',
                 fields: [
                     { key: 'KEYWORD_OPTIMIZER_API_KEY', label: 'API Key', type: 'password' },
                     { key: 'KEYWORD_OPTIMIZER_BASE_URL', label: 'Base URL' },
@@ -1241,7 +1241,7 @@
             },
             {
                 title: '外部检索工具',
-                subtitle: '联动搜索引擎、网站抓取等在线服务',
+                subtitle: '联动搜索引擎、网站抓取等在线服务，两个都需配置',
                 fields: [
                     { key: 'TAVILY_API_KEY', label: 'Tavily API Key', type: 'password' },
                     { key: 'BOCHA_WEB_SEARCH_API_KEY', label: 'Bocha API Key', type: 'password' }