@lobehub/chat 0.105.2 → 0.106.0

package/CHANGELOG.md

@@ -2,6 +2,31 @@
 
 # Changelog
 
+## [Version 0.106.0](https://github.com/lobehub/lobe-chat/compare/v0.105.2...v0.106.0)
+
+<sup>Released on **2023-11-29**</sup>
+
+#### ✨ Features
+
+- **misc**: Support custom deletion, addition, and renaming of models.
+
+<br/>
+
+<details>
+<summary><kbd>Improvements and Fixes</kbd></summary>
+
+#### What's improved
+
+- **misc**: Support custom deletion, addition, and renaming of models, closes [#521](https://github.com/lobehub/lobe-chat/issues/521) [#518](https://github.com/lobehub/lobe-chat/issues/518) [#518](https://github.com/lobehub/lobe-chat/issues/518) ([65e0824](https://github.com/lobehub/lobe-chat/commit/65e0824))
+
+</details>
+
+<div align="right">
+
+[![](https://img.shields.io/badge/-BACK_TO_TOP-151515?style=flat-square)](#readme-top)
+
+</div>
+
 ### [Version 0.105.2](https://github.com/lobehub/lobe-chat/compare/v0.105.1...v0.105.2)
 
 <sup>Released on **2023-11-27**</sup>

package/README.md

@@ -51,6 +51,7 @@ Supports one-click free deployment of your private ChatGPT/LLM web application.
 - [🛳 Self Hosting](#-self-hosting)
   - [`A` Deploying with Vercel](#a-deploying-with-vercel)
   - [`B` Deploying with Docker](#b-deploying-with-docker)
+  - [`C` Deploying with Zeabur](#c-deploying-with-zeabur)
   - [Environment Variable](#environment-variable)
 - [📦 Ecosystem](#-ecosystem)
 - [🧩 Plugins](#-plugins)
@@ -379,6 +380,21 @@ $ docker run -d -p 3210:3210 \
 
 <br/>
 
+### `C` Deploying with Zeabur
+
+If you want to deploy this service yourself on Zeabur, you can follow these steps:
+
+- Prepare your [OpenAI API Key](https://platform.openai.com/account/api-keys).
+- Click the button below to start deployment: Deploy with Zeabur.
+- You can start using it after the deployment.
+- You can bind a custom domain or use the subdomain provided by Zeabur.
+
+<div align="center">
+
+[![][deploy-on-zeabur-button-image]][deploy-on-zeabur-link]
+
+</div>
+
 ### Environment Variable
 
 This project provides some additional configuration items set with environment variables:
@@ -518,6 +534,8 @@ This project is [MIT](./LICENSE) licensed.
 [contributors-link]: https://github.com/lobehub/lobe-chat/graphs/contributors
 [deploy-button-image]: https://vercel.com/button
 [deploy-link]: https://vercel.com/new/clone?repository-url=https%3A%2F%2Fgithub.com%2Flobehub%2Flobe-chat&env=OPENAI_API_KEY&envDescription=Find%20your%20OpenAI%20API%20Key%20by%20click%20the%20right%20Learn%20More%20button.&envLink=https%3A%2F%2Fplatform.openai.com%2Faccount%2Fapi-keys&project-name=lobe-chat&repository-name=lobe-chat
+[deploy-on-zeabur-button-image]: https://zeabur.com/button.svg
+[deploy-on-zeabur-link]: https://zeabur.com/templates/VZGGTI
 [discord-link]: https://discord.gg/AYFPHvv2jT
 [discord-shield]: https://img.shields.io/discord/1127171173982154893?color=5865F2&label=discord&labelColor=black&logo=discord&logoColor=white&style=flat-square
 [discord-shield-badge]: https://img.shields.io/discord/1127171173982154893?color=5865F2&label=discord&labelColor=black&logo=discord&logoColor=white&style=for-the-badge

package/README.zh-CN.md

@@ -50,6 +50,7 @@ LobeChat 是开源的高性能聊天机器人框架，支持语音合成、多
 - [🛳 开箱即用](#-开箱即用)
   - [`A` 使用 Vercel 部署](#a-使用-vercel-部署)
   - [`B` 使用 Docker 部署](#b-使用-docker-部署)
+  - [`C` 使用 Zeabur 部署](#c-使用-zeabur-部署)
   - [环境变量](#环境变量)
 - [📦 生态系统](#-生态系统)
 - [🧩 插件体系](#-插件体系)
@@ -353,6 +354,21 @@ $ docker run -d -p 3210:3210 \
 
 <br/>
 
+### `C` 使用 Zeabur 部署
+
+如果想在 Zeabur 上部署该服务，可以按照以下步骤进行操作：
+
+- 准备好你的 [OpenAI API Key](https://platform.openai.com/account/api-keys) 。
+- 点击下方按钮开始部署： Deploy to Zeabur
+- 部署完毕后，即可开始使用；
+- 绑定自定义域名（可选）：你可以使用 Zeabur 提供的子域名，也可以选择绑定自定义域名。目前 Zeabur 提供的域名还未被污染，大多数地区都可以直连。
+
+<div align="center">
+
+[![][deploy-on-zeabur-button-image]][deploy-on-zeabur-link]
+
+</div>
+
 ### 环境变量
 
 本项目提供了一些额外的配置项，使用环境变量进行设置：
@@ -492,6 +508,8 @@ This project is [MIT](./LICENSE) licensed.
 [contributors-link]: https://github.com/lobehub/lobe-chat/graphs/contributors
 [deploy-button-image]: https://vercel.com/button
 [deploy-link]: https://vercel.com/new/clone?repository-url=https%3A%2F%2Fgithub.com%2Flobehub%2Flobe-chat&env=OPENAI_API_KEY&envDescription=Find%20your%20OpenAI%20API%20Key%20by%20click%20the%20right%20Learn%20More%20button.&envLink=https%3A%2F%2Fplatform.openai.com%2Faccount%2Fapi-keys&project-name=lobe-chat&repository-name=lobe-chat
+[deploy-on-zeabur-button-image]: https://zeabur.com/button.svg
+[deploy-on-zeabur-link]: https://zeabur.com/templates/VZGGTI
 [discord-link]: https://discord.gg/AYFPHvv2jT
 [discord-shield]: https://img.shields.io/discord/1127171173982154893?color=5865F2&label=discord&labelColor=black&logo=discord&logoColor=white&style=flat-square
 [discord-shield-badge]: https://img.shields.io/discord/1127171173982154893?color=5865F2&label=discord&labelColor=black&logo=discord&logoColor=white&style=for-the-badge

package/docs/Environment-Variable.md

@@ -34,9 +34,11 @@ LobeChat provides additional configuration options during deployment, which can
 ### `NEXT_PUBLIC_CUSTOM_MODELS`
 
 - Type: Optional
-- Description: add your custom model name, multi model seperate by comma. for example: `gpt-3.5-1106,gpt-4-1106`
+- Description: Used to control the model list. Use `+` to add a model, `-` to hide a model, and `model_name=display_name` to customize the display name of a model, separated by commas.
 - Default: `-`
-- Example: `model1,model2,model3`
+- Example: `+qwen-7b-chat,+glm-6b,-gpt-3.5-turbo,gpt-4-1106-preview=gpt-4-turbo`
+
+The above example adds `qwen-7b-chat` and `glm-6b` to the model list, removes `gpt-3.5-turbo` from the list, and displays the model name `gpt-4-1106-preview` as `gpt-4-turbo`. If you want to disable all models first and then enable specific models, you can use `-all,+gpt-3.5-turbo`, which means only `gpt-3.5-turbo` will be enabled.
 
 ## OpenAI
 

package/docs/Environment-Variable.zh-CN.md

@@ -34,9 +34,11 @@ LobeChat 在部署时提供了一些额外的配置项，使用环境变量进
 ### `NEXT_PUBLIC_CUSTOM_MODELS`
 
 - 类型：可选
-- 描述：添加自定义模型名称，多个模型需要使用逗号 `,` 隔开。 比如: `gpt-3.5-1106,gpt-4-1106`
+- 描述：用来控制模型列表，使用 `+` 增加一个模型，使用 `-` 来隐藏一个模型，使用 `模型名=展示名` 来自定义模型的展示名，用英文逗号隔开。
 - 默认值：`-`
-- 示例：`model1,model2,model3`
+- 示例：`+qwen-7b-chat,+glm-6b,-gpt-3.5-turbo,gpt-4-1106-preview=gpt-4-turbo`
+
+上面示例表示增加 `qwen-7b-chat` 和 `glm-6b` 到模型列表，而从列表中删除 `gpt-3.5-turbo`，并将 `gpt-4-1106-preview` 模型名字展示为 `gpt-4-turbo`。如果你想先禁用所有模型，再启用指定模型，可以使用 `-all,+gpt-3.5-turbo`，则表示仅启用 `gpt-3.5-turbo`。
 
 ## OpenAI
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@lobehub/chat",
-  "version": "0.105.2",
+  "version": "0.106.0",
   "description": "An open-source, extensible (Function Calling), high-performance chatbot framework. It supports one-click free deployment of your private ChatGPT/LLM web application",
   "keywords": [
     "chatbot",

package/src/app/chat/features/ChatInput/ActionBar/ModelSwitch.tsx

@@ -22,7 +22,7 @@ const ModelSwitch = memo(() => {
     <Dropdown
       menu={{
         activeKey: model,
-        items: modelList.map((i) => ({ key: i, label: i })),
+        items: modelList.map(({ name, displayName }) => ({ key: name, label: displayName })),
         onClick: (e) => {
           updateAgentConfig({ model: e.key as LanguageModel });
         },

package/src/features/AgentSetting/AgentConfig/index.tsx

@@ -114,7 +114,14 @@ const AgentConfig = memo(() => {
   const model: ItemGroup = {
     children: [
       {
-        children: <Select options={modelList.map((value) => ({ label: value, value }))} />,
+        children: (
+          <Select
+            options={modelList.map(({ name, displayName }) => ({
+              label: displayName,
+              value: name,
+            }))}
+          />
+        ),
         desc: t('settingModel.model.desc'),
         label: t('settingModel.model.title'),
         name: 'model',

package/src/store/global/selectors/__snapshots__/settings.test.ts.snap

@@ -1,5 +1,104 @@
 // Vitest Snapshot v1, https://vitest.dev/guide/snapshot.html
 
+exports[`settingsSelectors > CUSTOM_MODELS > custom deletion, addition, and renaming of models 1`] = `
+[
+  {
+    "displayName": "llama",
+    "name": "llama",
+  },
+  {
+    "displayName": "claude-2",
+    "name": "claude-2",
+  },
+  {
+    "displayName": "gpt-4-32k",
+    "name": "gpt-4-1106-preview",
+  },
+]
+`;
+
+exports[`settingsSelectors > CUSTOM_MODELS > duplicate naming model 1`] = `
+[
+  {
+    "displayName": "gpt-3.5-turbo",
+    "name": "gpt-3.5-turbo",
+  },
+  {
+    "displayName": "gpt-3.5-turbo-1106",
+    "name": "gpt-3.5-turbo-1106",
+  },
+  {
+    "displayName": "gpt-3.5-turbo-16k",
+    "name": "gpt-3.5-turbo-16k",
+  },
+  {
+    "displayName": "gpt-4",
+    "name": "gpt-4",
+  },
+  {
+    "displayName": "gpt-4-32k",
+    "name": "gpt-4-32k",
+  },
+  {
+    "displayName": "gpt-4-vision-preview",
+    "name": "gpt-4-vision-preview",
+  },
+  {
+    "displayName": "gpt-4-32k",
+    "name": "gpt-4-1106-preview",
+  },
+]
+`;
+
+exports[`settingsSelectors > CUSTOM_MODELS > only add the model 1`] = `
+[
+  {
+    "displayName": "gpt-3.5-turbo",
+    "name": "gpt-3.5-turbo",
+  },
+  {
+    "displayName": "gpt-3.5-turbo-1106",
+    "name": "gpt-3.5-turbo-1106",
+  },
+  {
+    "displayName": "gpt-3.5-turbo-16k",
+    "name": "gpt-3.5-turbo-16k",
+  },
+  {
+    "displayName": "gpt-4",
+    "name": "gpt-4",
+  },
+  {
+    "displayName": "gpt-4-32k",
+    "name": "gpt-4-32k",
+  },
+  {
+    "displayName": "gpt-4-1106-preview",
+    "name": "gpt-4-1106-preview",
+  },
+  {
+    "displayName": "gpt-4-vision-preview",
+    "name": "gpt-4-vision-preview",
+  },
+  {
+    "displayName": "model1",
+    "name": "model1",
+  },
+  {
+    "displayName": "model2",
+    "name": "model2",
+  },
+  {
+    "displayName": "model3",
+    "name": "model3",
+  },
+  {
+    "displayName": "model4",
+    "name": "model4",
+  },
+]
+`;
+
 exports[`settingsSelectors > currentSettings > should merge DEFAULT_SETTINGS and s.settings correctly 1`] = `
 {
   "avatar": "avatar.jpg",

package/src/store/global/selectors/settings.test.ts

@@ -58,6 +58,57 @@ describe('settingsSelectors', () => {
     });
   });
 
+  describe('CUSTOM_MODELS', () => {
+    it('custom deletion, addition, and renaming of models', () => {
+      const s = {
+        settings: {
+          languageModel: {
+            openAI: {
+              customModelName:
+                '-all,+llama,+claude-2，-gpt-3.5-turbo,gpt-4-1106-preview=gpt-4-turbo,gpt-4-1106-preview=gpt-4-32k',
+            },
+          },
+        },
+      } as unknown as GlobalStore;
+
+      const result = settingsSelectors.modelList(s);
+
+      expect(result).toMatchSnapshot();
+    });
+
+    it('duplicate naming model', () => {
+      const s = {
+        settings: {
+          languageModel: {
+            openAI: {
+              customModelName: 'gpt-4-1106-preview=gpt-4-turbo，gpt-4-1106-preview=gpt-4-32k',
+            },
+          },
+        },
+      } as unknown as GlobalStore;
+
+      const result = settingsSelectors.modelList(s);
+
+      expect(result).toMatchSnapshot();
+    });
+
+    it('only add the model', () => {
+      const s = {
+        settings: {
+          languageModel: {
+            openAI: {
+              customModelName: 'model1,model2,model3，model4',
+            },
+          },
+        },
+      } as unknown as GlobalStore;
+
+      const result = settingsSelectors.modelList(s);
+
+      expect(result).toMatchSnapshot();
+    });
+  });
+
   // describe('defaultAgent', () => {
   //   it('should merge DEFAULT_AGENT and s.settings.defaultAgent correctly', () => {
   //     const s: GlobalStore = {

package/src/store/global/selectors/settings.ts

@@ -8,7 +8,7 @@ import {
   DEFAULT_TTS_CONFIG,
 } from '@/const/settings';
 import { Locales } from '@/locales/resources';
-import { GlobalSettings } from '@/types/settings';
+import { CustomModels, GlobalSettings } from '@/types/settings';
 import { isOnServerSide } from '@/utils/env';
 import { merge } from '@/utils/merge';
 
@@ -29,10 +29,41 @@ const openAIAPIKeySelectors = (s: GlobalStore) =>
 
 const openAIProxyUrlSelectors = (s: GlobalStore) => s.settings.languageModel.openAI.endpoint;
 
-const modelListSelectors = (s: GlobalStore) => [
-  ...DEFAULT_OPENAI_MODEL_LIST,
-  ...(s.settings.languageModel.openAI.customModelName || '').split(',').filter(Boolean),
-];
+const modelListSelectors = (s: GlobalStore) => {
+  let models: CustomModels = [];
+
+  const modelNames = [
+    ...DEFAULT_OPENAI_MODEL_LIST,
+    ...(s.settings.languageModel.openAI.customModelName || '').split(/[,，]/).filter(Boolean),
+  ];
+
+  for (const item of modelNames) {
+    const disable = item.startsWith('-');
+    const nameConfig = item.startsWith('+') || item.startsWith('-') ? item.slice(1) : item;
+    const [name, displayName] = nameConfig.split('=');
+
+    if (disable) {
+      // Disable all models.
+      if (name === 'all') {
+        models = [];
+      }
+      continue;
+    }
+
+    // Remove duplicate model entries.
+    const existingIndex = models.findIndex(({ name: n }) => n === name);
+    if (existingIndex !== -1) {
+      models.splice(existingIndex, 1);
+    }
+
+    models.push({
+      displayName: displayName || name,
+      name,
+    });
+  }
+
+  return models;
+};
 
 export const exportSettings = (s: GlobalStore) => {
   // eslint-disable-next-line @typescript-eslint/no-unused-vars

package/src/types/settings.ts

@@ -45,6 +45,8 @@ export interface GlobalBaseSettings {
 
 export type GlobalDefaultAgent = Pick<LobeAgentSession, 'config' | 'meta'>;
 
+export type CustomModels = { displayName: string; name: string }[];
+
 export interface OpenAIConfig {
   OPENAI_API_KEY: string;
   azureApiVersion?: string;