@lobehub/chat
Version:
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.
674 lines (615 loc) • 21.1 kB
text/typescript
import { describe, expect, it } from 'vitest';
import { LOBE_DEFAULT_MODEL_LIST } from '@/config/aiModels';
import { openaiChatModels } from '@/config/aiModels/openai';
import { AiFullModelCard } from '@/types/aiModel';
import { parseModelString, transformToAiChatModelList } 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();
});
it('empty string model', () => {
const result = parseModelString('gpt-4-1106-preview=gpt-4-turbo,, ,\n ，+claude-2');
expect(result).toMatchSnapshot();
});
describe('extension capabilities', () => {
it('with token', () => {
const result = parseModelString('chatglm-6b=ChatGLM 6B<4096>');
expect(result.add[0]).toEqual({
displayName: 'ChatGLM 6B',
id: 'chatglm-6b',
contextWindowTokens: 4096,
abilities: {},
type: 'chat',
});
});
it('token and function calling', () => {
const result = parseModelString('spark-v3.5=讯飞星火 v3.5<8192:fc>');
expect(result.add[0]).toEqual({
displayName: '讯飞星火 v3.5',
abilities: {
functionCall: true,
},
id: 'spark-v3.5',
contextWindowTokens: 8192,
type: 'chat',
});
});
it('token and reasoning', () => {
const result = parseModelString('deepseek-r1=Deepseek R1<65536:reasoning>');
expect(result.add[0]).toEqual({
displayName: 'Deepseek R1',
abilities: {
reasoning: true,
},
id: 'deepseek-r1',
contextWindowTokens: 65_536,
type: 'chat',
});
});
it('token and search', () => {
const result = parseModelString('qwen-max-latest=Qwen Max<32768:search>');
expect(result.add[0]).toEqual({
displayName: 'Qwen Max',
abilities: {
search: true,
},
id: 'qwen-max-latest',
contextWindowTokens: 32_768,
type: 'chat',
});
});
it('token and image output', () => {
const result = parseModelString(
'gemini-2.0-flash-exp-image-generation=Gemini 2.0 Flash (Image Generation) Experimental<32768:imageOutput>',
);
expect(result.add[0]).toEqual({
displayName: 'Gemini 2.0 Flash (Image Generation) Experimental',
abilities: {
imageOutput: true,
},
id: 'gemini-2.0-flash-exp-image-generation',
contextWindowTokens: 32_768,
type: 'chat',
});
});
it('multi models', () => {
const result = parseModelString(
'gemini-1.5-flash-latest=Gemini 1.5 Flash<16000:vision>,gpt-4-all=ChatGPT Plus<128000:fc:vision:file>',
);
expect(result.add).toEqual([
{
displayName: 'Gemini 1.5 Flash',
abilities: {
vision: true,
},
id: 'gemini-1.5-flash-latest',
contextWindowTokens: 16000,
type: 'chat',
},
{
displayName: 'ChatGPT Plus',
abilities: {
vision: true,
functionCall: true,
files: true,
},
type: 'chat',
id: 'gpt-4-all',
contextWindowTokens: 128000,
},
]);
});
it('should have file with builtin models like gpt-4-0125-preview', () => {
const result = parseModelString(
'-all,+gpt-4-0125-preview=ChatGPT-4<128000:fc:file>,+gpt-4-turbo-2024-04-09=ChatGPT-4 Vision<128000:fc:vision:file>',
);
expect(result.add).toEqual([
{
displayName: 'ChatGPT-4',
abilities: {
functionCall: true,
files: true,
},
type: 'chat',
id: 'gpt-4-0125-preview',
contextWindowTokens: 128000,
},
{
displayName: 'ChatGPT-4 Vision',
abilities: {
functionCall: true,
files: true,
vision: true,
},
type: 'chat',
id: 'gpt-4-turbo-2024-04-09',
contextWindowTokens: 128000,
},
]);
});
it('should handle empty extension capability value', () => {
const result = parseModelString('model1<1024:>');
expect(result.add[0]).toEqual({
abilities: {},
type: 'chat',
id: 'model1',
contextWindowTokens: 1024,
});
});
it('should handle empty extension capability name', () => {
const result = parseModelString('model1<1024::file>');
expect(result.add[0]).toEqual({
id: 'model1',
contextWindowTokens: 1024,
abilities: {
files: true,
},
type: 'chat',
});
});
it('should handle duplicate extension capabilities', () => {
const result = parseModelString('model1<1024:vision:vision>');
expect(result.add[0]).toEqual({
id: 'model1',
contextWindowTokens: 1024,
abilities: {
vision: true,
},
type: 'chat',
});
});
it('should handle case-sensitive extension capability names', () => {
const result = parseModelString('model1<1024:VISION:FC:file>');
expect(result.add[0]).toEqual({
id: 'model1',
contextWindowTokens: 1024,
abilities: {
files: true,
},
type: 'chat',
});
});
it('should handle case-sensitive extension capability values', () => {
const result = parseModelString('model1<1024:vision:Fc:File>');
expect(result.add[0]).toEqual({
id: 'model1',
contextWindowTokens: 1024,
abilities: {
vision: true,
},
type: 'chat',
});
});
it('should handle empty angle brackets', () => {
const result = parseModelString('model1<>');
expect(result.add[0]).toEqual({ id: 'model1', abilities: {}, type: 'chat' });
});
it('should handle not close angle brackets', () => {
const result = parseModelString('model1<,model2');
expect(result.add).toEqual([
{ id: 'model1', abilities: {}, type: 'chat' },
{ id: 'model2', abilities: {}, type: 'chat' },
]);
});
it('should handle multi close angle brackets', () => {
const result = parseModelString('model1<>>,model2');
expect(result.add).toEqual([
{ id: 'model1', abilities: {}, type: 'chat' },
{ id: 'model2', abilities: {}, type: 'chat' },
]);
});
it('should handle only colon inside angle brackets', () => {
const result = parseModelString('model1<:>');
expect(result.add[0]).toEqual({ id: 'model1', abilities: {}, type: 'chat' });
});
it('should handle only non-digit characters inside angle brackets', () => {
const result = parseModelString('model1<abc>');
expect(result.add[0]).toEqual({ id: 'model1', abilities: {}, type: 'chat' });
});
it('should handle non-digit characters followed by digits inside angle brackets', () => {
const result = parseModelString('model1<abc123>');
expect(result.add[0]).toEqual({ id: 'model1', abilities: {}, type: 'chat' });
});
it('should handle digits followed by non-colon characters inside angle brackets', () => {
const result = parseModelString('model1<1024abc>');
expect(result.add[0]).toEqual({
id: 'model1',
contextWindowTokens: 1024,
abilities: {},
type: 'chat',
});
});
it('should handle digits followed by multiple colons inside angle brackets', () => {
const result = parseModelString('model1<1024::>');
expect(result.add[0]).toEqual({
id: 'model1',
contextWindowTokens: 1024,
abilities: {},
type: 'chat',
});
});
it('should handle digits followed by a colon and non-letter characters inside angle brackets', () => {
const result = parseModelString('model1<1024:123>');
expect(result.add[0]).toEqual({
id: 'model1',
contextWindowTokens: 1024,
abilities: {},
type: 'chat',
});
});
it('should handle digits followed by a colon and spaces inside angle brackets', () => {
const result = parseModelString('model1<1024: vision>');
expect(result.add[0]).toEqual({
id: 'model1',
contextWindowTokens: 1024,
abilities: {},
type: 'chat',
});
});
it('should handle digits followed by multiple colons and spaces inside angle brackets', () => {
const result = parseModelString('model1<1024: : vision>');
expect(result.add[0]).toEqual({
id: 'model1',
contextWindowTokens: 1024,
abilities: {},
type: 'chat',
});
});
});
describe('deployment name', () => {
it('should have no deployment name', () => {
const result = parseModelString('model1=Model 1', true);
expect(result.add[0]).toEqual({
id: 'model1',
displayName: 'Model 1',
abilities: {},
type: 'chat',
});
});
it('should have diff deployment name as id', () => {
const result = parseModelString('gpt-35-turbo->my-deploy=GPT 3.5 Turbo', true);
expect(result.add[0]).toEqual({
id: 'gpt-35-turbo',
displayName: 'GPT 3.5 Turbo',
abilities: {},
type: 'chat',
config: {
deploymentName: 'my-deploy',
},
});
});
it('should handle with multi deployName', () => {
const result = parseModelString(
'gpt-4o->id1=GPT-4o,gpt-4o-mini->id2=gpt-4o-mini,o1-mini->id3=O1 mini',
true,
);
expect(result.add).toEqual([
{
abilities: {},
displayName: 'GPT-4o',
id: 'gpt-4o',
type: 'chat',
config: { deploymentName: 'id1' },
},
{
abilities: {},
displayName: 'gpt-4o-mini',
id: 'gpt-4o-mini',
type: 'chat',
config: { deploymentName: 'id2' },
},
{
abilities: {},
displayName: 'O1 mini',
id: 'o1-mini',
type: 'chat',
config: { deploymentName: 'id3' },
},
]);
});
});
});
describe('transformToChatModelCards', () => {
const defaultChatModels: AiFullModelCard[] = [
{ id: 'model1', displayName: 'Model 1', enabled: true, type: 'chat' },
{ id: 'model2', displayName: 'Model 2', enabled: false, type: 'chat' },
];
it('should return undefined when modelString is empty', () => {
const result = transformToAiChatModelList({
modelString: '',
defaultChatModels,
providerId: 'openai',
});
expect(result).toBeUndefined();
});
it('should remove all models when removeAll is true', () => {
const result = transformToAiChatModelList({
modelString: '-all',
defaultChatModels,
providerId: 'openai',
});
expect(result).toEqual([]);
});
it('should remove specified models', () => {
const result = transformToAiChatModelList({
modelString: '-model1',
defaultChatModels,
providerId: 'openai',
});
expect(result).toEqual([
{ id: 'model2', displayName: 'Model 2', enabled: false, type: 'chat' },
]);
});
it('should add a new known model', () => {
const knownModel = LOBE_DEFAULT_MODEL_LIST.find((m) => m.providerId === 'ai21')!;
const result = transformToAiChatModelList({
modelString: `${knownModel.id}`,
defaultChatModels,
providerId: 'ai21',
});
expect(result).toContainEqual({
...knownModel,
displayName: knownModel.displayName || knownModel.id,
enabled: true,
});
});
it('should update an existing known model', () => {
const knownModel = LOBE_DEFAULT_MODEL_LIST.find((m) => m.providerId === 'openai')!;
const result = transformToAiChatModelList({
modelString: `+${knownModel.id}=Updated Model`,
defaultChatModels: [knownModel],
providerId: 'openai',
});
expect(result).toContainEqual({
...knownModel,
displayName: 'Updated Model',
enabled: true,
});
});
it('should add a new custom model', () => {
const result = transformToAiChatModelList({
modelString: '+custom_model=Custom Model',
defaultChatModels,
providerId: 'openai',
});
expect(result).toContainEqual({
id: 'custom_model',
displayName: 'Custom Model',
enabled: true,
abilities: {},
type: 'chat',
});
});
it('should have file with builtin models like gpt-4-0125-preview', () => {
const result = transformToAiChatModelList({
modelString:
'-all,+gpt-4-0125-preview=ChatGPT-4<128000:fc:file>,+gpt-4-turbo-2024-04-09=ChatGPT-4 Vision<128000:fc:vision:file>',
defaultChatModels: openaiChatModels,
providerId: 'openai',
});
expect(result).toMatchSnapshot();
});
it('should use default deploymentName from known model when not specified in string (VolcEngine case)', () => {
const knownModel = LOBE_DEFAULT_MODEL_LIST.find(
(m) => m.id === 'deepseek-r1' && m.providerId === 'volcengine',
);
const defaultChatModels: AiFullModelCard[] = [];
const result = transformToAiChatModelList({
modelString: '+deepseek-r1',
defaultChatModels,
providerId: 'volcengine',
withDeploymentName: true,
});
expect(result).toContainEqual({
...knownModel,
enabled: true,
});
});
it('should use deploymentName from modelString when specified (VolcEngine case)', () => {
const defaultChatModels: AiFullModelCard[] = [];
const knownModel = LOBE_DEFAULT_MODEL_LIST.find(
(m) => m.id === 'deepseek-r1' && m.providerId === 'volcengine',
);
const result = transformToAiChatModelList({
modelString: `+deepseek-r1->my-custom-deploy`,
defaultChatModels,
providerId: 'volcengine',
withDeploymentName: true,
});
expect(result).toContainEqual({
...knownModel,
enabled: true,
config: { deploymentName: 'my-custom-deploy' },
});
});
it('should set both id and deploymentName to the full string when no -> is used and withDeploymentName is true', () => {
const defaultChatModels: AiFullModelCard[] = [];
const result = transformToAiChatModelList({
modelString: `+my_model`,
defaultChatModels,
providerId: 'volcengine',
withDeploymentName: true,
});
expect(result).toContainEqual({
id: `my_model`,
displayName: `my_model`,
type: 'chat',
abilities: {},
enabled: true,
config: {
deploymentName: `my_model`,
},
});
});
it('should handle azure real case', () => {
const defaultChatModels = [
{
abilities: { functionCall: true, reasoning: true },
config: { deploymentName: 'o3-mini' },
contextWindowTokens: 200000,
description:
'o3-mini 是我们最新的小型推理模型，在与 o1-mini 相同的成本和延迟目标下提供高智能。',
displayName: 'OpenAI o3-mini',
id: 'o3-mini',
maxOutput: 100000,
pricing: { input: 1.1, output: 4.4 },
releasedAt: '2025-01-31',
type: 'chat',
},
{
abilities: { reasoning: true },
config: { deploymentName: 'o1-mini' },
contextWindowTokens: 128000,
description:
'o1-mini是一款针对编程、数学和科学应用场景而设计的快速、经济高效的推理模型。该模型具有128K上下文和2023年10月的知识截止日期。',
displayName: 'OpenAI o1-mini',
enabled: true,
id: 'o1-mini',
maxOutput: 65536,
pricing: { input: 1.1, output: 4.4 },
releasedAt: '2024-09-12',
type: 'chat',
},
{
abilities: { reasoning: true },
config: { deploymentName: 'o1' },
contextWindowTokens: 200000,
description:
'o1是OpenAI新的推理模型，支持图文输入并输出文本，适用于需要广泛通用知识的复杂任务。该模型具有200K上下文和2023年10月的知识截止日期。',
displayName: 'OpenAI o1',
enabled: true,
id: 'o1',
maxOutput: 100000,
pricing: { input: 15, output: 60 },
releasedAt: '2024-12-17',
type: 'chat',
},
{
abilities: { reasoning: true },
config: { deploymentName: 'o1-preview' },
contextWindowTokens: 128000,
description:
'o1是OpenAI新的推理模型，适用于需要广泛通用知识的复杂任务。该模型具有128K上下文和2023年10月的知识截止日期。',
displayName: 'OpenAI o1-preview',
id: 'o1-preview',
maxOutput: 32768,
pricing: { input: 15, output: 60 },
releasedAt: '2024-09-12',
type: 'chat',
},
{
abilities: { functionCall: true, vision: true },
config: { deploymentName: 'gpt-4o' },
contextWindowTokens: 128000,
description:
'ChatGPT-4o 是一款动态模型，实时更新以保持当前最新版本。它结合了强大的语言理解与生成能力，适合于大规模应用场景，包括客户服务、教育和技术支持。',
displayName: 'GPT-4o',
enabled: true,
id: 'gpt-4o',
pricing: { input: 2.5, output: 10 },
releasedAt: '2024-05-13',
type: 'chat',
},
{
abilities: { functionCall: true, vision: true },
config: { deploymentName: 'gpt-4-turbo' },
contextWindowTokens: 128000,
description: 'GPT 4 Turbo，多模态模型，提供杰出的语言理解和生成能力，同时支持图像输入。',
displayName: 'GPT 4 Turbo',
id: 'gpt-4',
maxOutput: 4096,
type: 'chat',
},
{
abilities: { functionCall: true, vision: true },
config: { deploymentName: 'gpt-4o-mini' },
contextWindowTokens: 128000,
description: 'GPT-4o Mini，小型高效模型，具备与GPT-4o相似的卓越性能。',
displayName: 'GPT 4o Mini',
enabled: true,
id: 'gpt-4o-mini',
maxOutput: 4096,
type: 'chat',
},
] as AiFullModelCard[];
const modelString =
'-all,gpt-4o->id1=GPT-4o,gpt-4o-mini->id2=GPT 4o Mini,o1-mini->id3=OpenAI o1-mini';
const data = transformToAiChatModelList({
modelString,
defaultChatModels,
providerId: 'azure',
withDeploymentName: true,
});
expect(data).toEqual([
{
abilities: { functionCall: true, vision: true },
config: { deploymentName: 'id1' },
contextWindowTokens: 128000,
description:
'ChatGPT-4o 是一款动态模型，实时更新以保持当前最新版本。它结合了强大的语言理解与生成能力，适合于大规模应用场景，包括客户服务、教育和技术支持。',
displayName: 'GPT-4o',
enabled: true,
id: 'gpt-4o',
maxOutput: 4096,
pricing: {
cachedInput: 1.25,
input: 2.5,
output: 10,
},
providerId: 'azure',
releasedAt: '2024-05-13',
source: 'builtin',
type: 'chat',
},
{
abilities: { functionCall: true, vision: true },
config: { deploymentName: 'id2' },
contextWindowTokens: 128000,
description: 'GPT-4o Mini，小型高效模型，具备与GPT-4o相似的卓越性能。',
displayName: 'GPT 4o Mini',
providerId: 'azure',
source: 'builtin',
enabled: true,
id: 'gpt-4o-mini',
maxOutput: 4096,
pricing: {
cachedInput: 0.075,
input: 0.15,
output: 0.6,
},
type: 'chat',
},
{
abilities: { reasoning: true },
config: { deploymentName: 'id3' },
contextWindowTokens: 128000,
description:
'o1-mini是一款针对编程、数学和科学应用场景而设计的快速、经济高效的推理模型。该模型具有128K上下文和2023年10月的知识截止日期。',
displayName: 'OpenAI o1-mini',
enabled: true,
providerId: 'azure',
source: 'builtin',
id: 'o1-mini',
maxOutput: 65536,
pricing: {
cachedInput: 0.55,
input: 1.1,
output: 4.4,
},
releasedAt: '2024-09-12',
type: 'chat',
},
]);
});
});