@lobehub/chat 1.1.18 → 1.2.1

package/CHANGELOG.md

@@ -2,6 +2,56 @@
 
 # Changelog
 
+### [Version 1.2.1](https://github.com/lobehub/lobe-chat/compare/v1.2.0...v1.2.1)
+
+<sup>Released on **2024-07-01**</sup>
+
+#### ♻ Code Refactoring
+
+- **misc**: Refactor the portal file.
+
+<br/>
+
+<details>
+<summary><kbd>Improvements and Fixes</kbd></summary>
+
+#### Code refactoring
+
+- **misc**: Refactor the portal file, closes [#3106](https://github.com/lobehub/lobe-chat/issues/3106) ([2d9635f](https://github.com/lobehub/lobe-chat/commit/2d9635f))
+
+</details>
+
+<div align="right">
+
+[![](https://img.shields.io/badge/-BACK_TO_TOP-151515?style=flat-square)](#readme-top)
+
+</div>
+
+## [Version 1.2.0](https://github.com/lobehub/lobe-chat/compare/v1.1.18...v1.2.0)
+
+<sup>Released on **2024-07-01**</sup>
+
+#### ✨ Features
+
+- **misc**: Add Baichuan model provider.
+
+<br/>
+
+<details>
+<summary><kbd>Improvements and Fixes</kbd></summary>
+
+#### What's improved
+
+- **misc**: Add Baichuan model provider, closes [#3097](https://github.com/lobehub/lobe-chat/issues/3097) ([378cf02](https://github.com/lobehub/lobe-chat/commit/378cf02))
+
+</details>
+
+<div align="right">
+
+[![](https://img.shields.io/badge/-BACK_TO_TOP-151515?style=flat-square)](#readme-top)
+
+</div>
+
 ### [Version 1.1.18](https://github.com/lobehub/lobe-chat/compare/v1.1.17...v1.1.18)
 
 <sup>Released on **2024-07-01**</sup>

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@lobehub/chat",
-  "version": "1.1.18",
+  "version": "1.2.1",
   "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",

package/src/app/(main)/chat/(workspace)/@portal/features/Tools/ToolUI/ToolRender.tsx

@@ -3,7 +3,7 @@ import isEqual from 'fast-deep-equal';
 import PluginRender from '@/features/PluginsUI/Render';
 import { useChatStore } from '@/store/chat';
 import { chatPortalSelectors, chatSelectors } from '@/store/chat/selectors';
-import { BuiltinToolsDocks } from '@/tools/docks';
+import { BuiltinToolsPortals } from '@/tools/portals';
 import { safeParseJSON } from '@/utils/safeParseJSON';
 
 const ToolRender = () => {
@@ -22,7 +22,7 @@ const ToolRender = () => {
 
   if (!args) return;
 
-  const Render = BuiltinToolsDocks[plugin.identifier];
+  const Render = BuiltinToolsPortals[plugin.identifier];
 
   if (!Render)
     return (

package/src/app/(main)/settings/llm/ProviderList/providers.tsx

@@ -1,5 +1,6 @@
 import {
   Anthropic,
+  Baichuan,
   Claude,
   DeepSeek,
   Gemini,
@@ -24,6 +25,7 @@ import urlJoin from 'url-join';
 
 import {
   AnthropicProviderCard,
+  BaichuanProviderCard,
   DeepSeekProviderCard,
   GoogleProviderCard,
   GroqProviderCard,
@@ -170,6 +172,11 @@ export const useProviderList = (): ProviderItem[] => {
         docUrl: urlJoin(BASE_DOC_URL, 'stepfun'),
         title: <Stepfun.Combine size={20} type={'color'} />,
       },
+      {
+        ...BaichuanProviderCard,
+        docUrl: urlJoin(BASE_DOC_URL, 'baichuan'),
+        title: <Baichuan.Combine size={ 20 } type={ 'color' } />,
+      },
     ],
     [azureProvider, ollamaProvider, ollamaProvider, bedrockProvider],
   );

package/src/app/api/chat/agentRuntime.ts

@@ -170,6 +170,13 @@ const getLlmOptionsFromPayload = (provider: string, payload: JWTPayload) => {
 
       const apiKey = apiKeyManager.pick(payload?.apiKey || STEPFUN_API_KEY);
 
+      return { apiKey };
+    }
+    case ModelProvider.Baichuan: {
+      const { BAICHUAN_API_KEY } = getLLMConfig();
+
+      const apiKey = apiKeyManager.pick(payload?.apiKey || BAICHUAN_API_KEY);
+
       return { apiKey };
     }
   }

package/src/components/ModelProviderIcon/index.tsx

@@ -1,6 +1,7 @@
 import {
   Anthropic,
   Azure,
+  Baichuan,
   Bedrock,
   DeepSeek,
   Google,
@@ -114,6 +115,10 @@ const ModelProviderIcon = memo<ModelProviderIconProps>(({ provider }) => {
       return <Stepfun size={20} />;
     }
 
+    case ModelProvider.Baichuan: {
+      return <Baichuan size={20} />;
+    }
+
     default: {
       return null;
     }

package/src/config/llm.ts

@@ -82,6 +82,9 @@ export const getLLMConfig = () => {
 
       ENABLED_STEPFUN: z.boolean(),
       STEPFUN_API_KEY: z.string().optional(),
+
+      ENABLED_BAICHUAN: z.boolean(),
+      BAICHUAN_API_KEY: z.string().optional(),
     },
     runtimeEnv: {
       API_KEY_SELECT_MODE: process.env.API_KEY_SELECT_MODE,
@@ -155,6 +158,9 @@ export const getLLMConfig = () => {
 
       ENABLED_STEPFUN: !!process.env.STEPFUN_API_KEY,
       STEPFUN_API_KEY: process.env.STEPFUN_API_KEY,
+
+      ENABLED_BAICHUAN: !!process.env.BAICHUAN_API_KEY,
+      BAICHUAN_API_KEY: process.env.BAICHUAN_API_KEY,
     },
   });
 };

package/src/config/modelProviders/baichuan.ts

@@ -0,0 +1,55 @@
+import { ModelProviderCard } from '@/types/llm';
+
+// ref https://platform.baichuan-ai.com/price
+const Baichuan: ModelProviderCard = {
+  chatModels: [
+    {
+      description: '模型能力国内第一，在知识百科、长文本、生成创作等中文任务上超越国外主流模型。还具备行业领先的多模态能力，多项权威评测基准表现优异。',
+      displayName: 'Baichuan 4',
+      enabled: true,
+      functionCall: true,
+      id: 'Baichuan4',
+      maxOutput: 4096,
+      tokens: 32_768,
+    },
+    {
+      description: '针对企业高频场景优化，效果大幅提升，高性价比。相对于Baichuan2模型，内容创作提升20%，知识问答提升17%， 角色扮演能力提升40%。整体效果比GPT3.5更优。',
+      displayName: 'Baichuan 3 Turbo',
+      enabled: true,
+      functionCall: true,
+      id: 'Baichuan3-Turbo',
+      maxOutput: 8192,
+      tokens: 32_768,
+    },
+    {
+      description: '具备 128K 超长上下文窗口，针对企业高频场景优化，效果大幅提升，高性价比。相对于Baichuan2模型，内容创作提升20%，知识问答提升17%， 角色扮演能力提升40%。整体效果比GPT3.5更优。',
+      displayName: 'Baichuan 3 Turbo 128k',
+      enabled: true,
+      id: 'Baichuan3-Turbo-128k',
+      maxOutput: 4096,
+      tokens: 128_000,
+    },
+    {
+      description: '采用搜索增强技术实现大模型与领域知识、全网知识的全面链接。支持PDF、Word等多种文档上传及网址输入，信息获取及时、全面，输出结果准确、专业。',
+      displayName: 'Baichuan 2 Turbo',
+      enabled: true,
+      id: 'Baichuan2-Turbo',
+      maxOutput: 8192,
+      tokens: 32_768,
+    },
+    {
+      description: '具备 192K 超长上下文窗口，采用搜索增强技术实现大模型与领域知识、全网知识的全面链接。支持PDF、Word等多种文档上传及网址输入，信息获取及时、全面，输出结果准确、专业。',
+      displayName: 'Baichuan 2 Turbo 192k',
+      enabled: true,
+      id: 'Baichuan2-Turbo-192k',
+      maxOutput: 2048,
+      tokens: 192_000,
+    },
+  ],
+  checkModel: 'Baichuan4',
+  id: 'baichuan',
+  modelList: { showModelFetcher: true },
+  name: 'Baichuan',
+};
+
+export default Baichuan;

package/src/config/modelProviders/index.ts

@@ -2,6 +2,7 @@ import { ChatModelCard, ModelProviderCard } from '@/types/llm';
 
 import AnthropicProvider from './anthropic';
 import AzureProvider from './azure';
+import BaichuanProvider from './baichuan';
 import BedrockProvider from './bedrock';
 import DeepSeekProvider from './deepseek';
 import GoogleProvider from './google';
@@ -37,6 +38,7 @@ export const LOBE_DEFAULT_MODEL_LIST: ChatModelCard[] = [
   AnthropicProvider.chatModels,
   ZeroOneProvider.chatModels,
   StepfunProvider.chatModels,
+  BaichuanProvider.chatModels,
 ].flat();
 
 export const DEFAULT_MODEL_PROVIDER_LIST = [
@@ -58,6 +60,7 @@ export const DEFAULT_MODEL_PROVIDER_LIST = [
   ZeroOneProvider,
   ZhiPuProvider,
   StepfunProvider,
+  BaichuanProvider,
 ];
 
 export const filterEnabledModels = (provider: ModelProviderCard) => {
@@ -66,6 +69,7 @@ export const filterEnabledModels = (provider: ModelProviderCard) => {
 
 export { default as AnthropicProviderCard } from './anthropic';
 export { default as AzureProviderCard } from './azure';
+export { default as BaichuanProviderCard } from './baichuan';
 export { default as BedrockProviderCard } from './bedrock';
 export { default as DeepSeekProviderCard } from './deepseek';
 export { default as GoogleProviderCard } from './google';

package/src/const/settings/llm.ts

@@ -1,5 +1,6 @@
 import {
   AnthropicProviderCard,
+  BaichuanProviderCard,
   BedrockProviderCard,
   DeepSeekProviderCard,
   GoogleProviderCard,
@@ -29,6 +30,10 @@ export const DEFAULT_LLM_CONFIG: UserModelProviderConfig = {
   azure: {
     enabled: false,
   },
+  baichuan: {
+    enabled: false,
+    enabledModels: filterEnabledModels(BaichuanProviderCard),
+  },
   bedrock: {
     enabled: false,
     enabledModels: filterEnabledModels(BedrockProviderCard),

package/src/libs/agent-runtime/AgentRuntime.ts

@@ -5,6 +5,7 @@ import type { TracePayload } from '@/const/trace';
 import { LobeRuntimeAI } from './BaseAI';
 import { LobeAnthropicAI } from './anthropic';
 import { LobeAzureOpenAI } from './azureOpenai';
+import { LobeBaichuanAI } from './baichuan';
 import { LobeBedrockAI, LobeBedrockAIParams } from './bedrock';
 import { LobeDeepSeekAI } from './deepseek';
 import { LobeGoogleAI } from './google';
@@ -103,6 +104,7 @@ class AgentRuntime {
     params: Partial<{
       anthropic: Partial<ClientOptions>;
       azure: { apiVersion?: string; apikey?: string; endpoint?: string };
+      baichuan: Partial<ClientOptions>;
       bedrock: Partial<LobeBedrockAIParams>;
       deepseek: Partial<ClientOptions>;
       google: { apiKey?: string; baseURL?: string };
@@ -219,6 +221,11 @@ class AgentRuntime {
         runtimeModel = new LobeStepfunAI(params.stepfun ?? {});
         break;
       }
+
+      case ModelProvider.Baichuan: {
+        runtimeModel = new LobeBaichuanAI(params.baichuan ?? {});
+        break
+      }
     }
 
     return new AgentRuntime(runtimeModel);

package/src/libs/agent-runtime/baichuan/index.test.ts

@@ -0,0 +1,255 @@
+// @vitest-environment node
+import OpenAI from 'openai';
+import { Mock, afterEach, beforeEach, describe, expect, it, vi } from 'vitest';
+
+import {
+  ChatStreamCallbacks,
+  LobeOpenAICompatibleRuntime,
+  ModelProvider,
+} from '@/libs/agent-runtime';
+
+import * as debugStreamModule from '../utils/debugStream';
+import { LobeBaichuanAI } from './index';
+
+const provider = ModelProvider.Baichuan;
+const defaultBaseURL = 'https://api.baichuan-ai.com/v1';
+
+const bizErrorType = 'ProviderBizError';
+const invalidErrorType = 'InvalidProviderAPIKey';
+
+// Mock the console.error to avoid polluting test output
+vi.spyOn(console, 'error').mockImplementation(() => {});
+
+let instance: LobeOpenAICompatibleRuntime;
+
+beforeEach(() => {
+  instance = new LobeBaichuanAI({ apiKey: 'test' });
+
+  // 使用 vi.spyOn 来模拟 chat.completions.create 方法
+  vi.spyOn(instance['client'].chat.completions, 'create').mockResolvedValue(
+    new ReadableStream() as any,
+  );
+});
+
+afterEach(() => {
+  vi.clearAllMocks();
+});
+
+describe('LobeBaichuanAI', () => {
+  describe('init', () => {
+    it('should correctly initialize with an API key', async () => {
+      const instance = new LobeBaichuanAI({ apiKey: 'test_api_key' });
+      expect(instance).toBeInstanceOf(LobeBaichuanAI);
+      expect(instance.baseURL).toEqual(defaultBaseURL);
+    });
+  });
+
+  describe('chat', () => {
+    describe('Error', () => {
+      it('should return OpenAIBizError with an openai error response when OpenAI.APIError is thrown', async () => {
+        // Arrange
+        const apiError = new OpenAI.APIError(
+          400,
+          {
+            status: 400,
+            error: {
+              message: 'Bad Request',
+            },
+          },
+          'Error message',
+          {},
+        );
+
+        vi.spyOn(instance['client'].chat.completions, 'create').mockRejectedValue(apiError);
+
+        // Act
+        try {
+          await instance.chat({
+            messages: [{ content: 'Hello', role: 'user' }],
+            model: 'Baichuan4',
+            temperature: 0,
+          });
+        } catch (e) {
+          expect(e).toEqual({
+            endpoint: defaultBaseURL,
+            error: {
+              error: { message: 'Bad Request' },
+              status: 400,
+            },
+            errorType: bizErrorType,
+            provider,
+          });
+        }
+      });
+
+      it('should throw AgentRuntimeError with NoOpenAIAPIKey if no apiKey is provided', async () => {
+        try {
+          new LobeBaichuanAI({});
+        } catch (e) {
+          expect(e).toEqual({ errorType: invalidErrorType });
+        }
+      });
+
+      it('should return OpenAIBizError with the cause when OpenAI.APIError is thrown with cause', async () => {
+        // Arrange
+        const errorInfo = {
+          stack: 'abc',
+          cause: {
+            message: 'api is undefined',
+          },
+        };
+        const apiError = new OpenAI.APIError(400, errorInfo, 'module error', {});
+
+        vi.spyOn(instance['client'].chat.completions, 'create').mockRejectedValue(apiError);
+
+        // Act
+        try {
+          await instance.chat({
+            messages: [{ content: 'Hello', role: 'user' }],
+            model: 'Baichuan4',
+            temperature: 0,
+          });
+        } catch (e) {
+          expect(e).toEqual({
+            endpoint: defaultBaseURL,
+            error: {
+              cause: { message: 'api is undefined' },
+              stack: 'abc',
+            },
+            errorType: bizErrorType,
+            provider,
+          });
+        }
+      });
+
+      it('should return OpenAIBizError with an cause response with desensitize Url', async () => {
+        // Arrange
+        const errorInfo = {
+          stack: 'abc',
+          cause: { message: 'api is undefined' },
+        };
+        const apiError = new OpenAI.APIError(400, errorInfo, 'module error', {});
+
+        instance = new LobeBaichuanAI({
+          apiKey: 'test',
+
+          baseURL: 'https://api.abc.com/v1',
+        });
+
+        vi.spyOn(instance['client'].chat.completions, 'create').mockRejectedValue(apiError);
+
+        // Act
+        try {
+          await instance.chat({
+            messages: [{ content: 'Hello', role: 'user' }],
+            model: 'Baichuan4',
+            temperature: 0,
+          });
+        } catch (e) {
+          expect(e).toEqual({
+            endpoint: 'https://api.***.com/v1',
+            error: {
+              cause: { message: 'api is undefined' },
+              stack: 'abc',
+            },
+            errorType: bizErrorType,
+            provider,
+          });
+        }
+      });
+
+      it('should throw an InvalidBaichuanAPIKey error type on 401 status code', async () => {
+        // Mock the API call to simulate a 401 error
+        const error = new Error('Unauthorized') as any;
+        error.status = 401;
+        vi.mocked(instance['client'].chat.completions.create).mockRejectedValue(error);
+
+        try {
+          await instance.chat({
+            messages: [{ content: 'Hello', role: 'user' }],
+            model: 'Baichuan4',
+            temperature: 0,
+          });
+        } catch (e) {
+          // Expect the chat method to throw an error with InvalidBaichuanAPIKey
+          expect(e).toEqual({
+            endpoint: defaultBaseURL,
+            error: new Error('Unauthorized'),
+            errorType: invalidErrorType,
+            provider,
+          });
+        }
+      });
+
+      it('should return AgentRuntimeError for non-OpenAI errors', async () => {
+        // Arrange
+        const genericError = new Error('Generic Error');
+
+        vi.spyOn(instance['client'].chat.completions, 'create').mockRejectedValue(genericError);
+
+        // Act
+        try {
+          await instance.chat({
+            messages: [{ content: 'Hello', role: 'user' }],
+            model: 'Baichuan4',
+            temperature: 0,
+          });
+        } catch (e) {
+          expect(e).toEqual({
+            endpoint: defaultBaseURL,
+            errorType: 'AgentRuntimeError',
+            provider,
+            error: {
+              name: genericError.name,
+              cause: genericError.cause,
+              message: genericError.message,
+              stack: genericError.stack,
+            },
+          });
+        }
+      });
+    });
+
+    describe('DEBUG', () => {
+      it('should call debugStream and return StreamingTextResponse when DEBUG_BAICHUAN_CHAT_COMPLETION is 1', async () => {
+        // Arrange
+        const mockProdStream = new ReadableStream() as any; // 模拟的 prod 流
+        const mockDebugStream = new ReadableStream({
+          start(controller) {
+            controller.enqueue('Debug stream content');
+            controller.close();
+          },
+        }) as any;
+        mockDebugStream.toReadableStream = () => mockDebugStream; // 添加 toReadableStream 方法
+
+        // 模拟 chat.completions.create 返回值，包括模拟的 tee 方法
+        (instance['client'].chat.completions.create as Mock).mockResolvedValue({
+          tee: () => [mockProdStream, { toReadableStream: () => mockDebugStream }],
+        });
+
+        // 保存原始环境变量值
+        const originalDebugValue = process.env.DEBUG_BAICHUAN_CHAT_COMPLETION;
+
+        // 模拟环境变量
+        process.env.DEBUG_BAICHUAN_CHAT_COMPLETION = '1';
+        vi.spyOn(debugStreamModule, 'debugStream').mockImplementation(() => Promise.resolve());
+
+        // 执行测试
+        // 运行你的测试函数，确保它会在条件满足时调用 debugStream
+        // 假设的测试函数调用，你可能需要根据实际情况调整
+        await instance.chat({
+          messages: [{ content: 'Hello', role: 'user' }],
+          model: 'Baichuan4',
+          stream: true,
+          temperature: 0,
+        });
+
+        // 验证 debugStream 被调用
+        expect(debugStreamModule.debugStream).toHaveBeenCalled();
+
+        // 恢复原始环境变量值
+        process.env.DEBUG_BAICHUAN_CHAT_COMPLETION = originalDebugValue;
+      });
+    });
+  });
+});

package/src/libs/agent-runtime/baichuan/index.ts

@@ -0,0 +1,32 @@
+import OpenAI from 'openai';
+
+import { ChatStreamPayload, ModelProvider } from '../types';
+import { LobeOpenAICompatibleFactory } from '../utils/openaiCompatibleFactory';
+
+export const LobeBaichuanAI = LobeOpenAICompatibleFactory({
+  baseURL: 'https://api.baichuan-ai.com/v1',
+  chatCompletion: {
+    handlePayload: (payload: ChatStreamPayload) => {
+      const { frequency_penalty, ...rest } = payload;
+
+      let adjustedFrequencyPenalty = frequency_penalty ?? 1;
+
+      if (frequency_penalty !== undefined) {
+        if (frequency_penalty < 1) {
+          // If less than 1 (including negative values), add 1 to bring it into the 1-2 range
+          adjustedFrequencyPenalty = Math.min(Math.max(frequency_penalty + 1, 1), 2);
+        } else if (frequency_penalty > 2) {
+          // If greater than 2, cap it at 2
+          adjustedFrequencyPenalty = 2;
+        }
+        // If between 1 and 2, keep the original value
+      }
+
+      return { ...rest, frequency_penalty: adjustedFrequencyPenalty } as OpenAI.ChatCompletionCreateParamsStreaming;
+    },
+  },
+  debug: {
+    chatCompletion: () => process.env.DEBUG_BAICHUAN_CHAT_COMPLETION === '1',
+  },
+  provider: ModelProvider.Baichuan,
+});

package/src/libs/agent-runtime/types/type.ts

@@ -24,6 +24,7 @@ export interface CreateChatCompletionOptions {
 export enum ModelProvider {
   Anthropic = 'anthropic',
   Azure = 'azure',
+  Baichuan = 'baichuan',
   Bedrock = 'bedrock',
   DeepSeek = 'deepseek',
   Google = 'google',

package/src/server/globalConfig/index.ts

@@ -34,6 +34,7 @@ export const getServerGlobalConfig = () => {
     ENABLED_MISTRAL,
     ENABLED_QWEN,
     ENABLED_STEPFUN,
+    ENABLED_BAICHUAN,
 
     ENABLED_AZURE_OPENAI,
     AZURE_MODEL_LIST,
@@ -70,6 +71,7 @@ export const getServerGlobalConfig = () => {
           withDeploymentName: true,
         }),
       },
+      baichuan: { enabled: ENABLED_BAICHUAN },
       bedrock: { enabled: ENABLED_AWS_BEDROCK },
       deepseek: { enabled: ENABLED_DEEPSEEK },
       google: { enabled: ENABLED_GOOGLE },

package/src/tools/portals.ts

@@ -0,0 +1,3 @@
+import { BuiltinPortal } from '@/types/tool';
+
+export const BuiltinToolsPortals: Record<string, BuiltinPortal> = {};

package/src/types/tool/builtin.ts

@@ -37,11 +37,11 @@ export interface BuiltinRenderProps<Content = any, Arguments = any, State = any>
 
 export type BuiltinRender = <T = any>(props: BuiltinRenderProps<T>) => ReactNode;
 
-export interface BuiltinDockProps<Arguments = Record<string, any>, State = any> {
+export interface BuiltinPortalProps<Arguments = Record<string, any>, State = any> {
   arguments: Arguments;
   identifier: string;
   messageId: string;
   state: State;
 }
 
-export type BuiltinDock = <T = any>(props: BuiltinDockProps<T>) => ReactNode;
+export type BuiltinPortal = <T = any>(props: BuiltinPortalProps<T>) => ReactNode;

package/src/types/user/settings/keyVaults.ts

@@ -18,6 +18,7 @@ export interface AWSBedrockKeyVault {
 export interface UserKeyVaults {
   anthropic?: OpenAICompatibleKeyVault;
   azure?: AzureOpenAIKeyVault;
+  baichuan?: OpenAICompatibleKeyVault;
   bedrock?: AWSBedrockKeyVault;
   deepseek?: OpenAICompatibleKeyVault;
   google?: OpenAICompatibleKeyVault;

package/src/tools/docks.ts

@@ -1,3 +0,0 @@
-import { BuiltinDock } from '@/types/tool';
-
-export const BuiltinToolsDocks: Record<string, BuiltinDock> = {};