@lobehub/chat 0.152.6 → 0.152.7

package/CHANGELOG.md

@@ -2,6 +2,31 @@
 
 # Changelog
 
+### [Version 0.152.7](https://github.com/lobehub/lobe-chat/compare/v0.152.6...v0.152.7)
+
+<sup>Released on **2024-05-02**</sup>
+
+#### 💄 Styles
+
+- **misc**: Refactor setting layout and improve setting design.
+
+<br/>
+
+<details>
+<summary><kbd>Improvements and Fixes</kbd></summary>
+
+#### Styles
+
+- **misc**: Refactor setting layout and improve setting design, closes [#2344](https://github.com/lobehub/lobe-chat/issues/2344) ([fa16721](https://github.com/lobehub/lobe-chat/commit/fa16721))
+
+</details>
+
+<div align="right">
+
+[![](https://img.shields.io/badge/-BACK_TO_TOP-151515?style=flat-square)](#readme-top)
+
+</div>
+
 ### [Version 0.152.6](https://github.com/lobehub/lobe-chat/compare/v0.152.5...v0.152.6)
 
 <sup>Released on **2024-05-02**</sup>

package/docs/self-hosting/advanced/settings-url-share.mdx

@@ -0,0 +1,100 @@
+# Share settings via URL 
+
+LobeChat support import settings from external URL to quickly set up LobeChat configuration.
+
+The currently supported settings are:
+
+- `languageModel`: Language model settings
+
+## Import from URL
+
+Use the following URL format to import settings parameters from an external URL:
+
+```plaintext
+https://lobehub.com/?settings=<settings object in JSON format>
+https://lobehub.com/?settings={"languageModel":{"openai":{"apiKey":"user-key","endpoint":"https://lobehub.com/v1"}}}
+```
+
+Example of settings in JSON format:
+
+```json
+{
+    "languageModel": {
+        "openai": {
+            "apiKey": "user-key"
+        }
+    }
+}
+```
+
+## Export settings to URL
+
+```ts
+// Generate settings to export to URL
+const settings = {
+    languageModel: {
+    openai: {
+        apiKey: 'user-key',
+        endpoint: 'https://lobehub.com/v1'
+    },
+}};
+// Convert settings to a JSON formatted string
+const url = `/?settings=${JSON.stringify(settings)}`;
+console.log(url); 
+// /?settings={"languageModel":{"openai":{"apiKey":"user-key","endpoint":"https://lobehub.com/v1"}}}
+```
+
+<Callout type={'warning'}>
+    LobeChat does not verify the correctness of the settings parameters in the URL, nor provide encryption or decryption methods. Please use with caution.
+</Callout>
+
+## Parameter schema
+
+### languageModel
+
+- Property name and type
+
+| Property name | Type                           |
+|---------------|--------------------------------|
+| anthropic     | GeneralModelProviderConfig      |
+| azure         | AzureOpenAIConfig               |
+| bedrock       | AWSBedrockConfig                |
+| google        | GeneralModelProviderConfig      |
+| groq          | GeneralModelProviderConfig      |
+| minimax       | GeneralModelProviderConfig      |
+| mistral       | GeneralModelProviderConfig      |
+| moonshot      | GeneralModelProviderConfig      |
+| ollama        | GeneralModelProviderConfig      |
+| openai        | GeneralModelProviderConfig      |
+| openrouter    | GeneralModelProviderConfig      |
+| perplexity    | GeneralModelProviderConfig      |
+| togetherai    | GeneralModelProviderConfig      |
+| zeroone       | GeneralModelProviderConfig      |
+| zhipu         | GeneralModelProviderConfig      |
+
+- Type `GeneralModelProviderConfig`
+
+| Property name | Type                           | Description                                                                 |
+|-----------------------|--------------------------|-----------------------------------------------------------------------------|
+| apiKey                | string                   | The API key for the model provider.                                          |
+| autoFetchModelLists   | boolean                  | Whether to automatically fetch model lists.                                  |
+| enabled               | boolean                  | Whether the model provider is enabled.                                       |
+| enabledModels         | string[] | null         | The IDs of the enabled models.                                               |
+| endpoint              | string                   | The endpoint for the model provider.                                         |
+| fetchOnClient         | boolean                  | Whether to fetch on the client.                                              |
+
+- Type `AzureOpenAIConfig`
+> Inherits the fields from `GeneralModelProviderConfig`
+
+| Property name | Type                           | Description                                                                 |
+|-----------------------|--------------------------|-----------------------------------------------------------------------------|
+| apiVersion                | string                   | The API version for Azure OpenAI.                                          |
+
+- Type `AWSBedrockConfig`
+> Inherits all fields from `GeneralModelProviderConfig` except `apiKey, endpoint`
+
+| Property name | Type                           | Description                                                                 |
+| accessKeyId           | string                   | The access key ID for AWS Bedrock.                                           |
+| region                | string                   | The region for AWS Bedrock.                                                  |
+| secretAccessKey       | string                   | The secret access key for AWS Bedrock.                                       |
+

package/docs/self-hosting/advanced/settings-url-share.zh-CN.mdx

@@ -0,0 +1,100 @@
+# URL 分享设置参数
+
+LobeChat 支持从外部 URL 导入设置参数，以便于快速设置 LobeChat 的配置。
+
+目前支持的设置项有：
+
+- `languageModel`：语言模型设置 
+
+## 从 URL 中导入
+
+使用以下 URL 格式，可以从外部 URL 导入设置参数：
+
+```plaintext
+https://lobehub.com/?settings=<JSON格式的设置对象>
+https://lobehub.com/?settings={"languageModel":{"openai":{"apiKey":"user-key","endpoint":"https://lobehub.com/v1"}}}
+```
+
+JSON格式的设置示例：
+
+```json
+{
+    "languageModel": {
+        "openai": {
+            "apiKey": "user-key"
+        }
+    }
+}
+```
+
+## 将设置导出到 URL
+
+```ts
+// 生成要导出到 URL 的设置
+const settings = {
+    languageModel: {
+    openai: {
+        apiKey: 'user-key',
+        endpoint: 'https://lobehub.com/v1'
+    },
+}};
+// 将设置转为 JSON 格式的字符串
+const url = `/?settings=${JSON.stringify(settings)}`;
+console.log(url); 
+// /?settings={"languageModel":{"openai":{"apiKey":"user-key","endpoint":"https://lobehub.com/v1"}}}
+```
+
+<Callout type={'warning'}>
+    LobeChat 不对 URL 中的设置参数进行正确性校验，也不提供加密、解密方法，请谨慎使用。
+</Callout>
+
+## 参数格式
+
+### languageModel
+
+- 参数及其类型
+
+| 参数名称 | 类型                           |
+|---------------|--------------------------------|
+| anthropic     | GeneralModelProviderConfig      |
+| azure         | AzureOpenAIConfig               |
+| bedrock       | AWSBedrockConfig                |
+| google        | GeneralModelProviderConfig      |
+| groq          | GeneralModelProviderConfig      |
+| minimax       | GeneralModelProviderConfig      |
+| mistral       | GeneralModelProviderConfig      |
+| moonshot      | GeneralModelProviderConfig      |
+| ollama        | GeneralModelProviderConfig      |
+| openai        | GeneralModelProviderConfig      |
+| openrouter    | GeneralModelProviderConfig      |
+| perplexity    | GeneralModelProviderConfig      |
+| togetherai    | GeneralModelProviderConfig      |
+| zeroone       | GeneralModelProviderConfig      |
+| zhipu         | GeneralModelProviderConfig      |
+
+- 类型 `GeneralModelProviderConfig`
+
+| 参数               | TS 类型                       | 描述                                                                 |
+|-----------------------|--------------------------|-----------------------------------------------------------------------------|
+| apiKey | string | 模型的 API 密钥。 |
+| autoFetchModelLists | boolean | 是否自动获取模型列表。 |
+| enabled | boolean | 是否启用该模型。 |
+| enabledModels | string[] | 启用的模型的 ID。 |
+| endpoint | string | 模型API端点。 |
+| fetchOnClient | boolean | 是否在客户端发起请求，默认在服务端发起请求。 |
+
+- 类型 `AzureOpenAIConfig`
+> 继承 `GeneralModelProviderConfig` 中的字段
+
+| 参数               | TS 类型                       | 描述                                                                 |
+|-----------------------|--------------------------|-----------------------------------------------------------------------------|
+| apiVersion | string | Azure OpenAI 的 API 版本。 |
+
+- 类型 `AWSBedrockConfig`
+> 继承 `GeneralModelProviderConfig` 中除 `apiKey, endpoint` 外的所有字段
+
+| 参数               | TS 类型                       | 描述                                                                 |
+|-----------------------|--------------------------|-----------------------------------------------------------------------------|
+| accessKeyId | string | AWS Bedrock 的访问密钥 ID。 |
+| region | string | AWS Bedrock 的区域。 |
+| secretAccessKey | string | AWS Bedrock 的访问密钥。 |

package/locales/ar/common.json

@@ -140,6 +140,7 @@
   "tab": {
     "chat": "الدردشة",
     "market": "الاكتشاف",
+    "me": "أنا",
     "setting": "الإعدادات"
   },
   "telemetry": {

package/locales/ar/setting.json

@@ -27,9 +27,12 @@
     }
   },
   "header": {
+    "desc": "إعدادات التفضيلات والنماذج.",
     "global": "إعدادات عامة",
     "session": "إعدادات الجلسة",
-    "sessionWithName": "إعدادات الجلسة · {{name}}"
+    "sessionDesc": "إعداد الشخصية وتفضيلات الجلسة.",
+    "sessionWithName": "إعدادات الجلسة · {{name}}",
+    "title": "إعدادات"
   },
   "llm": {
     "checker": {

package/locales/bg-BG/common.json

@@ -140,6 +140,7 @@
   "tab": {
     "chat": "Чат",
     "market": "Открий",
+    "me": "аз",
     "setting": "Настройки"
   },
   "telemetry": {

package/locales/bg-BG/setting.json

@@ -27,9 +27,12 @@
     }
   },
   "header": {
+    "desc": "Предпочитания и настройки на модела.",
     "global": "Глобални настройки",
     "session": "Настройки на сесията",
-    "sessionWithName": "Настройки на сесията · {{name}}"
+    "sessionDesc": "Задаване на роля и предпочитания за сесия.",
+    "sessionWithName": "Настройки на сесията · {{name}}",
+    "title": "Настройки"
   },
   "llm": {
     "checker": {

package/locales/de-DE/common.json

@@ -140,6 +140,7 @@
   "tab": {
     "chat": "Chat",
     "market": "Entdecken",
+    "me": "Ich",
     "setting": "Einstellung"
   },
   "telemetry": {

package/locales/de-DE/setting.json

@@ -27,9 +27,12 @@
     }
   },
   "header": {
+    "desc": "Präferenzen und Modellkonfigurationen.",
     "global": "Global Einstellungen",
     "session": "Sitzungseinstellungen",
-    "sessionWithName": "Sitzungseinstellungen · {{name}}"
+    "sessionDesc": "Rollenkonfiguration und Sitzungspräferenzen.",
+    "sessionWithName": "Sitzungseinstellungen · {{name}}",
+    "title": "Einstellungen"
   },
   "llm": {
     "checker": {

package/locales/en-US/common.json

@@ -140,6 +140,7 @@
   "tab": {
     "chat": "Chat",
     "market": "Discover",
+    "me": "Me",
     "setting": "Settings"
   },
   "telemetry": {

package/locales/en-US/setting.json

@@ -27,9 +27,12 @@
     }
   },
   "header": {
+    "desc": "Preferences and model settings.",
     "global": "Global Settings",
     "session": "Session Settings",
-    "sessionWithName": "Session Settings · {{name}}"
+    "sessionDesc": "Role settings and session preferences.",
+    "sessionWithName": "Session Settings · {{name}}",
+    "title": "Settings"
   },
   "llm": {
     "checker": {

package/locales/es-ES/common.json

@@ -140,6 +140,7 @@
   "tab": {
     "chat": "Chat",
     "market": "Descubrir",
+    "me": "Yo",
     "setting": "Configuración"
   },
   "telemetry": {

package/locales/es-ES/setting.json

@@ -27,9 +27,12 @@
     }
   },
   "header": {
+    "desc": "Preferencias y configuración del modelo.",
     "global": "Configuración global",
     "session": "Configuración de la sesión",
-    "sessionWithName": "Configuración de la sesión · {{name}}"
+    "sessionDesc": "Configuración de roles y preferencias de sesión.",
+    "sessionWithName": "Configuración de la sesión · {{name}}",
+    "title": "Configuración"
   },
   "llm": {
     "checker": {

package/locales/fr-FR/common.json

@@ -140,6 +140,7 @@
   "tab": {
     "chat": "Conversation",
     "market": "Découvrir",
+    "me": "moi",
     "setting": "Paramètre"
   },
   "telemetry": {

package/locales/fr-FR/setting.json

@@ -27,9 +27,12 @@
     }
   },
   "header": {
+    "desc": "Préférences et paramètres du modèle.",
     "global": "Paramètres globaux",
     "session": "Paramètres de session",
-    "sessionWithName": "Paramètres de session · {{name}}"
+    "sessionDesc": "Paramètres de personnage et préférences de session.",
+    "sessionWithName": "Paramètres de session · {{name}}",
+    "title": "Paramètres"
   },
   "llm": {
     "checker": {

package/locales/it-IT/common.json

@@ -140,6 +140,7 @@
   "tab": {
     "chat": "Chat",
     "market": "Scopri",
+    "me": "io",
     "setting": "Impostazioni"
   },
   "telemetry": {

package/locales/it-IT/setting.json

@@ -27,9 +27,12 @@
     }
   },
   "header": {
+    "desc": "Preferenze e impostazioni del modello.",
     "global": "Impostazioni globali",
     "session": "Impostazioni della sessione",
-    "sessionWithName": "Impostazioni della sessione · {{name}}"
+    "sessionDesc": "Impostazioni del personaggio e preferenze di sessione.",
+    "sessionWithName": "Impostazioni della sessione · {{name}}",
+    "title": "Impostazioni"
   },
   "llm": {
     "checker": {

package/locales/ja-JP/common.json

@@ -140,6 +140,7 @@
   "tab": {
     "chat": "チャット",
     "market": "探す",
+    "me": "私",
     "setting": "設定"
   },
   "telemetry": {

package/locales/ja-JP/setting.json

@@ -27,9 +27,12 @@
     }
   },
   "header": {
+    "desc": "設定優先順位和模型設置。",
     "global": "グローバル設定",
     "session": "セッション設定",
-    "sessionWithName": "セッション設定 · {{name}}"
+    "sessionDesc": "キャラクター設定とセッションの好み。",
+    "sessionWithName": "セッション設定 · {{name}}",
+    "title": "設定"
   },
   "llm": {
     "checker": {

package/locales/ko-KR/common.json

@@ -140,6 +140,7 @@
   "tab": {
     "chat": "채팅",
     "market": "발견",
+    "me": "나",
     "setting": "설정"
   },
   "telemetry": {

package/locales/ko-KR/setting.json

@@ -27,9 +27,12 @@
     }
   },
   "header": {
+    "desc": "설정 및 모델 설정.",
     "global": "전역 설정",
     "session": "세션 설정",
-    "sessionWithName": "세션 설정 · {{name}}"
+    "sessionDesc": "캐릭터 설정 및 세션 환경 설정.",
+    "sessionWithName": "세션 설정 · {{name}}",
+    "title": "설정"
   },
   "llm": {
     "checker": {

package/locales/nl-NL/common.json

@@ -140,6 +140,7 @@
   "tab": {
     "chat": "会话",
     "market": "发现",
+    "me": "我",
     "setting": "设置"
   },
   "telemetry": {

package/locales/nl-NL/setting.json

@@ -27,9 +27,12 @@
     }
   },
   "header": {
+    "desc": "Voorkeuren en modelinstellingen.",
     "global": "Algemene instellingen",
     "session": "Sessie-instellingen",
-    "sessionWithName": "Sessie-instellingen · {{name}}"
+    "sessionDesc": "Rolinstellingen en sessievoorkeuren.",
+    "sessionWithName": "Sessie-instellingen · {{name}}",
+    "title": "Instellingen"
   },
   "llm": {
     "checker": {

package/locales/pl-PL/common.json

@@ -140,6 +140,7 @@
   "tab": {
     "chat": "Czat",
     "market": "Odkrywaj",
+    "me": "ja",
     "setting": "Ustawienia"
   },
   "telemetry": {

package/locales/pl-PL/setting.json

@@ -27,9 +27,12 @@
     }
   },
   "header": {
+    "desc": "Preferencje i ustawienia modelu.",
     "global": "Ustawienia globalne",
     "session": "Ustawienia sesji",
-    "sessionWithName": "Ustawienia sesji · {{name}}"
+    "sessionDesc": "Ustawienia postaci i preferencje sesji.",
+    "sessionWithName": "Ustawienia sesji · {{name}}",
+    "title": "Ustawienia"
   },
   "llm": {
     "checker": {

package/locales/pt-BR/common.json

@@ -140,6 +140,7 @@
   "tab": {
     "chat": "Chat",
     "market": "Descobrir",
+    "me": "eu",
     "setting": "Configuração"
   },
   "telemetry": {

package/locales/pt-BR/setting.json

@@ -27,9 +27,12 @@
     }
   },
   "header": {
+    "desc": "Preferências e configurações do modelo.",
     "global": "Configurações Globais",
     "session": "Configurações de Sessão",
-    "sessionWithName": "Configurações de Sessão · {{name}}"
+    "sessionDesc": "Configurações de personagem e preferências de sessão.",
+    "sessionWithName": "Configurações de Sessão · {{name}}",
+    "title": "Configurações"
   },
   "llm": {
     "checker": {

package/locales/ru-RU/common.json

@@ -140,6 +140,7 @@
   "tab": {
     "chat": "Чат",
     "market": "Обзор",
+    "me": "я",
     "setting": "Настройки"
   },
   "telemetry": {

package/locales/ru-RU/setting.json

@@ -27,9 +27,12 @@
     }
   },
   "header": {
+    "desc": "Настройки предпочтений и моделей.",
     "global": "Глобальные настройки",
     "session": "Настройки сеанса",
-    "sessionWithName": "Настройки сеанса · {{name}}"
+    "sessionDesc": "Настройки персонажа и предпочтения сессии.",
+    "sessionWithName": "Настройки сеанса · {{name}}",
+    "title": "Настройки"
   },
   "llm": {
     "checker": {

package/locales/tr-TR/common.json

@@ -140,6 +140,7 @@
   "tab": {
     "chat": "Chat",
     "market": "Keşfet",
+    "me": "ben",
     "setting": "Ayarlar"
   },
   "telemetry": {

package/locales/tr-TR/setting.json

@@ -27,9 +27,12 @@
     }
   },
   "header": {
+    "desc": "Tercihler ve model ayarları.",
     "global": "Genel Ayarlar",
     "session": "Oturum Ayarları",
-    "sessionWithName": "Oturum Ayarları · {{name}}"
+    "sessionDesc": "Karakter ayarları ve oturum tercihleri.",
+    "sessionWithName": "Oturum Ayarları · {{name}}",
+    "title": "Ayarlar"
   },
   "llm": {
     "checker": {

package/locales/vi-VN/common.json

@@ -140,6 +140,7 @@
   "tab": {
     "chat": "Trò chuyện",
     "market": "Thị trường",
+    "me": "Tôi",
     "setting": "Cài đặt"
   },
   "telemetry": {

package/locales/vi-VN/setting.json

@@ -27,9 +27,12 @@
     }
   },
   "header": {
+    "desc": "Thiết lập Ưu tiên và Mô hình.",
     "global": "Cài đặt toàn cầu",
     "session": "Cài đặt cuộc trò chuyện",
-    "sessionWithName": "Cài đặt cuộc trò chuyện · {{name}}"
+    "sessionDesc": "Thiết lập nhân vật và ưu tiên phiên hội thoại.",
+    "sessionWithName": "Cài đặt cuộc trò chuyện · {{name}}",
+    "title": "Cài đặt"
   },
   "llm": {
     "checker": {

package/locales/zh-CN/common.json

@@ -140,6 +140,7 @@
   "tab": {
     "chat": "会话",
     "market": "发现",
+    "me": "我",
     "setting": "设置"
   },
   "telemetry": {

package/locales/zh-CN/setting.json

@@ -27,9 +27,12 @@
     }
   },
   "header": {
+    "desc": "偏好与模型设置",
     "global": "全局设置",
     "session": "会话设置",
-    "sessionWithName": "会话设置 · {{name}}"
+    "sessionDesc": "角色设定与会话偏好",
+    "sessionWithName": "会话设置 · {{name}}",
+    "title": "设置"
   },
   "llm": {
     "checker": {

package/locales/zh-TW/common.json

@@ -140,6 +140,7 @@
   "tab": {
     "chat": "對話",
     "market": "發現",
+    "me": "我",
     "setting": "設定"
   },
   "telemetry": {

package/locales/zh-TW/setting.json

@@ -27,9 +27,12 @@
     }
   },
   "header": {
+    "desc": "偏好與模型設定",
     "global": "全域設定",
     "session": "對話設定",
-    "sessionWithName": "對話設定 · {{name}}"
+    "sessionDesc": "角色設定與會話偏好",
+    "sessionWithName": "對話設定 · {{name}}",
+    "title": "設定"
   },
   "llm": {
     "checker": {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@lobehub/chat",
-  "version": "0.152.6",
+  "version": "0.152.7",
   "description": "Lobe Chat - an open-source, high-performance chatbot framework that supports speech synthesis, multimodal, and extensible Function Call plugin system. Supports one-click free deployment of your private ChatGPT/LLM web application.",
   "keywords": [
     "framework",