@lobehub/chat 0.122.9 → 0.123.0

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,
+  };
+};

package/src/app/api/openai/chat/createChatCompletion.test.ts

@@ -1,166 +0,0 @@
-import OpenAI, { APIError } from 'openai';
-import { Mock, afterEach, beforeEach, describe, expect, it, vi } from 'vitest';
-
-import { createChatCompletion } from './createChatCompletion';
-
-// Mock the console.error to avoid polluting test output
-vi.spyOn(console, 'error').mockImplementation(() => {});
-
-describe('createChatCompletion', () => {
-  let openaiInstance: OpenAI;
-
-  beforeEach(() => {
-    openaiInstance = new OpenAI({ apiKey: 'test', dangerouslyAllowBrowser: true });
-
-    // 使用 vi.spyOn 来模拟 chat.completions.create 方法
-    vi.spyOn(openaiInstance.chat.completions, 'create').mockResolvedValue(
-      new ReadableStream() as any,
-    );
-  });
-
-  afterEach(() => {
-    vi.clearAllMocks();
-  });
-
-  it('should return a StreamingTextResponse on successful API call', async () => {
-    // Arrange
-    const mockStream = new ReadableStream();
-    const mockResponse = Promise.resolve(mockStream);
-
-    (openaiInstance.chat.completions.create as Mock).mockResolvedValue(mockResponse);
-
-    // Act
-    const result = await createChatCompletion({
-      openai: openaiInstance,
-      payload: {
-        messages: [{ content: 'Hello', role: 'user' }],
-        model: 'text-davinci-003',
-        temperature: 0,
-      },
-    });
-
-    // Assert
-    expect(result).toBeInstanceOf(Response); // 注意这里的改动
-  });
-
-  it('should return 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(openaiInstance.chat.completions, 'create').mockRejectedValue(apiError);
-
-    // Act
-    const result = await createChatCompletion({
-      openai: openaiInstance,
-      payload: {
-        messages: [{ content: 'Hello', role: 'user' }],
-        model: 'text-davinci-003',
-        temperature: 0,
-      },
-    });
-
-    // Assert
-    expect(result).toBeInstanceOf(Response);
-    expect(result.status).toBe(577); // Your custom error status code
-  });
-
-  it('should return an cause response 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(openaiInstance.chat.completions, 'create').mockRejectedValue(apiError);
-
-    // Act
-    const result = await createChatCompletion({
-      openai: openaiInstance,
-      payload: {
-        messages: [{ content: 'Hello', role: 'user' }],
-        model: 'text-davinci-003',
-        temperature: 0,
-      },
-    });
-
-    // Assert
-    expect(result).toBeInstanceOf(Response);
-    expect(result.status).toBe(577); // Your custom error status code
-
-    const content = await result.json();
-    expect(content.body).toHaveProperty('endpoint');
-    expect(content.body.endpoint).toEqual('https://api.openai.com/v1');
-    expect(content.body.error).toEqual(errorInfo);
-  });
-
-  it('should return 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', {});
-
-    openaiInstance = new OpenAI({
-      apiKey: 'test',
-      dangerouslyAllowBrowser: true,
-      baseURL: 'https://api.abc.com/v1',
-    });
-
-    vi.spyOn(openaiInstance.chat.completions, 'create').mockRejectedValue(apiError);
-
-    // Act
-    const result = await createChatCompletion({
-      openai: openaiInstance,
-      payload: {
-        messages: [{ content: 'Hello', role: 'user' }],
-        model: 'gpt-3.5-turbo',
-        temperature: 0,
-      },
-    });
-
-    // Assert
-    expect(result).toBeInstanceOf(Response);
-    expect(result.status).toBe(577); // Your custom error status code
-
-    const content = await result.json();
-    expect(content.body.endpoint).toEqual('https://api.***.com/v1');
-    expect(content.body.error).toEqual(errorInfo);
-  });
-
-  it('should return a 500 error response for non-OpenAI errors', async () => {
-    // Arrange
-    const genericError = new Error('Generic Error');
-
-    vi.spyOn(openaiInstance.chat.completions, 'create').mockRejectedValue(genericError);
-
-    // Act
-    const result = await createChatCompletion({
-      openai: openaiInstance,
-      payload: {
-        messages: [{ content: 'Hello', role: 'user' }],
-        model: 'text-davinci-003',
-        temperature: 0,
-      },
-    });
-
-    // Assert
-    expect(result.status).toBe(500);
-    const content = await result.json();
-    expect(content.body).toHaveProperty('endpoint');
-    expect(content.body).toHaveProperty('error');
-  });
-});

package/src/app/api/openai/chat/createChatCompletion.ts

@@ -1,76 +0,0 @@
-import { OpenAIStream, StreamingTextResponse } from 'ai';
-import OpenAI from 'openai';
-
-import { ChatErrorType } from '@/types/fetch';
-import { OpenAIChatStreamPayload } from '@/types/openai/chat';
-
-import { createErrorResponse } from '../../errorResponse';
-import { desensitizeUrl } from './desensitizeUrl';
-
-interface CreateChatCompletionOptions {
-  openai: OpenAI;
-  payload: OpenAIChatStreamPayload;
-}
-
-export const createChatCompletion = async ({ payload, openai }: CreateChatCompletionOptions) => {
-  // ============  1. preprocess messages   ============ //
-  const { messages, ...params } = payload;
-
-  // ============  2. send api   ============ //
-
-  try {
-    const response = await openai.chat.completions.create(
-      {
-        messages,
-        ...params,
-        stream: true,
-      } as unknown as OpenAI.ChatCompletionCreateParamsStreaming,
-      { headers: { Accept: '*/*' } },
-    );
-    const stream = OpenAIStream(response);
-    return new StreamingTextResponse(stream);
-  } catch (error) {
-    let desensitizedEndpoint = openai.baseURL;
-
-    // refs: https://github.com/lobehub/lobe-chat/issues/842
-    if (openai.baseURL !== 'https://api.openai.com/v1') {
-      desensitizedEndpoint = desensitizeUrl(openai.baseURL);
-    }
-
-    // Check if the error is an OpenAI APIError
-    if (error instanceof OpenAI.APIError) {
-      let errorResult: any;
-
-      // if error is definitely OpenAI APIError, there will be an error object
-      if (error.error) {
-        errorResult = error.error;
-      }
-      // Or if there is a cause, we use error cause
-      // This often happened when there is a bug of the `openai` package.
-      else if (error.cause) {
-        errorResult = error.cause;
-      }
-      // if there is no other request error, the error object is a Response like object
-      else {
-        errorResult = { headers: error.headers, stack: error.stack, status: error.status };
-      }
-
-      // track the error at server side
-      console.error(errorResult);
-
-      return createErrorResponse(ChatErrorType.OpenAIBizError, {
-        endpoint: desensitizedEndpoint,
-        error: errorResult,
-      });
-    }
-
-    // track the non-openai error
-    console.error(error);
-
-    // return as a GatewayTimeout error
-    return createErrorResponse(ChatErrorType.InternalServerError, {
-      endpoint: desensitizedEndpoint,
-      error: JSON.stringify(error),
-    });
-  }
-};

package/src/app/api/openai/chat/route.ts

@@ -1,19 +0,0 @@
-import { OpenAIChatStreamPayload } from '@/types/openai/chat';
-
-import { getPreferredRegion } from '../../config';
-import { createBizOpenAI } from '../createBizOpenAI';
-import { createChatCompletion } from './createChatCompletion';
-
-export const runtime = 'edge';
-export const preferredRegion = getPreferredRegion();
-
-export const POST = async (req: Request) => {
-  const payload = (await req.json()) as OpenAIChatStreamPayload;
-
-  const openaiOrErrResponse = createBizOpenAI(req, payload.model);
-
-  // if resOrOpenAI is a Response, it means there is an error,just return it
-  if (openaiOrErrResponse instanceof Response) return openaiOrErrResponse;
-
-  return createChatCompletion({ openai: openaiOrErrResponse, payload });
-};

package/src/app/api/openai/models/route.ts

@@ -1,17 +0,0 @@
-import { getOpenAIAuthFromRequest } from '@/const/fetch';
-
-import { createOpenai } from '../createBizOpenAI/createOpenai';
-
-export const runtime = 'edge';
-
-export const POST = async (req: Request) => {
-  const { apiKey, endpoint } = getOpenAIAuthFromRequest(req);
-
-  const openAI = createOpenai(apiKey, endpoint);
-
-  const res = await openAI.models.list();
-
-  const modelList = res.data.map((i) => i.id);
-
-  return new Response(JSON.stringify(modelList));
-};

package/src/app/settings/llm/LLM/ModelList.tsx

@@ -1,51 +0,0 @@
-import { ActionIcon } from '@lobehub/ui';
-import { Button, Dropdown, Skeleton } from 'antd';
-import { MenuItemType } from 'antd/lib/menu/hooks/useItems';
-import { RotateCwIcon } from 'lucide-react';
-import { memo } from 'react';
-import { useTranslation } from 'react-i18next';
-import { Flexbox } from 'react-layout-kit';
-
-import { getModelList } from './getModelList';
-
-interface ModelListProps {
-  value?: string[];
-}
-const ModelList = memo<ModelListProps>(({ value }) => {
-  const { t } = useTranslation('setting');
-
-  const isLoading = !value;
-
-  if (isLoading)
-    return (
-      <Skeleton active paragraph={false} title={{ style: { marginBottom: 0 }, width: '50%' }} />
-    );
-
-  const isEmpty = value?.length === 0;
-
-  return isEmpty ? (
-    <Button
-      onClick={() => {
-        getModelList('openAI');
-      }}
-    >
-      {t('llm.OpenAI.models.fetch')}
-    </Button>
-  ) : (
-    <Dropdown
-      menu={{
-        items: (value || []).map<MenuItemType>((v) => ({
-          key: v,
-          label: v,
-        })),
-      }}
-    >
-      <Flexbox align={'center'} gap={8} horizontal>
-        {t('llm.OpenAI.models.count', { count: value.length })}
-        <ActionIcon icon={RotateCwIcon} size={'small'} title={t('llm.OpenAI.models.refetch')} />
-      </Flexbox>
-    </Dropdown>
-  );
-});
-
-export default ModelList;

package/src/app/settings/llm/LLM/getModelList.ts

@@ -1,9 +0,0 @@
-import { fetchModelList } from '@/services/modelList';
-import { useGlobalStore } from '@/store/global';
-
-export const getModelList = async (brand = 'openAI') => {
-  const setSettings = useGlobalStore.getState().setSettings;
-  const models = await fetchModelList();
-
-  setSettings({ languageModel: { [brand]: { models } } });
-};

package/src/app/settings/llm/index.tsx

@@ -1,36 +0,0 @@
-'use client';
-
-import Link from 'next/link';
-import { memo } from 'react';
-import { Trans, useTranslation } from 'react-i18next';
-
-import Footer from '@/app/settings/features/Footer';
-import PageTitle from '@/components/PageTitle';
-import { useSwitchSideBarOnInit } from '@/store/global/hooks/useSwitchSettingsOnInit';
-import { SettingsTabs } from '@/store/global/initialState';
-
-import LLM from './LLM';
-
-export default memo(() => {
-  useSwitchSideBarOnInit(SettingsTabs.LLM);
-  const { t } = useTranslation('setting');
-  return (
-    <>
-      <PageTitle title={t('tab.llm')} />
-      <LLM />
-      <Footer>
-        <Trans i18nKey="llm.waitingForMore" ns={'setting'}>
-          更多模型正在
-          <Link
-            aria-label={'todo'}
-            href="https://github.com/lobehub/lobe-chat/issues/151"
-            target="_blank"
-          >
-            计划接入
-          </Link>
-          中 ，敬请期待 ✨
-        </Trans>
-      </Footer>
-    </>
-  );
-});

package/src/const/llm.ts

@@ -1,32 +0,0 @@
-import { LanguageModel } from '@/types/llm';
-
-/**
- * A white list of language models that are allowed to display and be used in the app.
- */
-export const LanguageModelWhiteList = [
-  // OpenAI
-  'gpt-3.5-turbo',
-  'gpt-3.5-turbo-16k',
-  'gpt-4',
-  'gpt-4-32k',
-];
-
-export const DEFAULT_OPENAI_MODEL_LIST: string[] = Object.values(LanguageModel);
-
-// vision model white list, these models will change the content from string to array
-// refs: https://github.com/lobehub/lobe-chat/issues/790
-export const isVisionModel = (model?: string) => !!model && model.includes('vision');
-
-// refs: https://github.com/lobehub/lobe-chat/issues/837
-export const GPT4_VISION_MODEL_DEFAULT_MAX_TOKENS = 2048;
-
-// refs to: https://platform.openai.com/docs/models/gpt-4-and-gpt-4-turbo
-export const ModelTokens: Record<LanguageModel, number> = {
-  [LanguageModel.GPT3_5]: 4096,
-  [LanguageModel.GPT3_5_1106]: 16_385,
-  [LanguageModel.GPT3_5_16K]: 16_385,
-  [LanguageModel.GPT4]: 8196,
-  [LanguageModel.GPT4_PREVIEW]: 128_000,
-  [LanguageModel.GPT4_VISION_PREVIEW]: 128_000,
-  [LanguageModel.GPT4_32K]: 32_768,
-};