@lobehub/chat 0.122.9 → 0.123.1

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

@@ -1,64 +1,166 @@
-import { DEFAULT_OPENAI_MODEL_LIST } from '@/const/llm';
-import { CustomModels } from '@/types/settings';
+import { produce } from 'immer';
+
+import {
+  BedrockProvider,
+  GoogleProvider,
+  LOBE_DEFAULT_MODEL_LIST,
+  OpenAIProvider,
+  ZhiPuProvider,
+} from '@/config/modelProviders';
+import { ChatModelCard, ModelProviderCard } from '@/types/llm';
+import { parseModelString } from '@/utils/parseModels';
 
 import { GlobalStore } from '../../../store';
 import { currentSettings } from './settings';
 
-const openAIConfig = (s: GlobalStore) => currentSettings(s).languageModel.openAI;
+const modelProvider = (s: GlobalStore) => currentSettings(s).languageModel;
+const openAIConfig = (s: GlobalStore) => modelProvider(s).openAI;
 
-const openAIAPIKeySelectors = (s: GlobalStore) =>
-  currentSettings(s).languageModel.openAI.OPENAI_API_KEY;
+const openAIAPIKey = (s: GlobalStore) => openAIConfig(s).OPENAI_API_KEY;
+const openAIProxyUrl = (s: GlobalStore) => openAIConfig(s).endpoint;
 
-const enableAzure = (s: GlobalStore) => currentSettings(s).languageModel.openAI.useAzure;
+const enableZhipu = (s: GlobalStore) => modelProvider(s).zhipu.enabled;
+const zhipuAPIKey = (s: GlobalStore) => modelProvider(s).zhipu.apiKey;
+const zhipuProxyUrl = (s: GlobalStore) => modelProvider(s).zhipu.endpoint;
 
-const openAIProxyUrlSelectors = (s: GlobalStore) =>
-  currentSettings(s).languageModel.openAI.endpoint;
+const enableBedrock = (s: GlobalStore) => modelProvider(s).bedrock.enabled;
+const bedrockConfig = (s: GlobalStore) => modelProvider(s).bedrock;
 
-const modelListSelectors = (s: GlobalStore) => {
-  let models: CustomModels = [];
+const enableGoogle = (s: GlobalStore) => modelProvider(s).google.enabled;
+const googleAPIKey = (s: GlobalStore) => modelProvider(s).google.apiKey;
+const googleProxyUrl = (s: GlobalStore) => modelProvider(s).google.endpoint;
 
-  const removedModels: string[] = [];
-  const modelNames = [
-    ...DEFAULT_OPENAI_MODEL_LIST,
-    ...(s.serverConfig.customModelName || '').split(/[,，]/).filter(Boolean),
-    ...(currentSettings(s).languageModel.openAI.customModelName || '')
-      .split(/[,，]/)
-      .filter(Boolean),
-  ];
+const enableAzure = (s: GlobalStore) => modelProvider(s).openAI.useAzure;
+const azureConfig = (s: GlobalStore) => modelProvider(s).azure;
 
-  for (const item of modelNames) {
-    const disable = item.startsWith('-');
-    const nameConfig = item.startsWith('+') || item.startsWith('-') ? item.slice(1) : item;
-    const [name, displayName] = nameConfig.split('=');
+// const azureModelList = (s: GlobalStore): ModelProviderCard => {
+//   const azure = azureConfig(s);
+//   return {
+//     chatModels: parseModelString(azure.deployments),
+//     id: 'azure',
+//   };
+// };
 
-    if (disable) {
-      // Disable all models.
-      if (name === 'all') {
-        models = [];
+// 提取处理 chatModels 的专门方法
+const processChatModels = (modelConfig: ReturnType<typeof parseModelString>): ChatModelCard[] => {
+  let chatModels = modelConfig.removeAll ? [] : OpenAIProvider.chatModels;
+
+  // 处理移除逻辑
+  if (!modelConfig.removeAll) {
+    chatModels = chatModels.filter((m) => !modelConfig.removed.includes(m.id));
+  }
+
+  return produce(chatModels, (draft) => {
+    // 处理添加或替换逻辑
+    for (const customModel of modelConfig.add) {
+      // 首先尝试在 LOBE_DEFAULT_MODEL_LIST 中查找模型
+      const defaultModel = LOBE_DEFAULT_MODEL_LIST.find((model) => model.id === customModel.id);
+
+      // 如果在默认列表中找到了模型，则基于该模型进行更新
+      if (defaultModel) {
+        const model = draft.find((model) => model.id === customModel.id);
+        // 如果当前 chatModels 中已有该模型，更新它
+        if (model) {
+          if (model.hidden) delete model.hidden;
+          if (customModel.displayName) model.displayName = customModel.displayName;
+        } else {
+          // 如果当前 chatModels 中没有该模型，添加它
+          draft.push({
+            ...defaultModel,
+            displayName: customModel.displayName || defaultModel.displayName,
+          });
+        }
+      } else {
+        // 如果在默认列表中未找到模型，作为新的自定义模型添加
+        draft.push({
+          ...customModel,
+          displayName: customModel.displayName || customModel.id,
+          functionCall: true,
+          isCustom: true,
+          vision: true,
+        });
       }
-      removedModels.push(name);
-      continue;
     }
+  });
+};
 
-    // Remove duplicate model entries.
-    const existingIndex = models.findIndex(({ name: n }) => n === name);
-    if (existingIndex !== -1) {
-      models.splice(existingIndex, 1);
-    }
+const modelSelectList = (s: GlobalStore): ModelProviderCard[] => {
+  const string = [
+    s.serverConfig.customModelName,
+    currentSettings(s).languageModel.openAI.customModelName,
+  ]
+    .filter(Boolean)
+    .join(',');
 
-    models.push({
-      displayName: displayName || name,
-      name,
-    });
-  }
+  const modelConfig = parseModelString(string);
+
+  const chatModels = processChatModels(modelConfig);
 
-  return models.filter((m) => !removedModels.includes(m.name));
+  return [
+    {
+      ...OpenAIProvider,
+      chatModels,
+    },
+    // { ...azureModelList(s), enabled: enableAzure(s) },
+    { ...ZhiPuProvider, enabled: enableZhipu(s) },
+    { ...GoogleProvider, enabled: enableGoogle(s) },
+    { ...BedrockProvider, enabled: enableBedrock(s) },
+  ];
 };
 
+const modelCardById = (id: string) => (s: GlobalStore) => {
+  const list = modelSelectList(s);
+
+  return list.flatMap((i) => i.chatModels).find((m) => m.id === id);
+};
+
+const modelEnabledFunctionCall = (id: string) => (s: GlobalStore) =>
+  modelCardById(id)(s)?.functionCall || false;
+
+// vision model white list, these models will change the content from string to array
+// refs: https://github.com/lobehub/lobe-chat/issues/790
+const modelEnabledVision = (id: string) => (s: GlobalStore) =>
+  modelCardById(id)(s)?.vision || id.includes('vision');
+
+const modelEnabledFiles = (id: string) => (s: GlobalStore) => modelCardById(id)(s)?.files;
+
+const modelEnabledUpload = (id: string) => (s: GlobalStore) =>
+  modelEnabledVision(id)(s) || modelEnabledFiles(id)(s);
+
+const modelHasMaxToken = (id: string) => (s: GlobalStore) =>
+  typeof modelCardById(id)(s)?.tokens !== 'undefined';
+
+const modelMaxToken = (id: string) => (s: GlobalStore) => modelCardById(id)(s)?.tokens || 0;
+
+/* eslint-disable sort-keys-fix/sort-keys-fix,  */
 export const modelProviderSelectors = {
-  enableAzure,
-  modelList: modelListSelectors,
-  openAIAPI: openAIAPIKeySelectors,
+  modelSelectList,
+
+  modelCardById,
+  modelMaxToken,
+  modelHasMaxToken,
+
+  modelEnabledFunctionCall,
+  modelEnabledVision,
+  modelEnabledFiles,
+  modelEnabledUpload,
+
+  // OpenAI
   openAIConfig,
-  openAIProxyUrl: openAIProxyUrlSelectors,
+  openAIAPIKey,
+  openAIProxyUrl,
+  // Azure OpenAI
+  enableAzure,
+  azureConfig,
+  // Zhipu
+  enableZhipu,
+  zhipuAPIKey,
+  zhipuProxyUrl,
+  // Google
+  enableGoogle,
+  googleAPIKey,
+  googleProxyUrl,
+  // Bedrock
+  enableBedrock,
+  bedrockConfig,
 };

package/src/store/session/slices/agent/selectors.test.ts

@@ -177,52 +177,4 @@ describe('agentSelectors', () => {
       expect(description).toBe('noDescription'); // Assuming translation returns this key
     });
   });
-
-  describe('showTokenTag', () => {
-    it('should return true if the model is in the list of models that show tokens', () => {
-      const show = agentSelectors.showTokenTag(mockSessionStore);
-      expect(show).toBe(true);
-    });
-
-    it('should return false if the model is not in the list of models that show tokens', () => {
-      const modifiedSessionStore = {
-        ...mockSessionStore,
-        sessions: [
-          {
-            ...mockSessionStore.sessions[0],
-            config: {
-              ...mockSessionStore.sessions[0].config,
-              model: 'some-other-model',
-            },
-          },
-        ],
-      };
-      const show = agentSelectors.showTokenTag(modifiedSessionStore);
-      expect(show).toBe(false);
-    });
-  });
-
-  describe('modelHasVisionAbility', () => {
-    it('should return true if the model has vision ability', () => {
-      const hasAbility = agentSelectors.modelHasVisionAbility(mockSessionStore);
-      expect(hasAbility).toBe(false);
-    });
-
-    it('should return false if the model does not have vision ability', () => {
-      const modifiedSessionStore = {
-        ...mockSessionStore,
-        sessions: [
-          {
-            ...mockSessionStore.sessions[0],
-            config: {
-              ...mockSessionStore.sessions[0].config,
-              model: 'some-other-model',
-            },
-          },
-        ],
-      };
-      const hasAbility = agentSelectors.modelHasVisionAbility(modifiedSessionStore);
-      expect(hasAbility).toBe(false);
-    });
-  });
 });

package/src/store/session/slices/agent/selectors.ts

@@ -1,7 +1,6 @@
 import { VoiceList } from '@lobehub/tts';
 import { t } from 'i18next';
 
-import { DEFAULT_OPENAI_MODEL_LIST, isVisionModel } from '@/const/llm';
 import { DEFAULT_AVATAR, DEFAULT_BACKGROUND_COLOR, DEFAULT_INBOX_AVATAR } from '@/const/meta';
 import { DEFAULT_AGENT_CONFIG, DEFAUTT_AGENT_TTS_CONFIG } from '@/const/settings';
 import { useGlobalStore } from '@/store/global';
@@ -36,6 +35,12 @@ const currentAgentModel = (s: SessionStore): LanguageModel | string => {
   return config?.model || LanguageModel.GPT3_5;
 };
 
+const currentAgentModelProvider = (s: SessionStore) => {
+  const config = currentAgentConfig(s);
+
+  return config?.provider;
+};
+
 const currentAgentPlugins = (s: SessionStore) => {
   const config = currentAgentConfig(s);
 
@@ -99,20 +104,11 @@ const getTitle = (s: MetaData) => s.title || t('defaultSession', { ns: 'common'
 export const getDescription = (s: MetaData) =>
   s.description || t('noDescription', { ns: 'common' });
 
-const showTokenTag = (s: SessionStore) => {
-  const model = currentAgentModel(s);
-
-  return DEFAULT_OPENAI_MODEL_LIST.includes(model);
-};
 const hasSystemRole = (s: SessionStore) => {
   const config = currentAgentConfig(s);
 
   return !!config.systemRole;
 };
-const modelHasVisionAbility = (s: SessionStore): boolean => {
-  const model = currentAgentModel(s);
-  return isVisionModel(model);
-};
 
 export const agentSelectors = {
   currentAgentAvatar,
@@ -121,6 +117,7 @@ export const agentSelectors = {
   currentAgentDescription,
   currentAgentMeta,
   currentAgentModel,
+  currentAgentModelProvider,
   currentAgentPlugins,
   currentAgentSystemRole,
   currentAgentTTS,
@@ -130,6 +127,4 @@ export const agentSelectors = {
   getDescription,
   getTitle,
   hasSystemRole,
-  modelHasVisionAbility,
-  showTokenTag,
 };

package/src/types/agent/index.ts

@@ -1,4 +1,4 @@
-import { FewShots, LLMParams, LanguageModel } from '@/types/llm';
+import { FewShots, LLMParams } from '@/types/llm';
 
 export type TTSServer = 'openai' | 'edge' | 'microsoft';
 
@@ -37,7 +37,7 @@ export interface LobeAgentConfig {
    * 角色所使用的语言模型
    * @default gpt-3.5-turbo
    */
-  model: LanguageModel | string;
+  model: string;
   /**
    * 语言模型参数
    */
@@ -46,6 +46,10 @@ export interface LobeAgentConfig {
    * 启用的插件
    */
   plugins?: string[];
+  /**
+   *  模型供应商
+   */
+  provider?: string;
   /**
    * 系统角色
    */

package/src/types/fetch.ts

@@ -1,10 +1,12 @@
 /* eslint-disable sort-keys-fix/sort-keys-fix */
+import { ILobeAgentRuntimeErrorType } from '@/libs/agent-runtime';
+
 export const ChatErrorType = {
   // ******* 业务错误语义 ******* //
 
   InvalidAccessCode: 'InvalidAccessCode', // 密码无效
   OpenAIBizError: 'OpenAIBizError', // OpenAI 返回的业务错误
-  NoAPIKey: 'NoAPIKey',
+  NoOpenAIAPIKey: 'NoOpenAIAPIKey',
 
   // ******* 客户端错误 ******* //
   BadRequest: 400,
@@ -26,5 +28,5 @@ export type ErrorType = (typeof ChatErrorType)[keyof typeof ChatErrorType];
 
 export interface ErrorResponse {
   body: any;
-  errorType: ErrorType;
+  errorType: ErrorType | ILobeAgentRuntimeErrorType;
 }

package/src/types/files.ts

@@ -1,8 +1,8 @@
-import { DB_File } from '../database/schemas/files';
-
-export interface FilePreview extends Pick<DB_File, 'saveMode' | 'fileType'> {
+export interface FilePreview {
   base64Url?: string;
   data?: ArrayBuffer;
+  fileType: string;
   name: string;
+  saveMode: 'local' | 'url';
   url: string;
 }

package/src/types/llm.ts

@@ -17,6 +17,40 @@ export enum LanguageModel {
   GPT4_VISION_PREVIEW = 'gpt-4-vision-preview',
 }
 
+export interface ChatModelCard {
+  description?: string;
+  displayName?: string;
+  /**
+   * whether model supports file upload
+   */
+  files?: boolean;
+  /**
+   * whether model supports function call
+   */
+  functionCall?: boolean;
+  hidden?: boolean;
+  id: string;
+  /**
+   * whether model is custom
+   */
+  isCustom?: boolean;
+  /**
+   * whether model is legacy (deprecated but not removed yet)
+   */
+  legacy?: boolean;
+  tokens?: number;
+  /**
+   *  whether model supports vision
+   */
+  vision?: boolean;
+}
+
+export interface ModelProviderCard {
+  chatModels: ChatModelCard[];
+  enabled?: boolean;
+  id: string;
+}
+
 // 语言模型的设置参数
 export interface LLMParams {
   /**

package/src/types/message/index.ts

@@ -1,9 +1,12 @@
+import { IPluginErrorType } from '@lobehub/chat-plugin-sdk';
+
+import { ILobeAgentRuntimeErrorType } from '@/libs/agent-runtime';
 import { ErrorType } from '@/types/fetch';
-import { Translate } from '@/types/translate';
 
 import { LLMRoleType } from '../llm';
 import { BaseDataModel } from '../meta';
 import { ChatPluginPayload } from './tools';
+import { Translate } from './translate';
 
 /**
  * 聊天消息错误对象
@@ -11,7 +14,7 @@ import { ChatPluginPayload } from './tools';
 export interface ChatMessageError {
   body?: any;
   message: string;
-  type: ErrorType;
+  type: ErrorType | IPluginErrorType | ILobeAgentRuntimeErrorType;
 }
 
 export interface ChatTranslate extends Translate {
@@ -28,10 +31,11 @@ export * from './tools';
 
 export interface ChatMessage extends BaseDataModel {
   content: string;
-  error?: any;
+  error?: ChatMessageError;
   // 扩展字段
   extra?: {
     fromModel?: string;
+    fromProvider?: string;
     // 翻译
     translate?: ChatTranslate | false;
     // TTS

package/src/types/openai/chat.ts

@@ -32,24 +32,15 @@ export interface OpenAIChatMessage {
   role: LLMRoleType;
 }
 
-export interface OpenAIChatStringMessage {
-  content: string;
-  role: LLMRoleType;
-}
-
 /**
- * @title OpenAI Stream Payload
+ * @title Chat Stream Payload
  */
-export interface OpenAIChatStreamPayload {
+export interface ChatStreamPayload {
   /**
    * @title 控制生成文本中的惩罚系数，用于减少重复性
    * @default 0
    */
   frequency_penalty?: number;
-  /**
-   * @deprecated
-   */
-  functions?: ChatCompletionFunctions[];
   /**
    * @title 生成文本的最大长度
    */
@@ -75,6 +66,10 @@ export interface OpenAIChatStreamPayload {
    * @default 0
    */
   presence_penalty?: number;
+  /**
+   * @default openai
+   */
+  provider?: string;
   /**
    * @title 是否开启流式请求
    * @default true

package/src/types/settings/index.ts

@@ -21,6 +21,7 @@ export interface GlobalTool {
 export interface GlobalServerConfig {
   customModelName?: string;
   defaultAgent?: DeepPartial<GlobalDefaultAgent>;
+  languageModel?: DeepPartial<GlobalLLMConfig>;
 }
 
 /**

package/src/types/settings/modelProvider.ts

@@ -1,4 +1,4 @@
-export type CustomModels = { displayName: string; name: string }[];
+export type CustomModels = { displayName: string; id: string }[];
 
 export interface OpenAIConfig {
   OPENAI_API_KEY: string;
@@ -8,10 +8,46 @@ export interface OpenAIConfig {
    */
   customModelName?: string;
   endpoint?: string;
+  /**
+   * @deprecated
+   */
   models?: string[];
   useAzure?: boolean;
 }
 
+export interface AzureOpenAIConfig {
+  apiKey: string;
+  apiVersion?: string;
+  deployments: string;
+  enabled: boolean;
+  endpoint?: string;
+}
+
+export interface ZhiPuConfig {
+  apiKey?: string;
+  enabled: boolean;
+  endpoint?: string;
+}
+
+export interface GoogleConfig {
+  apiKey?: string;
+  enabled: boolean;
+  endpoint?: string;
+}
+
+export interface AWSBedrockConfig {
+  accessKeyId?: string;
+  enabled: boolean;
+  region?: string;
+  secretAccessKey?: string;
+}
+
 export interface GlobalLLMConfig {
+  azure: AzureOpenAIConfig;
+  bedrock: AWSBedrockConfig;
+  google: GoogleConfig;
   openAI: OpenAIConfig;
+  zhipu: ZhiPuConfig;
 }
+
+export type GlobalLLMProviderKey = keyof GlobalLLMConfig;

package/src/utils/__snapshots__/parseModels.test.ts.snap

@@ -0,0 +1,63 @@
+// Vitest Snapshot v1, https://vitest.dev/guide/snapshot.html
+
+exports[`parseModelString > custom deletion, addition, and renaming of models 1`] = `
+{
+  "add": [
+    {
+      "displayName": undefined,
+      "id": "llama",
+    },
+    {
+      "displayName": undefined,
+      "id": "claude-2",
+    },
+    {
+      "displayName": "gpt-4-32k",
+      "id": "gpt-4-1106-preview",
+    },
+  ],
+  "removeAll": true,
+  "removed": [
+    "all",
+    "gpt-3.5-turbo",
+  ],
+}
+`;
+
+exports[`parseModelString > duplicate naming model 1`] = `
+{
+  "add": [
+    {
+      "displayName": "gpt-4-32k",
+      "id": "gpt-4-1106-preview",
+    },
+  ],
+  "removeAll": false,
+  "removed": [],
+}
+`;
+
+exports[`parseModelString > only add the model 1`] = `
+{
+  "add": [
+    {
+      "displayName": undefined,
+      "id": "model1",
+    },
+    {
+      "displayName": undefined,
+      "id": "model2",
+    },
+    {
+      "displayName": undefined,
+      "id": "model3",
+    },
+    {
+      "displayName": undefined,
+      "id": "model4",
+    },
+  ],
+  "removeAll": false,
+  "removed": [],
+}
+`;

package/src/utils/parseModels.test.ts

@@ -0,0 +1,24 @@
+import { describe, expect, it } from 'vitest';
+
+import { parseModelString } from './parseModels';
+
+describe('parseModelString', () => {
+  it('custom deletion, addition, and renaming of models', () => {
+    const result = parseModelString(
+      '-all,+llama,+claude-2，-gpt-3.5-turbo,gpt-4-1106-preview=gpt-4-turbo,gpt-4-1106-preview=gpt-4-32k',
+    );
+
+    expect(result).toMatchSnapshot();
+  });
+
+  it('duplicate naming model', () => {
+    const result = parseModelString('gpt-4-1106-preview=gpt-4-turbo，gpt-4-1106-preview=gpt-4-32k');
+    expect(result).toMatchSnapshot();
+  });
+
+  it('only add the model', () => {
+    const result = parseModelString('model1,model2,model3，model4');
+
+    expect(result).toMatchSnapshot();
+  });
+});

package/src/utils/parseModels.ts

@@ -0,0 +1,37 @@
+import { CustomModels } from '@/types/settings';
+
+export const parseModelString = (modelString: string = '') => {
+  let models: CustomModels = [];
+  let removeAll = false;
+  const removedModels: string[] = [];
+  const modelNames = modelString.split(/[,，]/).filter(Boolean);
+
+  for (const item of modelNames) {
+    const disable = item.startsWith('-');
+    const nameConfig = item.startsWith('+') || item.startsWith('-') ? item.slice(1) : item;
+    const [id, displayName] = nameConfig.split('=');
+
+    if (disable) {
+      // Disable all models.
+      if (id === 'all') {
+        removeAll = true;
+      }
+      removedModels.push(id);
+      continue;
+    }
+
+    // Remove duplicate model entries.
+    const existingIndex = models.findIndex(({ id: n }) => n === id);
+    if (existingIndex !== -1) {
+      models.splice(existingIndex, 1);
+    }
+
+    models.push({ displayName, id: id });
+  }
+
+  return {
+    add: models,
+    removeAll,
+    removed: removedModels,
+  };
+};