@lobehub/chat 1.14.12 → 1.15.0

package/CHANGELOG.md

@@ -2,6 +2,31 @@
 
 # Changelog
 
+## [Version 1.15.0](https://github.com/lobehub/lobe-chat/compare/v1.14.12...v1.15.0)
+
+<sup>Released on **2024-08-30**</sup>
+
+#### ✨ Features
+
+- **misc**: Add Upstage model provider support.
+
+<br/>
+
+<details>
+<summary><kbd>Improvements and Fixes</kbd></summary>
+
+#### What's improved
+
+- **misc**: Add Upstage model provider support, closes [#3670](https://github.com/lobehub/lobe-chat/issues/3670) ([4b8591b](https://github.com/lobehub/lobe-chat/commit/4b8591b))
+
+</details>
+
+<div align="right">
+
+[![](https://img.shields.io/badge/-BACK_TO_TOP-151515?style=flat-square)](#readme-top)
+
+</div>
+
 ### [Version 1.14.12](https://github.com/lobehub/lobe-chat/compare/v1.14.11...v1.14.12)
 
 <sup>Released on **2024-08-30**</sup>

package/Dockerfile

@@ -146,6 +146,8 @@ ENV \
     TAICHU_API_KEY="" \
     # TogetherAI
     TOGETHERAI_API_KEY="" TOGETHERAI_MODEL_LIST="" \
+    # Upstage
+    UPSTAGE_API_KEY="" \
     # 01.AI
     ZEROONE_API_KEY="" \
     # Zhipu

package/Dockerfile.database

@@ -178,6 +178,8 @@ ENV \
     TAICHU_API_KEY="" \
     # TogetherAI
     TOGETHERAI_API_KEY="" TOGETHERAI_MODEL_LIST="" \
+    # Upstage
+    UPSTAGE_API_KEY="" \
     # 01.AI
     ZEROONE_API_KEY="" \
     # Zhipu

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@lobehub/chat",
-  "version": "1.14.12",
+  "version": "1.15.0",
   "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)/settings/llm/ProviderList/providers.tsx

@@ -18,6 +18,7 @@ import {
   StepfunProviderCard,
   TaichuProviderCard,
   TogetherAIProviderCard,
+  UpstageProviderCard,
   ZeroOneProviderCard,
   ZhiPuProviderCard,
 } from '@/config/modelProviders';
@@ -59,6 +60,7 @@ export const useProviderList = (): ProviderItem[] => {
       TaichuProviderCard,
       Ai360ProviderCard,
       SiliconCloudProviderCard,
+      UpstageProviderCard,
     ],
     [AzureProvider, OllamaProvider, OpenAIProvider, BedrockProvider],
   );

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

@@ -208,6 +208,13 @@ const getLlmOptionsFromPayload = (provider: string, payload: JWTPayload) => {
 
       return { apiKey, baseURL };
     }
+    case ModelProvider.Upstage: {
+      const { UPSTAGE_API_KEY } = getLLMConfig();
+
+      const apiKey = apiKeyManager.pick(payload?.apiKey || UPSTAGE_API_KEY);
+
+      return { apiKey };
+    }
   }
 };
 

package/src/config/llm.ts

@@ -93,6 +93,9 @@ export const getLLMConfig = () => {
       SILICONCLOUD_API_KEY: z.string().optional(),
       SILICONCLOUD_MODEL_LIST: z.string().optional(),
       SILICONCLOUD_PROXY_URL: z.string().optional(),
+
+      ENABLED_UPSTAGE: z.boolean(),
+      UPSTAGE_API_KEY: z.string().optional(),
     },
     runtimeEnv: {
       API_KEY_SELECT_MODE: process.env.API_KEY_SELECT_MODE,
@@ -183,6 +186,9 @@ export const getLLMConfig = () => {
       SILICONCLOUD_API_KEY: process.env.SILICONCLOUD_API_KEY,
       SILICONCLOUD_MODEL_LIST: process.env.SILICONCLOUD_MODEL_LIST,
       SILICONCLOUD_PROXY_URL: process.env.SILICONCLOUD_PROXY_URL,
+
+      ENABLED_UPSTAGE: !!process.env.UPSTAGE_API_KEY,
+      UPSTAGE_API_KEY: process.env.UPSTAGE_API_KEY,
     },
   });
 };

package/src/config/modelProviders/index.ts

@@ -21,6 +21,7 @@ import SiliconCloudProvider from './siliconcloud';
 import StepfunProvider from './stepfun';
 import TaichuProvider from './taichu';
 import TogetherAIProvider from './togetherai';
+import UpstageProvider from './upstage';
 import ZeroOneProvider from './zeroone';
 import ZhiPuProvider from './zhipu';
 
@@ -47,6 +48,7 @@ export const LOBE_DEFAULT_MODEL_LIST: ChatModelCard[] = [
   TaichuProvider.chatModels,
   Ai360Provider.chatModels,
   SiliconCloudProvider.chatModels,
+  UpstageProvider.chatModels,
 ].flat();
 
 export const DEFAULT_MODEL_PROVIDER_LIST = [
@@ -73,6 +75,7 @@ export const DEFAULT_MODEL_PROVIDER_LIST = [
   TaichuProvider,
   Ai360Provider,
   SiliconCloudProvider,
+  UpstageProvider,
 ];
 
 export const filterEnabledModels = (provider: ModelProviderCard) => {
@@ -105,5 +108,6 @@ export { default as SiliconCloudProviderCard } from './siliconcloud';
 export { default as StepfunProviderCard } from './stepfun';
 export { default as TaichuProviderCard } from './taichu';
 export { default as TogetherAIProviderCard } from './togetherai';
+export { default as UpstageProviderCard } from './upstage';
 export { default as ZeroOneProviderCard } from './zeroone';
 export { default as ZhiPuProviderCard } from './zhipu';

package/src/config/modelProviders/upstage.ts

@@ -0,0 +1,45 @@
+import { ModelProviderCard } from '@/types/llm';
+
+// ref https://developers.upstage.ai/docs/getting-started/models
+const Upstage: ModelProviderCard = {
+  chatModels: [
+    {
+      description: 'A compact LLM offering superior performance to GPT-3.5, with robust multilingual capabilities for both English and Korean, delivering high efficiency in a smaller package. solar-1-mini-chat is alias for our latest solar-1-mini-chat model. (Currently solar-1-mini-chat-240612)',
+      displayName: 'Solar 1 Mini Chat',
+      enabled: true,
+      functionCall: true,
+      id: 'solar-1-mini-chat',
+      tokens: 32_768,
+    },
+    {
+      description: 'A compact LLM that extends the capabilities of solar-mini-chat with specialization in Japanese, while maintaining high efficiency and performance in English and Korean. solar-1-mini-chat-ja is alias for our latest solar-1-mini-chat-ja model.(Currently solar-1-mini-chat-ja-240612)',
+      displayName: 'Solar 1 Mini Chat Ja',
+      enabled: true,
+      functionCall: false,
+      id: 'solar-1-mini-chat-ja',
+      tokens: 32_768,
+    },
+    {
+      description: 'English-to-Korean translation specialized model based on the solar-mini. Maximum context length is 32k tokens. solar-1-mini-translate-enko is alias for our latest solar-1-mini-translate-enko model. (Currently solar-1-mini-translate-enko-240507)',
+      displayName: 'Solar 1 Mini Translate EnKo',
+      enabled: false,
+      functionCall: false,
+      id: 'solar-1-mini-translate-enko',
+      tokens: 32_768,
+    },
+    {
+      description: 'Korean-to-English translation specialized model based on the solar-mini. Maximum context length is 32k tokens. solar-1-mini-translate-koen is alias for our latest solar-1-mini-translate-koen model. (Currently solar-1-mini-translate-koen-240507)',
+      displayName: 'Solar 1 Mini Translate KoEn',
+      enabled: false,
+      functionCall: false,
+      id: 'solar-1-mini-translate-koen',
+      tokens: 32_768,
+    },
+  ],
+  checkModel: 'solar-1-mini-chat',
+  id: 'upstage',
+  modelList: { showModelFetcher: true },
+  name: 'Upstage',
+};
+
+export default Upstage;

package/src/const/settings/llm.ts

@@ -19,6 +19,7 @@ import {
   StepfunProviderCard,
   TaichuProviderCard,
   TogetherAIProviderCard,
+  UpstageProviderCard,
   ZeroOneProviderCard,
   ZhiPuProviderCard,
   filterEnabledModels,
@@ -111,6 +112,10 @@ export const DEFAULT_LLM_CONFIG: UserModelProviderConfig = {
     enabled: false,
     enabledModels: filterEnabledModels(TogetherAIProviderCard),
   },
+  upstage: {
+    enabled: false,
+    enabledModels: filterEnabledModels(UpstageProviderCard),
+  },
   zeroone: {
     enabled: false,
     enabledModels: filterEnabledModels(ZeroOneProviderCard),

package/src/features/Conversation/Error/APIKeyForm/ProviderAvatar.tsx

@@ -16,6 +16,7 @@ import {
   Stepfun,
   Together,
   Tongyi,
+  Upstage,
   ZeroOne,
   Zhipu,
 } from '@lobehub/icons';
@@ -103,6 +104,10 @@ const ProviderAvatar = memo<ProviderAvatarProps>(({ provider }) => {
       return <Ai360 color={Ai360.colorPrimary} size={56} />;
     }
 
+    case ModelProvider.Upstage: {
+      return <Upstage color={Upstage.colorPrimary} size={56} />;
+    }
+
     default:
     case ModelProvider.OpenAI: {
       return <OpenAI color={theme.colorText} size={64} />;

package/src/features/FileViewer/Renderer/Image/index.tsx

@@ -0,0 +1,36 @@
+import { DocRenderer } from '@cyntler/react-doc-viewer';
+import { Center } from 'react-layout-kit';
+
+const ImageRenderer: DocRenderer = ({ mainState: { currentDocument } }) => {
+  const { uri, fileName } = currentDocument || {};
+
+  return (
+    <Center height={'100%'} width={'100%'}>
+      <img
+        alt={fileName}
+        height={'100%'}
+        src={uri}
+        style={{ objectFit: 'contain', overflow: 'hidden' }}
+        width={'100%'}
+      />
+    </Center>
+  );
+};
+
+export default ImageRenderer;
+
+ImageRenderer.fileTypes = [
+  'jpg',
+  'jpeg',
+  'image/jpg',
+  'image/jpeg',
+  'png',
+  'image/png',
+  'webp',
+  'image/webp',
+  'gif',
+  'image/gif',
+  'bmp',
+  'image/bmp',
+];
+ImageRenderer.weight = 0;

package/src/features/FileViewer/Renderer/index.ts

@@ -1,4 +1,5 @@
+import ImageRenderer from './Image';
 import MSDocRenderer from './MSDoc';
 import TXTRenderer from './TXT';
 
-export const FileViewRenderers = [TXTRenderer, MSDocRenderer];
+export const FileViewRenderers = [TXTRenderer, ImageRenderer, MSDocRenderer];

package/src/features/FileViewer/index.tsx

@@ -1,7 +1,7 @@
 'use client';
 
 import DocViewer from '@cyntler/react-doc-viewer';
-import { createStyles } from 'antd-style';
+import { css, cx } from 'antd-style';
 import { CSSProperties, memo } from 'react';
 
 import { FileListItem } from '@/types/files';
@@ -10,12 +10,13 @@ import NotSupport from './NotSupport';
 import { FileViewRenderers } from './Renderer';
 import PDFRenderer from './Renderer/PDF';
 
-const useStyles = createStyles(({ css, token }) => ({
-  container: css`
-    padding: 12px;
-    background: ${token.colorBgLayout} !important;
-  `,
-}));
+const container = css`
+  background: transparent !important;
+
+  #proxy-renderer {
+    height: 100%;
+  }
+`;
 
 interface FileViewerProps extends FileListItem {
   className?: string;
@@ -23,14 +24,13 @@ interface FileViewerProps extends FileListItem {
 }
 
 const FileViewer = memo<FileViewerProps>(({ id, style, fileType, url, name }) => {
-  const { styles } = useStyles();
   if (fileType === 'pdf' || name.endsWith('.pdf')) {
     return <PDFRenderer fileId={id} url={url} />;
   }
 
   return (
     <DocViewer
-      className={styles.container}
+      className={cx(container)}
       config={{
         header: { disableHeader: true },
         noRenderer: { overrideComponent: NotSupport },

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

@@ -24,6 +24,7 @@ import { LobeSiliconCloudAI } from './siliconcloud';
 import { LobeStepfunAI } from './stepfun';
 import { LobeTaichuAI } from './taichu';
 import { LobeTogetherAI } from './togetherai';
+import { LobeUpstageAI } from './upstage';
 import {
   ChatCompetitionOptions,
   ChatStreamPayload,
@@ -134,6 +135,7 @@ class AgentRuntime {
       stepfun: Partial<ClientOptions>;
       taichu: Partial<ClientOptions>;
       togetherai: Partial<ClientOptions>;
+      upstage: Partial<ClientOptions>;
       zeroone: Partial<ClientOptions>;
       zhipu: Partial<ClientOptions>;
     }>,
@@ -261,6 +263,11 @@ class AgentRuntime {
         runtimeModel = new LobeSiliconCloudAI(params.siliconcloud ?? {});
         break;
       }
+
+      case ModelProvider.Upstage: {
+        runtimeModel = new LobeUpstageAI(params.upstage);
+        break
+      }
     }
 
     return new AgentRuntime(runtimeModel);

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

@@ -43,6 +43,7 @@ export enum ModelProvider {
   Stepfun = 'stepfun',
   Taichu = 'taichu',
   TogetherAI = 'togetherai',
+  Upstage = 'upstage',
   ZeroOne = 'zeroone',
   ZhiPu = 'zhipu',
 }

package/src/libs/agent-runtime/upstage/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 { LobeUpstageAI } from './index';
+
+const provider = ModelProvider.Upstage;
+const defaultBaseURL = 'https://api.upstage.ai/v1/solar';
+
+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 LobeUpstageAI({ apiKey: 'test' });
+
+  // 使用 vi.spyOn 来模拟 chat.completions.create 方法
+  vi.spyOn(instance['client'].chat.completions, 'create').mockResolvedValue(
+    new ReadableStream() as any,
+  );
+});
+
+afterEach(() => {
+  vi.clearAllMocks();
+});
+
+describe('LobeUpstageAI', () => {
+  describe('init', () => {
+    it('should correctly initialize with an API key', async () => {
+      const instance = new LobeUpstageAI({ apiKey: 'test_api_key' });
+      expect(instance).toBeInstanceOf(LobeUpstageAI);
+      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: 'solar-1-mini-chat',
+            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 LobeUpstageAI({});
+        } 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: 'solar-1-mini-chat',
+            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 LobeUpstageAI({
+          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: 'solar-1-mini-chat',
+            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 InvalidUpstageAPIKey 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: 'solar-1-mini-chat',
+            temperature: 0,
+          });
+        } catch (e) {
+          // Expect the chat method to throw an error with InvalidUpstageAPIKey
+          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: 'solar-1-mini-chat',
+            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_UPSTAGE_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_UPSTAGE_CHAT_COMPLETION;
+
+        // 模拟环境变量
+        process.env.DEBUG_UPSTAGE_CHAT_COMPLETION = '1';
+        vi.spyOn(debugStreamModule, 'debugStream').mockImplementation(() => Promise.resolve());
+
+        // 执行测试
+        // 运行你的测试函数，确保它会在条件满足时调用 debugStream
+        // 假设的测试函数调用，你可能需要根据实际情况调整
+        await instance.chat({
+          messages: [{ content: 'Hello', role: 'user' }],
+          model: 'solar-1-mini-chat',
+          stream: true,
+          temperature: 0,
+        });
+
+        // 验证 debugStream 被调用
+        expect(debugStreamModule.debugStream).toHaveBeenCalled();
+
+        // 恢复原始环境变量值
+        process.env.DEBUG_UPSTAGE_CHAT_COMPLETION = originalDebugValue;
+      });
+    });
+  });
+});

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

@@ -0,0 +1,10 @@
+import { ModelProvider } from '../types';
+import { LobeOpenAICompatibleFactory } from '../utils/openaiCompatibleFactory';
+
+export const LobeUpstageAI = LobeOpenAICompatibleFactory({
+  baseURL: 'https://api.upstage.ai/v1/solar',
+  debug: {
+    chatCompletion: () => process.env.DEBUG_UPSTAGE_CHAT_COMPLETION === '1',
+  },
+  provider: ModelProvider.Upstage,
+});

package/src/server/globalConfig/index.ts

@@ -47,6 +47,8 @@ export const getServerGlobalConfig = () => {
     ENABLED_SILICONCLOUD,
     SILICONCLOUD_MODEL_LIST,
 
+    ENABLED_UPSTAGE,
+    
     ENABLED_AZURE_OPENAI,
     AZURE_MODEL_LIST,
 
@@ -138,6 +140,7 @@ export const getServerGlobalConfig = () => {
           modelString: TOGETHERAI_MODEL_LIST,
         }),
       },
+      upstage: { enabled: ENABLED_UPSTAGE },
       zeroone: { enabled: ENABLED_ZEROONE },
       zhipu: { 
         enabled: ENABLED_ZHIPU, 

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

@@ -39,6 +39,7 @@ export interface UserKeyVaults {
   stepfun?: OpenAICompatibleKeyVault;
   taichu?: OpenAICompatibleKeyVault;
   togetherai?: OpenAICompatibleKeyVault;
+  upstage?: OpenAICompatibleKeyVault;
   zeroone?: OpenAICompatibleKeyVault;
   zhipu?: OpenAICompatibleKeyVault;
 }