@lobehub/chat 0.147.7 → 0.147.9

package/CHANGELOG.md

@@ -2,6 +2,56 @@
 
 # Changelog
 
+### [Version 0.147.9](https://github.com/lobehub/lobe-chat/compare/v0.147.8...v0.147.9)
+
+<sup>Released on **2024-04-12**</sup>
+
+#### 🐛 Bug Fixes
+
+- **misc**: Fix custom model list not display correctly.
+
+<br/>
+
+<details>
+<summary><kbd>Improvements and Fixes</kbd></summary>
+
+#### What's fixed
+
+- **misc**: Fix custom model list not display correctly, closes [#2009](https://github.com/lobehub/lobe-chat/issues/2009) ([7d0e220](https://github.com/lobehub/lobe-chat/commit/7d0e220))
+
+</details>
+
+<div align="right">
+
+[![](https://img.shields.io/badge/-BACK_TO_TOP-151515?style=flat-square)](#readme-top)
+
+</div>
+
+### [Version 0.147.8](https://github.com/lobehub/lobe-chat/compare/v0.147.7...v0.147.8)
+
+<sup>Released on **2024-04-12**</sup>
+
+#### ♻ Code Refactoring
+
+- **misc**: Update README.md.
+
+<br/>
+
+<details>
+<summary><kbd>Improvements and Fixes</kbd></summary>
+
+#### Code refactoring
+
+- **misc**: Update README.md ([44b5a23](https://github.com/lobehub/lobe-chat/commit/44b5a23))
+
+</details>
+
+<div align="right">
+
+[![](https://img.shields.io/badge/-BACK_TO_TOP-151515?style=flat-square)](#readme-top)
+
+</div>
+
 ### [Version 0.147.7](https://github.com/lobehub/lobe-chat/compare/v0.147.6...v0.147.7)
 
 <sup>Released on **2024-04-12**</sup>

package/README.md

@@ -123,12 +123,12 @@ We have implemented support for the following model service providers:
 - **AWS Bedrock**: Integrated with AWS Bedrock service, supporting models such as **Claude / LLama2**, providing powerful natural language processing capabilities. [Learn more](https://aws.amazon.com/cn/bedrock)
 - **Anthropic (Claude)**: Accessed Anthropic's **Claude** series models, including Claude 3 and Claude 2, with breakthroughs in multi-modal capabilities and extended context, setting a new industry benchmark. [Learn more](https://www.anthropic.com/claude)
 - **Google AI (Gemini Pro, Gemini Vision)**: Access to Google's **Gemini** series models, including Gemini and Gemini Pro, to support advanced language understanding and generation. [Learn more](https://deepmind.google/technologies/gemini/)
-- **ChatGLM**: Added the **ChatGLM** series models from Zhipuai (GLM-4/GLM-4-vision/GLM-3-turbo), providing users with another efficient conversation model choice. [Learn more](https://www.zhipuai.cn/)
-- **Moonshot AI (Dark Side of the Moon)**: Integrated with the Moonshot series models, an innovative AI startup from China, aiming to provide deeper conversation understanding. [Learn more](https://www.moonshot.cn/)
 - **Groq**: Accessed Groq's AI models, efficiently processing message sequences and generating responses, capable of multi-turn dialogues and single-interaction tasks. [Learn more](https://groq.com/)
 - **OpenRouter**: Supports routing of models including **Claude 3**, **Gemma**, **Mistral**, **Llama2** and **Cohere**, with intelligent routing optimization to improve usage efficiency, open and flexible. [Learn more](https://openrouter.ai/)
 - **01.AI (Yi Model)**: Integrated the 01.AI models, with series of APIs featuring fast inference speed, which not only shortened the processing time, but also maintained excellent model performance. [Learn more](https://01.ai/)
 - **Together.ai**: Over 100 leading open-source Chat, Language, Image, Code, and Embedding models are available through the Together Inference API. For these models you pay just for what you use. [Learn more](https://www.together.ai/)
+- **ChatGLM**: Added the **ChatGLM** series models from Zhipuai (GLM-4/GLM-4-vision/GLM-3-turbo), providing users with another efficient conversation model choice. [Learn more](https://www.zhipuai.cn/)
+- **Moonshot AI (Dark Side of the Moon)**: Integrated with the Moonshot series models, an innovative AI startup from China, aiming to provide deeper conversation understanding. [Learn more](https://www.moonshot.cn/)
 
 At the same time, we are also planning to support more model service providers, such as Replicate and Perplexity, to further enrich our service provider library. If you would like LobeChat to support your favorite service provider, feel free to join our [community discussion](https://github.com/lobehub/lobe-chat/discussions/1284).
 

package/docs/self-hosting/advanced/model-list.mdx

@@ -0,0 +1,48 @@
+---
+title: Customizing Provider Model List in LobeChat for Deployment
+description: >-
+  Learn how to customize the model list in LobeChat for deployment with the
+  syntax and extension capabilities
+tags:
+  - LobeChat
+  - model customization
+  - deployment
+  - extension capabilities
+---
+
+# Model List
+
+LobeChat supports customizing the model list during deployment. You can use `+` to add a model, `-` to hide a model, and use `model name=display name<extension configuration>` to customize the display name of a model, separated by English commas. The basic syntax is as follows:
+
+```shell
+id=displayName < maxToken:vision:fc:file > ,model2,model3
+```
+
+For example: `+qwen-7b-chat,+glm-6b,-gpt-3.5-turbo,gpt-4-0125-preview=gpt-4-turbo`
+
+In the above example, it adds `qwen-7b-chat` and `glm-6b` to the model list, removes `gpt-3.5-turbo` from the list, and displays the model name of `gpt-4-0125-preview` as `gpt-4-turbo`. If you want to disable all models first and then enable specific models, you can use `-all,+gpt-3.5-turbo`, which means only enabling `gpt-3.5-turbo`.
+
+## Extension Capabilities
+
+Considering the diversity of model capabilities, we started to add extension configuration in version `0.147.8`, with the following rules:
+
+```shell
+id=displayName<maxToken:vision:fc:file>
+```
+
+The first value in angle brackets is designated as the `maxToken` for this model. The second value and beyond are the model's extension capabilities, separated by colons `:`, and the order is not important.
+
+Examples are as follows:
+
+- `chatglm-6b=ChatGLM 6B<4096>`: ChatGLM 6B, maximum context of 4k, no advanced capabilities;
+- `spark-v3.5=讯飞星火 v3.5<8192:fc>`: Xunfei Spark 3.5 model, maximum context of 8k, supports Function Call;
+- `gemini-pro-vision=Gemini Pro Vision<16000:vision>`: Google Vision model, maximum context of 16k, supports image recognition;
+- `gpt-4-all=ChatGPT Plus<128000:fc:vision:file>`, hacked version of ChatGPT Plus web, context of 128k, supports image recognition, Function Call, file upload.
+
+Currently supported extension capabilities are:
+
+| ---      | Description                                              |
+| -------- | -------------------------------------------------------- |
+| `fc`     | Function Calling                                         |
+| `vision` | Image Recognition                                        |
+| `file`   | File Upload (a bit hacky, not recommended for daily use) |

package/docs/self-hosting/advanced/model-list.zh-CN.mdx

@@ -0,0 +1,46 @@
+---
+title: LobeChat 自定义模型服务商模型列表及扩展能力配置
+description: 了解如何在 LobeChat 中自定义模型列表以及扩展能力配置的基本语法和规则。
+tags:
+  - LobeChat
+  - 自定义模型列表
+  - 扩展能力配置
+  - 模型展示名
+  - 模型能力
+---
+# Model List
+
+LobeChat 支持在部署时自定义模型列表，可以使用 `+` 增加一个模型，使用 `-` 来隐藏一个模型，使用 `模型名=展示名<扩展配置>` 来自定义模型的展示名，用英文逗号隔开。通过 `<>` 来添加扩展配置。基本语法如下：
+
+```shell
+id=displayName < maxToken:vision:fc:file > ,model2,model3
+```
+
+例如： `+qwen-7b-chat,+glm-6b,-gpt-3.5-turbo,gpt-4-0125-preview=gpt-4-turbo`
+
+上面示例表示增加 `qwen-7b-chat` 和 `glm-6b` 到模型列表，而从列表中删除 `gpt-3.5-turbo`，并将 `gpt-4-0125-preview` 模型名字展示为 `gpt-4-turbo`。如果你想先禁用所有模型，再启用指定模型，可以使用 `-all,+gpt-3.5-turbo`，则表示仅启用 `gpt-3.5-turbo`。
+
+## 扩展能力
+
+考虑到模型的能力多样性，我们在 `0.147.8` 版本开始增加扩展性配置，它的规则如下：
+
+```shell
+id=displayName<maxToken:vision:fc:file>
+```
+
+尖括号第一个值约定为这个模型的 `maxToken` 。第二个及以后作为模型的扩展能力，能力与能力之间用冒号 `:` 作为分隔符，顺序不重要。
+
+举例如下：
+
+- `chatglm-6b=ChatGLM 6B<4096>`：ChatGLM 6B，最大上下文 4k，没有高阶能力；
+- `spark-v3.5=讯飞星火 v3.5<8192:fc>`：讯飞星火 3.5 模型，最大上下文 8k，支持 Function Call；
+- `gemini-pro-vision=Gemini Pro Vision<16000:vision>`：Google 视觉模型，最大上下文 16k，支持图像识别；
+- `gpt-4-all=ChatGPT Plus<128000:fc:vision:file>`，hack 的 ChatGPT Plus 网页版，上下 128k ，支持图像识别、Function Call、文件上传
+
+目前支持的扩展能力有：
+
+| ---      | 描述                                 |
+| -------- | ------------------------------------ |
+| `fc`     | 函数调用（function calling）         |
+| `vision` | 视觉识别                             |
+| `file`   | 文件上传（比较hack，不建议日常使用） |

package/docs/self-hosting/environment-variables/basic.mdx

@@ -27,6 +27,17 @@ LobeChat provides some additional configuration options during deployment, which
 - Default: -
 - Example: `awCTe)re_r74` or `rtrt_ewee3@09!`
 
+### `API_KEY_SELECT_MODE`
+
+- Type：Optional
+- Description：Controls the mode for selecting the API Key when multiple API Keys are available. Currently supports `random` and `turn`.
+- Default：`random`
+- Example：`random` or `turn`
+
+When using the `random` mode, a random API Key will be selected from the available multiple API Keys.
+
+When using the `turn` mode, the API Keys will be retrieved in a round-robin manner according to the specified order.
+
 ### `ENABLE_OAUTH_SSO`
 
 - Type: Optional

package/docs/self-hosting/environment-variables/basic.zh-CN.mdx

@@ -23,6 +23,17 @@ LobeChat 在部署时提供了一些额外的配置项，你可以使用环境
 - 默认值：-
 - 示例：`awCTe)re_r74` or `rtrt_ewee3@09!`
 
+### `API_KEY_SELECT_MODE`
+
+- 类型：可选
+- 描述：用于控制多个 API Keys 时，选择 Key 的模式，当前支持 `random` 和 `turn`
+- 默认值：`random`
+- 示例：`random` 或 `turn`
+
+使用 `random` 模式下，将在多个 API Keys 中随机获取一个 API Key。
+
+使用 `turn` 模式下，将按照填写的顺序，轮训获取得到 API Key。
+
 ### `ENABLE_OAUTH_SSO`
 
 - 类型：可选

package/docs/self-hosting/environment-variables/model-provider.mdx

@@ -18,7 +18,7 @@ When deploying LobeChat, a rich set of environment variables related to model se
 ### `OPENAI_API_KEY`
 
 - Type: Required
-- Description: This is the API key you applied for on the OpenAI account page, you can check it out [here](openai-api-page)
+- Description: This is the API key you applied for on the OpenAI account page, you can check it out [here](https://platform.openai.com/api-keys)
 - Default: -
 - Example: `sk-xxxxxx...xxxxxx`
 
@@ -51,7 +51,7 @@ Related discussions:
 ### `OPENAI_MODEL_LIST`
 
 - Type: Optional
-- Description: Used to control the model list, use `+` to add a model, use `-` to hide a model, use `model_name=display_name` to customize the display name of a model, separated by commas.
+- Description: Used to control the model list, use `+` to add a model, use `-` to hide a model, use `model_name=display_name` to customize the display name of a model, separated by commas. Definition syntax rules see [model-list][model-list]
 - Default: `-`
 - Example: `+qwen-7b-chat,+glm-6b,-gpt-3.5-turbo,gpt-4-0125-preview=gpt-4-turbo`
 
@@ -61,57 +61,35 @@ You can find all current model names in [modelProviders](https://github.com/lobe
 
 ## Azure OpenAI
 
-If you need to use Azure OpenAI to provide model services, you can refer to the [Deploying with Azure OpenAI](../Deployment/Deploy-with-Azure-OpenAI.en-US.md) section for detailed steps. Here, we will list the environment variables related to Azure OpenAI.
-
-### `API_KEY_SELECT_MODE`
-
-- Type：Optional
-- Description：Controls the mode for selecting the API Key when multiple API Keys are available. Currently supports `random` and `turn`.
-- Default：`random`
-- Example：`random` or `turn`
-
-When using the `random` mode, a random API Key will be selected from the available multiple API Keys.
-
-When using the `turn` mode, the API Keys will be retrieved in a round-robin manner according to the specified order.
-
-### `USE_AZURE_OPENAI`
-
-- Type: Optional
-- Description: Set this value to `1` to enable Azure OpenAI configuration
-- Default: -
-- Example: `1`
+If you need to use Azure OpenAI to provide model services, you can refer to the [Deploying with Azure OpenAI](/docs/self-hosting/examples/azure-openai) section for detailed steps. Here, we will list the environment variables related to Azure OpenAI.
 
 ### `AZURE_API_KEY`
 
-- Type: Optional
+- Type: Required
 - Description: This is the API key you applied for on the Azure OpenAI account page
 - Default: -
 - Example: `c55168be3874490ef0565d9779ecd5a6`
 
-### `AZURE_API_VERSION`
+### `AZURE_ENDPOINT`
 
-- Type: Optional
-- Description: The API version of Azure, following the format YYYY-MM-DD
-- Default: `2023-08-01-preview`
-- Example: `2023-05-15`, refer to [latest version](https://docs.microsoft.com/zh-cn/azure/developer/javascript/api-reference/es-modules/azure-sdk/ai-translation/translationconfiguration?view=azure-node-latest#api-version)
-
-## ZHIPU AI
+- Type: Required
+- Description: The endpoint of Azure OpenAI, you can find it in the Azure OpenAI account page
+- Default: `-`
+- Example: `https://docs-test-001.openai.azure.com`
 
-### `ZHIPU_API_KEY`
+### `AZURE_API_VERSION`
 
 - Type: Required
-- Description: This is the API key you applied for in the ZHIPU AI service
-- Default: -
-- Example: `4582d332441a313f5c2ed9824d1798ca.rC8EcTAhgbOuAuVT`
+- Description: The API version of Azure, following the format YYYY-MM-DD
+- Default: `-`
+- Example: `2023-02-01`, refer to [latest version](https://docs.microsoft.com/zh-cn/azure/developer/javascript/api-reference/es-modules/azure-sdk/ai-translation/translationconfiguration?view=azure-node-latest#api-version)
 
-## Moonshot AI
+### `AZURE_MODEL_LIST`
 
-### `MOONSHOT_API_KEY`
-
-- Type: Required
-- Description: This is the API key you applied for in the Moonshot AI service
-- Default: -
-- Example: `Y2xpdGhpMzNhZXNoYjVtdnZjMWc6bXNrLWIxQlk3aDNPaXpBWnc0V1RaMDhSRmRFVlpZUWY=`
+- Type: Optional
+- Description: Used to control the model list, use `+` to add a model, use `-` to hide a model, use `id->deplymentName=displayName` to customize the display name of a model, separated by commas. Definition syntax rules see [model-list][model-list]
+- Default: `-`
+- Example: `gpt-35-turbo->my-deploy=GPT 3.5 Turbo` 或 `gpt-4-turbo->my-gpt4=GPT 4 Turbo<128000:vision:fc>`
 
 ## Google AI
 
@@ -125,10 +103,26 @@ When using the `turn` mode, the API Keys will be retrieved in a round-robin mann
 ### `GOOGLE_PROXY_URL`
 
 - Type: Optional
-- Description: If you manually configure the Google interface proxy, you can use this configuration item to override the default Google API request base URL
+- Description: If you manually configure the Google API proxy, you can use this configuration item to override the default Google API request base URL
 - Default: `https://generativelanguage.googleapis.com`
 - Example: `https://api.genai.gd.edu.kg/google`
 
+## Anthropic AI
+
+### `ANTHROPIC_API_KEY`
+
+- Type: Required
+- Description: This is the API key you applied from Anthropic AI
+- Default: -
+- Example: `sk-ant-apixx-xxxxxxxxx-xxxxxxxxxxxxxxxxx-xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx-xxxxxxxx`
+
+### `ANTHROPIC_PROXY_URL`
+
+- Type: Optional
+- Description: If you manually configure the Anthropic API proxy, you can use this configuration item to override the default Anthropic API request base URL
+- Default: `https://api.anthropic.com`
+- Example: `https://my-anthropic-proxy.com`
+
 ## AWS Bedrock
 
 ### `AWS_ACCESS_KEY_ID`
@@ -152,11 +146,43 @@ When using the `turn` mode, the API Keys will be retrieved in a round-robin mann
 - Default: `us-east-1`
 - Example: `us-east-1`
 
+## OpenRouter AI
+
+### `OPENROUTER_API_KEY`
+
+- Type: Required
+- Description: This is the API key you applied for in the OpenRouter AI service
+- Default: -
+- Example: `sk-or-v1-xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx=`
+
+### `OPENROUTER_MODEL_LIST`
+
+- Type: Optional
+- Description: Used to specify a custom OpenRouter model list. Model definition syntax rules see [model-list][model-list]
+- Default: `-`
+- Example: `-all,+01-ai/yi-34b-chat,+huggingfaceh4/zephyr-7b-beta`
+
+## TogetherAI
+
+### `TOGETHERAI_API_KEY`
+
+- Type: Required
+- Description: This is the API key you applied for in the TogetherAI service
+- Default: -
+- Example: `xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx`
+
+### `TOGETHERAI_MODEL_LIST`
+
+- Type: Optional
+- Description: Used to specify a custom TogetherAI model list. Model definition syntax rules see [model-list][model-list]
+- Default: `-`
+- Example: `01-ai/yi-34b-chat`
+
 ## Ollama
 
 ### `OLLAMA_PROXY_URL`
 
-- Type: Optional
+- Type: Required
 - Description: Used to enable the Ollama service, setting this will display optional open-source language models in the language model list and can also specify custom language models
 - Default: -
 - Example: `http://127.0.0.1:11434/v1`
@@ -164,27 +190,27 @@ When using the `turn` mode, the API Keys will be retrieved in a round-robin mann
 ### `OLLAMA_MODEL_LIST`
 
 - Type: Optional
-- Description: Used to customize your own language models
+- Description: Used to specify a custom Ollama language model. Model definition syntax rules see [model-list][model-list]
 - Default: -
 - Example: `llama2:7B`
 
-## Perplexity AI
+## Moonshot AI
 
-### `PERPLEXITY_API_KEY`
+### `MOONSHOT_API_KEY`
 
 - Type: Required
-- Description: This is the API key you applied from Perplexity AI
+- Description: This is the API key you applied for in the Moonshot AI service
 - Default: -
-- Example: `pplx-xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx`
+- Example: `Y2xpdGhpMzNhZXNoYjVtdnZjMWc6bXNrLWIxQlk3aDNPaXpBWnc0V1RaMDhSRmRFVlpZUWY=`
 
-## Anthropic AI
+## Perplexity AI
 
-### `ANTHROPIC_API_KEY`
+### `PERPLEXITY_API_KEY`
 
 - Type: Required
-- Description: This is the API key you applied from Anthropic AI
+- Description: This is the API key you applied from Perplexity AI
 - Default: -
-- Example: `sk-ant-apixx-xxxxxxxxx-xxxxxxxxxxxxxxxxx-xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx-xxxxxxxx`
+- Example: `pplx-xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx`
 
 ## Mistral AI
 
@@ -204,21 +230,14 @@ When using the `turn` mode, the API Keys will be retrieved in a round-robin mann
 - Default: -
 - Example: `gsk_xxxxxxxxxxxxxxxxxxxxxxxxxxxxx`
 
-## OpenRouter AI
+## ZHIPU AI
 
-### `OPENROUTER_API_KEY`
+### `ZHIPU_API_KEY`
 
 - Type: Required
-- Description: This is the API key you applied for in the OpenRouter AI service
+- Description: This is the API key you applied for in the ZHIPU AI service
 - Default: -
-- Example: `sk-or-v1-xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx=`
-
-### `OPENROUTER_MODEL_LIST`
-
-- Type: Optional
-- Description: Used to control the model list, use `+` to add a model, use `-` to hide a model, use `model_name=display_name` to customize the display name of a model, separated by commas.
-- Default: `-`
-- Example: `-all,+01-ai/yi-34b-chat,+huggingfaceh4/zephyr-7b-beta`
+- Example: `4582d332441a313f5c2ed9824d1798ca.rC8EcTAhgbOuAuVT`
 
 ## 01.AI
 
@@ -229,11 +248,4 @@ When using the `turn` mode, the API Keys will be retrieved in a round-robin mann
 - Default: -
 - 示例：`xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx`
 
-## TogetherAI
-
-### `TOGETHERAI_API_KEY`
-
-- Type: Required
-- Description: This is the API key you applied for in the TogetherAI service
-- Default: -
-- Example: `xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx`
+[model-list]: /docs/self-hosting/advanced/model-list