@lobehub/chat 0.122.9 → 0.123.0

package/src/libs/agent-runtime/zhipu/authToken.ts

@@ -0,0 +1,22 @@
+import { SignJWT } from 'jose';
+
+export const generateApiToken = async (apiKey?: string): Promise<string> => {
+  if (!apiKey) {
+    throw new Error('Invalid apiKey');
+  }
+
+  const [id, secret] = apiKey.split('.');
+  if (!id || !secret) {
+    throw new Error('Invalid apiKey');
+  }
+
+  const expSeconds = 60 * 60 * 24 * 30;
+  const nowSeconds = Math.floor(Date.now() / 1000);
+  const exp = nowSeconds + expSeconds;
+  const jwtConstructor = new SignJWT({ api_key: id })
+    .setProtectedHeader({ alg: 'HS256', sign_type: 'SIGN', typ: 'JWT' })
+    .setExpirationTime(exp)
+    .setIssuedAt(nowSeconds);
+
+  return jwtConstructor.sign(new TextEncoder().encode(secret));
+};

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

@@ -0,0 +1,125 @@
+import { OpenAIStream, StreamingTextResponse } from 'ai';
+import OpenAI from 'openai';
+
+import { LobeRuntimeAI } from '../BaseAI';
+import { AgentRuntimeErrorType } from '../error';
+import { ChatStreamPayload, ModelProvider, OpenAIChatMessage } from '../types';
+import { AgentRuntimeError } from '../utils/createError';
+import { debugStream } from '../utils/debugStream';
+import { desensitizeUrl } from '../utils/desensitizeUrl';
+import { DEBUG_CHAT_COMPLETION } from '../utils/env';
+import { handleOpenAIError } from '../utils/handleOpenAIError';
+import { parseDataUri } from '../utils/uriParser';
+import { generateApiToken } from './authToken';
+
+const DEFAULT_BASE_URL = 'https://open.bigmodel.cn/api/paas/v4';
+
+export class LobeZhipuAI implements LobeRuntimeAI {
+  private _llm: OpenAI;
+
+  baseURL: string;
+
+  constructor(oai: OpenAI) {
+    this._llm = oai;
+    this.baseURL = this._llm.baseURL;
+  }
+
+  static async fromAPIKey(apiKey?: string, baseURL: string = DEFAULT_BASE_URL) {
+    const invalidZhipuAPIKey = AgentRuntimeError.createError(
+      AgentRuntimeErrorType.InvalidZhipuAPIKey,
+    );
+
+    let token: string;
+
+    try {
+      token = await generateApiToken(apiKey);
+    } catch {
+      throw invalidZhipuAPIKey;
+    }
+
+    const header = { Authorization: `Bearer ${token}` };
+
+    const llm = new OpenAI({ apiKey, baseURL, defaultHeaders: header });
+
+    return new LobeZhipuAI(llm);
+  }
+
+  async chat(payload: ChatStreamPayload) {
+    try {
+      const params = this.buildCompletionsParams(payload);
+
+      const response = await this._llm.chat.completions.create(
+        params as unknown as OpenAI.ChatCompletionCreateParamsStreaming,
+      );
+
+      const stream = OpenAIStream(response);
+
+      const [debug, returnStream] = stream.tee();
+
+      if (DEBUG_CHAT_COMPLETION) {
+        debugStream(debug).catch(console.error);
+      }
+
+      return new StreamingTextResponse(returnStream);
+    } catch (error) {
+      const { errorResult, RuntimeError } = handleOpenAIError(error);
+
+      const errorType = RuntimeError || AgentRuntimeErrorType.ZhipuBizError;
+
+      let desensitizedEndpoint = this.baseURL;
+
+      if (this.baseURL !== DEFAULT_BASE_URL) {
+        desensitizedEndpoint = desensitizeUrl(this.baseURL);
+      }
+      throw AgentRuntimeError.chat({
+        endpoint: desensitizedEndpoint,
+        error: errorResult,
+        errorType,
+        provider: ModelProvider.ZhiPu,
+      });
+    }
+  }
+
+  private buildCompletionsParams(payload: ChatStreamPayload) {
+    const { messages, temperature, top_p, ...params } = payload;
+
+    return {
+      messages: messages.map((m) => this.transformMessage(m)) as any,
+      ...params,
+      do_sample: temperature === 0,
+      stream: true,
+      // 当前的模型侧不支持 top_p=1 和 temperature 为 0
+      // refs: https://zhipu-ai.feishu.cn/wiki/TUo0w2LT7iswnckmfSEcqTD0ncd
+      temperature: temperature === 0 ? undefined : temperature,
+      top_p: top_p === 1 ? 0.99 : top_p,
+    };
+  }
+
+  // TODO: 临时处理，后续需要移除
+  private transformMessage = (message: OpenAIChatMessage): OpenAIChatMessage => {
+    return {
+      ...message,
+      content:
+        typeof message.content === 'string'
+          ? message.content
+          : message.content.map((c) => {
+              switch (c.type) {
+                default:
+                case 'text': {
+                  return c;
+                }
+
+                case 'image_url': {
+                  const { base64 } = parseDataUri(c.image_url.url);
+                  return {
+                    image_url: { ...c.image_url, url: base64 || c.image_url.url },
+                    type: 'image_url',
+                  };
+                }
+              }
+            }),
+    };
+  };
+}
+
+export default LobeZhipuAI;

package/src/locales/default/chat.ts

@@ -1,4 +1,7 @@
 export default {
+  ModelSwitch: {
+    title: '模型',
+  },
   agentDefaultMessage:
     '你好，我是 **{{name}}**，你可以立即与我开始对话，也可以前往 [助手设置](/chat/settings#session={{id}}) 完善我的信息。',
   agentDefaultMessageWithSystemRole: '你好，我是 **{{name}}**，{{systemRole}}，让我们开始对话吧！',
@@ -66,8 +69,14 @@ export default {
     prettifying: '润色中...',
   },
   temp: '临时',
-  tokenDetail:
-    '角色设定: {{systemRoleToken}} · 会话消息: {{chatsToken}} · 工具设定: {{toolsToken}}',
+  tokenDetails: {
+    chats: '会话消息',
+    rest: '剩余可用',
+    systemRole: '角色设定',
+    tools: '插件设定',
+    total: '总共可用',
+    used: '总计使用',
+  },
   tokenTag: {
     overload: '超过限制',
     remained: '剩余',
@@ -105,6 +114,7 @@ export default {
   updateAgent: '更新助理信息',
   upload: {
     actionTooltip: '上传图片',
+    disabled: '当前模型不支持视觉识别，请切换模型后使用',
     dragDesc: '拖拽文件到这里，支持上传多个图片。按住 Shift 直接发送图片',
     dragTitle: '上传图片',
   },

package/src/locales/default/common.ts

@@ -1,4 +1,12 @@
 export default {
+  ModelSelect: {
+    featureTag: {
+      custom: '自定义模型，默认设定同时支持函数调用与视觉识别，请根据实际情况验证上述能力的可用性',
+      functionCall: '该模型支持函数调用（Function Call）',
+      tokens: '该模型单个会话最多支持 {{tokens}} Tokens',
+      vision: '该模型支持视觉识别',
+    },
+  },
   about: '关于',
   advanceSettings: '高级设置',
   agentMaxToken: '会话最大长度',
@@ -89,6 +97,14 @@ export default {
     'zh-TW': '繁体中文',
   },
   layoutInitializing: '正在加载布局...',
+  modelProvider: {
+    azure: 'Azure',
+    bedrock: 'AWS Bedrock',
+    google: 'Google',
+    oneapi: 'One API',
+    openai: 'OpenAI',
+    zhipu: '智谱AI',
+  },
   noDescription: '暂无描述',
   ok: '确定',
   password: '密码',

package/src/locales/default/error.ts

@@ -51,9 +51,26 @@ export default {
     PluginGatewayError: '很抱歉，插件网关出现错误，请检查插件网关配置是否正确',
     PluginOpenApiInitError: '很抱歉，OpenAPI 客户端初始化失败，请检查 OpenAPI 的配置信息是否正确',
 
-    InvalidAccessCode: '密码不正确或为空，请输入正确的访问密码，或者添加自定义 OpenAI API Key',
+    InvalidAccessCode: '密码不正确或为空，请输入正确的访问密码，或者添加自定义 API Key',
+    LocationNotSupportError:
+      '很抱歉，你的所在位置不支持此模型服务，可能是由于地区限制或服务未开通。请确认当前位置是否支持使用此服务，或尝试使用其他位置信息。',
+
     OpenAIBizError: '请求 OpenAI 服务出错，请根据以下信息排查或重试',
-    NoAPIKey: 'OpenAI API Key 为空，请添加自定义 OpenAI API Key',
+    NoOpenAIAPIKey: 'OpenAI API Key 为空，请添加自定义 OpenAI API Key',
+
+    ZhipuBizError: '请求智谱服务出错，请根据以下信息排查或重试',
+    InvalidZhipuAPIKey: 'Zhipu API Key 不正确或为空，请检查 Zhipu API Key 后重试',
+
+    GoogleBizError: '请求 Google 服务出错，请根据以下信息排查或重试',
+    InvalidGoogleAPIKey: 'Google API Key 不正确或为空，请检查 Google API Key 后重试',
+
+    InvalidBedrockCredentials: 'Bedrock 鉴权未通过，请检查 AccessKeyId/SecretAccessKey 后重试',
+    BedrockBizError: '请求 Bedrock 服务出错，请根据以下信息排查或重试',
+
+    InvalidAzureAPIKey: 'Azure API Key 不正确或为空，请检查 Azure API Key 后重试',
+    AzureBizError: '请求 Azure AI 服务出错，请根据以下信息排查或重试',
+
+    AgentRuntimeError: 'Lobe 语言模型运行时执行出错，请根据以下信息排查或重试',
     /* eslint-enable */
   },
   stt: {
@@ -64,9 +81,25 @@ export default {
   },
   unlock: {
     apikey: {
-      addProxyUrl: '添加 OpenAI 代理地址（可选）',
-      description: '输入你的 OpenAI API Key 即可开始会话。应用不会记录你的 API Key',
-      title: '使用自定义 API Key',
+      Bedrock: {
+        customRegion: '自定义服务区域',
+        description:
+          '输入你的 Aws AccessKeyId / SecretAccessKey 即可开始会话。应用不会记录你的鉴权配置',
+        title: '使用自定义 Bedrock 鉴权信息',
+      },
+      Google: {
+        description: '输入你的 Google API Key 即可开始会话。应用不会记录你的 API Key',
+        title: '使用自定义 Google API Key',
+      },
+      OpenAI: {
+        addProxyUrl: '添加 OpenAI 代理地址（可选）',
+        description: '输入你的 OpenAI API Key 即可开始会话。应用不会记录你的 API Key',
+        title: '使用自定义 OpenAI API Key',
+      },
+      Zhipu: {
+        description: '输入你的 Zhipu API Key 即可开始会话。应用不会记录你的 API Key',
+        title: '使用自定义 Zhipu API Key',
+      },
     },
     closeMessage: '关闭提示',
     confirm: '确认并重试',
@@ -75,5 +108,9 @@ export default {
       placeholder: '请输入密码',
       title: '输入密码解锁应用',
     },
+    tabs: {
+      apiKey: '自定义 API Key',
+      password: '密码',
+    },
   },
 };

package/src/locales/default/setting.ts

@@ -22,6 +22,16 @@ export default {
   },
   llm: {
     AzureOpenAI: {
+      azureApiVersion: {
+        desc: 'Azure 的 API 版本，遵循 YYYY-MM-DD 格式，查阅[最新版本](https://learn.microsoft.com/zh-cn/azure/ai-services/openai/reference#chat-completions)',
+        fetch: '获取列表',
+        title: 'Azure Api Version',
+      },
+      deployments: {
+        desc: '使用 id=name 的语法填写你的部署模型（如部署名和模型同名，可以只填写模型名称），多个模型使用逗号（,） 隔开',
+        title: 'Azure 部署模型列表',
+      },
+
       endpoint: {
         desc: '从 Azure 门户检查资源时，可在“密钥和终结点”部分中找到此值',
         placeholder: 'https://docs-test-001.openai.azure.com',
@@ -31,25 +41,48 @@ export default {
         desc: '支持的模型',
         title: '模型列表',
       },
-      title: 'Azure OpenAI 设置',
+      title: 'Azure OpenAI',
       token: {
         desc: '从 Azure 门户检查资源时，可在“密钥和终结点”部分中找到此值。 可以使用 KEY1 或 KEY2',
         placeholder: 'Azure API Key',
         title: 'API Key',
       },
     },
+    Bedrock: {
+      accessKeyId: {
+        desc: '填入Aws Access Key Id',
+        placeholder: 'Aws Access Key Id',
+        title: 'Aws Access Key Id',
+      },
+      checker: {
+        desc: '测试 AccessKeyId / SecretAccessKey 是否填写正确',
+      },
+      region: {
+        desc: '填入 Aws Region',
+        placeholder: 'Aws Region',
+        title: 'Aws Region',
+      },
+      secretAccessKey: {
+        desc: '填入 Aws Secret Access Key',
+        placeholder: 'Aws Secret Access Key',
+        title: 'Aws Secret Access Key',
+      },
+      title: 'Bedrock',
+    },
+    Google: {
+      title: 'Google',
+      token: {
+        desc: '填入来自 Google 的 API Key',
+        placeholder: 'Google API Key',
+        title: 'API Key',
+      },
+    },
     OpenAI: {
       azureApiVersion: {
         desc: 'Azure 的 API 版本，遵循 YYYY-MM-DD 格式，查阅[最新版本](https://learn.microsoft.com/zh-cn/azure/ai-services/openai/reference#chat-completions)',
         fetch: '获取列表',
         title: 'Azure Api Version',
       },
-      check: {
-        button: '检查',
-        desc: '测试 Api Key 与代理地址是否正确填写',
-        pass: '检查通过',
-        title: '连通性检查',
-      },
       customModelName: {
         desc: '增加自定义模型，多个模型使用逗号（,） 隔开',
         placeholder: 'model1,model2,model3',
@@ -69,11 +102,11 @@ export default {
         refetch: '重新获取模型列表',
         title: '模型列表',
       },
-      title: 'OpenAI 设置',
+      title: 'OpenAI',
       token: {
         desc: '使用自己的 OpenAI Key',
         placeholder: 'OpenAI API Key',
-        title: 'API Key',
+        title: 'OpenAI API Key',
       },
       useAzure: {
         desc: '使用 Azure 提供的 OpenAI 服务',
@@ -82,6 +115,21 @@ export default {
         title: 'Azure OpenAI',
       },
     },
+    Zhipu: {
+      title: '智谱',
+      token: {
+        desc: '填入来自智谱的 API Key',
+        placeholder: 'Zhipu API Key',
+        title: 'API Key',
+      },
+    },
+
+    checker: {
+      button: '检查',
+      desc: '测试 Api Key 与代理地址是否正确填写',
+      pass: '检查通过',
+      title: '连通性检查',
+    },
     waitingForMore: '更多模型正在 <1>计划接入</1> 中，敬请期待 ✨',
   },
   plugin: {
@@ -291,14 +339,15 @@ export default {
   },
   tools: {
     builtins: {
-      groupName: '内置扩展',
+      groupName: '内置插件',
     },
+    disabled: '当前模型不支持函数调用，无法使用插件',
     plugins: {
       enabled: '已启用 {{num}}',
-      groupName: '插件',
+      groupName: '三方插件',
       noEnabled: '暂无启用插件',
       store: '插件商店',
     },
-    title: '扩展工具',
+    title: '扩展插件',
   },
 };

package/src/services/__tests__/chat.test.ts

@@ -7,9 +7,10 @@ import { useFileStore } from '@/store/file';
 import { useToolStore } from '@/store/tool';
 import { DalleManifest } from '@/tools/dalle';
 import { ChatMessage } from '@/types/message';
-import { OpenAIChatStreamPayload } from '@/types/openai/chat';
+import { ChatStreamPayload } from '@/types/openai/chat';
 import { LobeTool } from '@/types/tool';
 
+// import { createHeaderWithAuth } from '../_header';
 import { chatService } from '../chat';
 
 // Mocking external dependencies
@@ -23,6 +24,11 @@ vi.mock('@/utils/fetch', () => ({
   getMessageError: vi.fn(),
 }));
 
+// mock auth
+vi.mock('../_auth', () => ({
+  createHeaderWithAuth: vi.fn().mockResolvedValue({}),
+}));
+
 describe('ChatService', () => {
   describe('createAssistantMessage', () => {
     it('should process messages and call getChatCompletion with the right parameters', async () => {
@@ -531,7 +537,7 @@ Get data from users`,
 
   describe('getChatCompletion', () => {
     it('should make a POST request with the correct payload', async () => {
-      const params: Partial<OpenAIChatStreamPayload> = {
+      const params: Partial<ChatStreamPayload> = {
         model: 'test-model',
         messages: [],
       };

package/src/services/__tests__/message.test.ts

@@ -217,7 +217,7 @@ describe('MessageService', () => {
   describe('updateMessageError', () => {
     it('should update the error field of a message', async () => {
       // Setup
-      const newError = { type: 'NoAPIKey', message: 'Error occurred' } as ChatMessageError;
+      const newError = { type: 'NoOpenAIAPIKey', message: 'Error occurred' } as ChatMessageError;
       (MessageModel.update as Mock).mockResolvedValue({ ...mockMessage, error: newError });
 
       // Execute

package/src/services/_auth.ts

@@ -0,0 +1,106 @@
+import { SignJWT, importJWK } from 'jose';
+
+import { JWTPayload, JWT_SECRET_KEY, LOBE_CHAT_AUTH_HEADER } from '@/const/auth';
+import { ModelProvider } from '@/libs/agent-runtime';
+import { useGlobalStore } from '@/store/global';
+import { modelProviderSelectors, settingsSelectors } from '@/store/global/selectors';
+
+const createJWT = async (payload: JWTPayload) => {
+  // 将AccessCode转换成适合作为密钥的格式，例如使用SHA-256进行哈希
+  const encoder = new TextEncoder();
+  const secretKey = await crypto.subtle.digest('SHA-256', encoder.encode(JWT_SECRET_KEY));
+
+  // 将密钥导入为JWK格式
+  const jwkSecretKey = await importJWK(
+    {
+      k: Buffer.from(secretKey).toString('base64'),
+      kty: 'oct',
+    },
+    'HS256',
+  );
+
+  // 获取当前时间戳
+  const now = Math.floor(Date.now() / 1000);
+
+  // 创建JWT
+  return new SignJWT(payload as Record<string, any>)
+    .setProtectedHeader({ alg: 'HS256' })
+    .setIssuedAt(now) // 设置JWT的iat（签发时间）声明
+    .setExpirationTime(now + 100) // 设置 JWT 的 exp（过期时间）为 100 s
+    .sign(jwkSecretKey);
+};
+
+const getProviderAuthPayload = (provider: string) => {
+  switch (provider) {
+    case ModelProvider.ZhiPu: {
+      return { apiKey: modelProviderSelectors.zhipuAPIKey(useGlobalStore.getState()) };
+    }
+
+    case ModelProvider.Google: {
+      return { apiKey: modelProviderSelectors.googleAPIKey(useGlobalStore.getState()) };
+    }
+
+    case ModelProvider.Bedrock: {
+      const { accessKeyId, region, secretAccessKey } = modelProviderSelectors.bedrockConfig(
+        useGlobalStore.getState(),
+      );
+      const awsSecretAccessKey = secretAccessKey;
+      const awsAccessKeyId = accessKeyId;
+
+      const apiKey = (awsSecretAccessKey || '') + (awsAccessKeyId || '');
+
+      return { apiKey, awsAccessKeyId, awsRegion: region, awsSecretAccessKey };
+    }
+
+    case ModelProvider.Azure: {
+      const azure = modelProviderSelectors.azureConfig(useGlobalStore.getState());
+
+      return {
+        apiKey: azure.apiKey,
+        azureApiVersion: azure.apiVersion,
+        endpoint: azure.endpoint,
+      };
+    }
+
+    default:
+    case ModelProvider.OpenAI: {
+      const openai = modelProviderSelectors.openAIConfig(useGlobalStore.getState());
+      const apiKey = openai.OPENAI_API_KEY || '';
+      const endpoint = openai.endpoint || '';
+
+      return {
+        apiKey,
+        azureApiVersion: openai.azureApiVersion,
+        endpoint,
+        useAzure: openai.useAzure,
+      };
+    }
+  }
+};
+
+const createAuthTokenWithPayload = async (payload = {}) => {
+  const accessCode = settingsSelectors.password(useGlobalStore.getState());
+
+  return await createJWT({ accessCode, ...payload });
+};
+
+interface AuthParams {
+  // eslint-disable-next-line no-undef
+  headers?: HeadersInit;
+  payload?: Record<string, any>;
+  provider?: string;
+}
+
+// eslint-disable-next-line no-undef
+export const createHeaderWithAuth = async (params?: AuthParams): Promise<HeadersInit> => {
+  let payload = params?.payload || {};
+
+  if (params?.provider) {
+    payload = { ...payload, ...getProviderAuthPayload(params?.provider) };
+  }
+
+  const token = await createAuthTokenWithPayload(payload);
+
+  // eslint-disable-next-line no-undef
+  return { ...params?.headers, [LOBE_CHAT_AUTH_HEADER]: token };
+};

package/src/services/_header.ts

@@ -8,6 +8,7 @@ import {
 import { useGlobalStore } from '@/store/global';
 import { modelProviderSelectors, settingsSelectors } from '@/store/global/selectors';
 
+// TODO: Need to be removed after tts refactor
 // eslint-disable-next-line no-undef
 export const createHeaderWithOpenAI = (header?: HeadersInit): HeadersInit => {
   const openai = modelProviderSelectors.openAIConfig(useGlobalStore.getState());

package/src/services/_url.ts

@@ -10,9 +10,7 @@ export const PLUGINS_URLS = {
 };
 
 export const OPENAI_URLS = {
-  chat: '/api/openai/chat',
   images: '/api/openai/images',
-  models: '/api/openai/models',
   stt: '/api/openai/stt',
   tts: '/api/openai/tts',
 };