@lobehub/chat 0.128.2 → 0.128.4

package/docs/agents/prompt.zh-CN.mdx

@@ -0,0 +1,97 @@
+import { Callout } from 'nextra/components';
+
+# Prompt 使用指南
+
+## Prompt 基本概念
+
+生成式 AI 非常有用，但它需要人类指导。通常情况下，生成式 AI 能就像公司新来的实习生一样，非常有能力，但需要清晰的指示才能做得好。能够正确地指导生成式 AI 是一项非常强大的技能。你可以通过发送一个 prompt 来指导生成式 AI，这通常是一个文本指令。Prompt 是向助手提供的输入，它会影响输出结果。一个好的 Prompt 应该是结构化的，清晰的，简洁的，并且具有指向性。
+
+## 如何写好一个结构化 prompt
+
+<Callout type={'info'}>
+  结构化 prompt 是指 prompt 的构造应该有明确的逻辑和结构。例如，如果你想让模型生成一篇文章，你的
+  prompt 可能需要包括文章的主题，文章的大纲，文章的风格等信息。
+</Callout>
+
+让我们看一个基本的讨论问题的例子:
+
+> _"我们星球面临的最紧迫的环境问题是什么，个人可以采取哪些措施来帮助解决这些问题？"_
+
+我们可以将其转化为简单的助手提示，将回答以下问题：放在前面。
+
+```prompt
+回答以下问题:
+我们星球面临的最紧迫的环境问题是什么，个人可以采取哪些措施来帮助解决这些问题？
+```
+
+由于这个提示生成的结果并不一致，有些只有一两个句子。一个典型的讨论回答应该有多个段落，因此这些结果并不理想。一个好的提示应该给出**具体的格式和内容指令**。您需要消除语言中的歧义以提高一致性和质量。这是一个更好的提示。
+
+```prompt
+写一篇高度详细的论文，包括引言、正文和结论段，回答以下问题:
+我们星球面临的最紧迫的环境问题是什么，
+个人可以采取哪些措施来帮助解决这些问题？
+```
+
+第二个提示生成了更长的输出和更好的结构。提示中使用 “论文” 一词是有意的，因为助手可以理解论文的定义，因此更有可能生成连贯的、结构化的回答。
+
+<br />
+
+## 如何提升其质量和效果
+
+<Callout type={'info'}>
+提升 prompt 质量和效果的方法主要有以下几点：
+
+- **尽量明确你的需求：** 模型的输出会尽可能满足你的需求，所以如果你的需求不明确，输出可能会不如预期。
+- **使用正确的语法和拼写：** 模型会尽可能模仿你的语言风格，所以如果你的语言风格有问题，输出可能也会有问题。
+- **提供足够的上下文信息：** 模型会根据你提供的上下文信息生成输出，所以如果你提供的上下文信息不足，可能无法生成你想要的结果。
+
+</Callout>
+
+在为讨论问题制定有效的提示后，您现在需要细化生成的结果。这可能涉及到调整输出以符合诸如字数等限制，或将不同生成的结果的概念组合在一起。
+
+迭代的一个简单方法是生成多个输出并查看它们，以了解正在使用的概念和结构。一旦评估了输出，您就可以选择最合适的输出并将它们组合成一个连贯的回答。另一种迭代的方法是逐步开始，然后**逐步扩展**。这需要不止一个提示：一个起始提示，用于撰写最初的一两段，然后是其他提示，以扩展已经写过的内容。以下是一个潜在的哲学讨论问题:
+
+> _"数学是发明还是发现？用仔细的推理来解释你的答案。"_
+
+将其添加到一个简单的提示中，如下所示:
+
+```prompt
+写一个起始段回答以下问题:
+数学是发明还是发现？用仔细的推理来解释你的答案。
+```
+
+生成了一些回答，找到了一个我们喜欢的：
+
+```prompt
+哲学家和数学家之间争论不休，数学是发明还是发现。
+一些人认为，数学的概念和原则独立于人类思维存在，因此可以被认为是被发现而不是被发明的。
+例如，数字、比率和几何形状的概念在自然界中被观察到，可以被抽象化和系统化地研究。
+```
+
+是一个不错的开端。然后使用另一个提示来扩展：
+
+```prompt
+我正在撰写一篇详细的短文，回答以下提示:
+数学是发明还是发现？用仔细的推理来解释你的答案。这是我目前的情况: 哲学家和数学家之间争论不休，数学是发明还是发现。
+一些人认为，数学的概念和原则独立于人类思维存在，因此可以被认为是被发现而不是被发明的。
+例如，数字、比率和几何形状的概念在自然界中被观察到，可以被抽象化和系统化地研究。写下我文章的下一段。
+```
+
+使用此提示生成了几个扩展，并选择了一个我喜欢的，最终得到了以下结果：
+
+```prompt
+哲学家和数学家之间争论不休，数学是发明还是发现。
+一些人认为，数学的概念和原则独立于人类思维存在，因此可以被认为是被发现而不是被发明的。
+例如，数字、比率和几何形状的概念在自然界中被观察到，可以被抽象化和系统化地研究。
+另一方面，有人认为数学在很大程度上是人类思维的发明。
+数学原理基于逻辑推理，这是人类思维的一个特征。
+例如，欧几里德几何基于抽象的公理和前提，被接受为真实而无需证明。
+因此，可以认为几何是人类思维的发明，而不是一种发现。
+同样，数学公式和方程用于模拟和预测物理现象，这又是人类推理的结果。
+```
+
+使用扩展提示，我们可以逐步地写作并在每个步骤上进行迭代。这对于需要**生成更高质量的输出并希望逐步修改**的情况非常有用。
+
+## 扩展阅读
+
+- **Learn Prompting**: https://learnprompting.org/zh-Hans/docs/intro

package/docs/agents/topics.mdx

@@ -0,0 +1,7 @@
+# Topic Usage Guide
+
+![](https://github-production-user-asset-6210df.s3.amazonaws.com/17870709/279602496-fd72037a-735e-4cc2-aa56-2994bceaba81.png)
+
+- **Save Topic:** During a conversation, if you want to save the current context and start a new topic, you can click the save button next to the send button.
+- **Topic List:** Clicking on a topic in the list allows for quick switching of historical conversation records and continuing the conversation. You can also use the star icon <kbd>⭐️</kbd> to pin favorite topics to the top, or use the more button on the right to rename or delete topics.
+

package/docs/agents/topics.zh-CN.mdx

@@ -0,0 +1,6 @@
+# 话题使用指南
+
+![](https://github-production-user-asset-6210df.s3.amazonaws.com/17870709/279602496-fd72037a-735e-4cc2-aa56-2994bceaba81.png)
+
+- **保存话题：** 在聊天过程中，如果想要保存当前上下文并开启新的话题，可以点击发送按钮旁边的保存按钮。
+- **话题列表：** 点击列表中的话题可以快速切换历史对话记录，并继续对话。你还可以通过点击星标图标 <kbd>⭐️</kbd> 将话题收藏置顶，或者通过右侧更多按钮对话题进行重命名和删除操作。

package/docs/common-errors/no-v1-suffix.mdx

@@ -0,0 +1,18 @@
+# Configuring `OPENAI_PROXY_URL` Environment Variable but Getting Empty Response
+
+### Problem Description
+
+After configuring the `OPENAI_PROXY_URL` environment variable, you may encounter a situation where the AI returns an empty message. This may be due to an incorrect configuration of `OPENAI_PROXY_URL`.
+
+### Solution
+
+Recheck and confirm whether `OPENAI_PROXY_URL` is set correctly, including whether the `/v1` suffix is added correctly (if required).
+
+### Related Discussion Links
+
+- [Why is the return value blank after configuring environment variables in Docker?](https://github.com/lobehub/lobe-chat/discussions/623)
+- [Reasons for errors when using third-party interfaces](https://github.com/lobehub/lobe-chat/discussions/734)
+- [No response when the proxy server address is filled in for chat](https://github.com/lobehub/lobe-chat/discussions/1065)
+
+If the problem still cannot be resolved, it is recommended to raise the issue in the community, providing relevant logs and configuration information for other developers or maintainers to offer assistance.
+

package/docs/common-errors/no-v1-suffix.zh-CN.mdx

@@ -0,0 +1,17 @@
+# 配置 `OPENAI_PROXY_URL` 环境变量但返回值为空
+
+### 问题描述
+
+配置 `OPENAI_PROXY_URL` 环境变量后，可能会遇到 AI 的返回消息为空的情况。这可能是由于 `OPENAI_PROXY_URL` 配置不正确导致。
+
+### 解决方案
+
+重新检查并确认 `OPENAI_PROXY_URL` 是否设置正确，包括是否正确地添加了 `/v1` 后缀（如果需要）。
+
+### 相关讨论链接
+
+- [Docker 安装，配置好环境变量后，为何返回值是空白？](https://github.com/lobehub/lobe-chat/discussions/623)
+- [使用第三方接口报错的原因](https://github.com/lobehub/lobe-chat/discussions/734)
+- [代理服务器地址填了聊天没任何反应](https://github.com/lobehub/lobe-chat/discussions/1065)
+
+如果问题依旧无法解决，建议在社区中提出问题，附上相关日志和配置信息，以便其他开发者或维护者提供帮助。

package/docs/common-errors/proxy-with-unable-to-verify-leaf-signature.mdx

@@ -0,0 +1,70 @@
+# Encounter `UNABLE_TO_VERIFY_LEAF_SIGNATURE` Error When Using Proxy
+
+## Problem Description
+
+When deploying privately and using a proxy (e.g., Surge) for network requests, you may encounter certificate verification errors.
+
+The error message may look like this:
+
+```bash
+[TypeError: fetch failed] {
+  cause: [Error: unable to verify the first certificate] {
+    code: 'UNABLE_TO_VERIFY_LEAF_SIGNATURE'
+  }
+}
+```
+
+Or:
+
+```json
+{
+  "endpoint": "https://api.openai.com/v1",
+  "error": {
+    "cause": {
+      "code": "UNABLE_TO_VERIFY_LEAF_SIGNATURE"
+    }
+  }
+}
+```
+
+This problem typically occurs when using a proxy server with a self-signed certificate or a man-in-the-middle certificate that is not trusted by Node.js by default.
+
+## Solution
+
+To resolve this issue, you can bypass Node.js certificate validation by adding an environment variable when starting the application. Specifically, you can add `NODE_TLS_REJECT_UNAUTHORIZED=0` to the startup command. For example:
+
+```bash
+NODE_TLS_REJECT_UNAUTHORIZED=0 npm run start
+```
+
+Alternatively, when running in a Docker container, you can set the environment variable in the Dockerfile or docker-compose.yml:
+
+```dockerfile
+# In the Dockerfile
+ENV NODE_TLS_REJECT_UNAUTHORIZED=0
+```
+
+```yaml
+# In the docker-compose.yml
+environment:
+  - NODE_TLS_REJECT_UNAUTHORIZED=0
+```
+
+Example Docker run command:
+
+```bash
+docker run -e NODE_TLS_REJECT_UNAUTHORIZED=0 <other parameters> <image name>
+```
+
+Please note that this method reduces security as it allows Node.js to accept unverified certificates. Therefore, it is only recommended for use in privately deployed environments with complete trust and should be reverted to the default certificate validation settings after resolving the certificate issue.
+
+## More Secure Alternatives
+
+If possible, it is recommended to address the certificate issue using the following methods:
+
+1. Ensure all man-in-the-middle certificates are correctly installed on the proxy server and the corresponding clients.
+2. Replace self-signed or man-in-the-middle certificates with valid certificates issued by trusted certificate authorities.
+3. Properly configure the certificate chain in the code to ensure Node.js can validate to the root certificate.
+
+Implementing these methods can resolve certificate validation issues without compromising security.
+

package/docs/{Deployment/Common-Error.zh-CN.md → common-errors/proxy-with-unable-to-verify-leaf-signature.zh-CN.mdx}

@@ -1,30 +1,12 @@
-# 常见问题
+# 使用代理时遇到 `UNABLE_TO_VERIFY_LEAF_SIGNATURE` 错误
 
-## 配置 `OPENAI_PROXY_URL` 环境变量但返回值为空
+## 问题描述
 
-### 问题描述
+在私有化部署时，使用代理（例如：Surge）进行网络请求可能会遇到证书验证错误。
 
-配置 `OPENAI_PROXY_URL` 环境变量后，可能会遇到 AI 的返回消息为空的情况。这可能是由于 `OPENAI_PROXY_URL` 配置不正确导致。
+此时错误信息可能如下：
 
-### 解决方案
-
-重新检查并确认 `OPENAI_PROXY_URL` 是否设置正确，包括是否正确地添加了 `/v1` 后缀（如果需要）。
-
-### 相关讨论链接
-
-- [Docker 安装，配置好环境变量后，为何返回值是空白？](https://github.com/lobehub/lobe-chat/discussions/623)
-- [使用第三方接口报错的原因](https://github.com/lobehub/lobe-chat/discussions/734)
-- [代理服务器地址填了聊天没任何反应](https://github.com/lobehub/lobe-chat/discussions/1065)
-
-如果问题依旧无法解决，建议在社区中提出问题，附上相关日志和配置信息，以便其他开发者或维护者提供帮助。
-
-## 使用代理中转请求时（例如：Surge），报 `UNABLE_TO_VERIFY_LEAF_SIGNATURE` 错误
-
-### 问题描述
-
-在私有化部署时，进行网络请求可能会遇到证书验证错误。错误信息可能如下：
-
-```
+```bash
 [TypeError: fetch failed] {
   cause: [Error: unable to verify the first certificate] {
     code: 'UNABLE_TO_VERIFY_LEAF_SIGNATURE'
@@ -34,7 +16,7 @@
 
 或者是：
 
-```
+```json
 {
   "endpoint": "https://api.openai.com/v1",
   "error": {
@@ -47,7 +29,7 @@
 
 这个问题通常出现在使用代理服务器时，代理服务器使用的自签名证书或中间人证书不被 Node.js 默认信任。
 
-### 解决方案
+## 解决方案
 
 要解决这个问题，可以在启动应用时添加环境变量，跳过 Node.js 的证书验证。具体做法是在启动命令中加入 `NODE_TLS_REJECT_UNAUTHORIZED=0`。例如：
 
@@ -76,7 +58,7 @@ docker run -e NODE_TLS_REJECT_UNAUTHORIZED=0 <其他参数> <镜像名>
 
 请注意，这种方法会降低安全性，因为它允许 Node.js 接受未经验证的证书。因此，仅建议在完全信任网络环境的私有化部署中使用，且需要在解决证书问题后恢复默认的证书验证设置。
 
-### 更安全的替代方案
+## 更安全的替代方案
 
 如果可能，建议通过以下方法解决证书问题：
 

package/docs/environment-variables/common.mdx

@@ -0,0 +1,215 @@
+import { Callout } from 'nextra/components';
+
+# Environment Variables
+
+LobeChat provides some additional configuration options during deployment, which can be customized using environment variables.
+
+## Common Variables
+
+### `ACCESS_CODE`
+
+- Type: Optional
+- Description: Add a password to access the LobeChat service. You can set a long password to prevent brute force attacks.
+- Default: -
+- Example: `awCTe)re_r74` or `rtrt_ewee3@09!`
+
+### `ENABLE_OAUTH_SSO`
+
+- Type: Optional
+- Description: Enable Single Sign-On (SSO) for LobeChat. Set to `1` to enable SSO. For more information, see [Authentication Services](#authentication-services).
+- Default: -
+- Example: `1`
+
+### `NEXT_PUBLIC_BASE_PATH`
+
+- Type: Optional
+- Description: Add a `basePath` for LobeChat.
+- Default: -
+- Example: `/test`
+
+### `DEFAULT_AGENT_CONFIG`
+
+- Type: Optional
+- Description: Used to configure the default settings for the LobeChat default agent. It supports various data types and structures, including key-value pairs, nested fields, array values, and more.
+- Default: -
+- Example: `'model=gpt-4-1106-preview;params.max_tokens=300;plugins=search-engine,lobe-image-designer`
+
+The `DEFAULT_AGENT_CONFIG` is used to configure the default settings for the LobeChat default agent. It supports various data types and structures, including key-value pairs, nested fields, array values, and more. The table below provides detailed information on the configuration options, examples, and corresponding explanations for the `DEFAULT_AGENT_CONFIG` environment variable:
+
+| Configuration Type | Example | Explanation |
+| --- | --- | --- |
+| Basic Key-Value Pair | `model=gpt-4` | Set the model to `gpt-4`. |
+| Nested Field | `tts.sttLocale=en-US` | Set the language locale for the text-to-speech service to `en-US`. |
+| Array | `plugins=search-engine,lobe-image-designer` | Enable the `search-engine` and `lobe-image-designer` plugins. |
+| Chinese Comma | `plugins=search-engine，lobe-image-designer` | Same as above, demonstrating support for Chinese comma separation. |
+| Multiple Configurations | `model=glm-4;provider=zhipu` | Set the model to `glm-4` and the model provider to `zhipu`. |
+| Numeric Value | `params.max_tokens=300` | Set the maximum tokens to `300`. |
+| Boolean Value | `enableAutoCreateTopic=true` | Enable automatic topic creation. |
+| Special Characters | `inputTemplate="Hello; I am a bot;"` | Set the input template to `Hello; I am a bot;`. |
+| Error Handling | `model=gpt-4;maxToken` | Ignore invalid entry `maxToken` and only parse `model=gpt-4`. |
+| Value Override | `model=gpt-4;model=gpt-4-1106-preview` | If a key is repeated, use the value that appears last; in this case, the value of `model` is `gpt-4-1106-preview`. |
+
+Further reading:
+
+- [\[RFC\] 022 - Default Assistant Parameters Configuration via Environment Variables](https://github.com/lobehub/lobe-chat/discussions/913)
+
+## Identity Verification Service
+
+### General Settings
+
+#### `ENABLE_OAUTH_SSO`
+
+- Type: Required
+- Description: Enable single sign-on (SSO) for LobeChat. Set to `1` to enable single sign-on.
+- Default: `-`
+- Example: `1`
+
+#### `NEXTAUTH_SECRET`
+
+- Type: Required
+- Description: Key used to encrypt the session tokens in Auth.js. You can generate the key using the following command: `openssl rand -base64 32`.
+- Default: `-`
+- Example: `Tfhi2t2pelSMEA8eaV61KaqPNEndFFdMIxDaJnS1CUI=`
+
+### Auth0
+
+<Callout>
+  Currently, we only support the Auth0 identity verification service provider. If you need to use
+  other identity verification service providers, you can submit a [feature
+  request](https://github.com/lobehub/lobe-chat/issues/new/choose) or Pull Request.
+</Callout>
+
+#### `AUTH0_CLIENT_ID`
+
+- Type: Required
+- Description: Client ID of the Auth0 application. You can access it [here][auth0-client-page] and navigate to the application settings to view.
+- Default: `-`
+- Example: `evCnOJP1UX8FMnXR9Xkj5t0NyFn5p70P`
+
+#### `AUTH0_CLIENT_SECRET`
+
+- Type: Required
+- Description: Client Secret of the Auth0 application.
+- Default: `-`
+- Example: `wnX7UbZg85ZUzF6ioxPLnJVEQa1Elbs7aqBUSF16xleBS5AdkVfASS49-fQIC8Rm`
+
+#### `AUTH0_ISSUER`
+
+- Type: Required
+- Description: Issuer/domain of the Auth0 application.
+- Default: `-`
+- Example: `https://example.auth0.com`
+
+## Plugin Service
+
+### `PLUGINS_INDEX_URL`
+
+- Type: Optional
+- Description: Index address of the LobeChat plugin market. If you have deployed the plugin market service on your own, you can use this variable to override the default plugin market address.
+- Default: `https://chat-plugins.lobehub.com`
+
+### `PLUGIN_SETTINGS`
+
+- Type: Optional
+- Description: Used to configure plugin settings. Use the format `plugin-name:setting-field=setting-value` to configure the settings of the plugin. Separate multiple setting fields with a semicolon `;`, and separate multiple plugin settings with a comma `,`.
+- Default: `-`
+- Example: `search-engine:SERPAPI_API_KEY=xxxxx,plugin-2:key1=value1;key2=value2`
+
+The above example sets the `SERPAPI_API_KEY` of the `search-engine` plugin to `xxxxx`, and sets `key1` of `plugin-2` to `value1`, and `key2` to `value2`. The generated plugin settings configuration is as follows:
+
+```json
+{
+  "plugin-2": {
+    "key1": "value1",
+    "key2": "value2"
+  },
+  "search-engine": {
+    "SERPAPI_API_KEY": "xxxxx"
+  }
+}
+```
+
+## Assistant Market
+
+### `AGENTS_INDEX_URL`
+
+- Type: Optional
+- Description: Index address of the LobeChat assistant market. If you have deployed the assistant market service on your own, you can use this variable to override the default market address.
+- Default: `https://chat-agents.lobehub.com`
+
+## Data Statistics
+
+### Vercel Analytics
+
+#### `NEXT_PUBLIC_ANALYTICS_VERCEL`
+
+- Type: Optional
+- Description: Used to configure the environment variable for Vercel Analytics. Set to `1` to enable Vercel Analytics.
+- Default: `-`
+- Example: `1`
+
+#### `NEXT_PUBLIC_VERCEL_DEBUG`
+
+- Type: Optional
+- Description: Used to enable the debug mode for Vercel Analytics.
+- Default: `-`
+- Example: `1`
+
+### Posthog Analytics
+
+#### `NEXT_PUBLIC_ANALYTICS_POSTHOG`
+
+- Type: Optional
+- Description: Used to enable the environment variable for [PostHog Analytics][posthog-analytics-url]. Set to `1` to enable PostHog Analytics.
+- Default: `-`
+- Example: `1`
+
+#### `NEXT_PUBLIC_POSTHOG_KEY`
+
+- Type: Optional
+- Description: Set the PostHog project Key.
+- Default: `-`
+- Example: `phc_xxxxxxxx`
+
+#### `NEXT_PUBLIC_POSTHOG_HOST`
+
+- Type: Optional
+- Description: Set the deployment address of the PostHog service, defaulting to the official SAAS address.
+- Default: `https://app.posthog.com`
+- Example: `https://example.com`
+
+#### `NEXT_PUBLIC_POSTHOG_DEBUG`
+
+- Type: Optional
+- Description: Enable the debug mode for PostHog.
+- Default: `-`
+- Example: `1`
+
+### Umami Analytics
+
+#### `NEXT_PUBLIC_ANALYTICS_UMAMI`
+
+- Type: Optional
+- Description: Used to enable the environment variable for [Umami Analytics][umami-analytics-url]. Set to `1` to enable Umami Analytics.
+- Default: `-`
+- Example: `1`
+
+#### `NEXT_PUBLIC_UMAMI_SCRIPT_URL`
+
+- Type: Optional
+- Description: The URL of the Umami script, defaulting to the script URL provided by Umami Cloud.
+- Default: `https://analytics.umami.is/script.js`
+- Example: `https://umami.your-site.com/script.js`
+
+#### `NEXT_PUBLIC_UMAMI_WEBSITE_ID`
+
+- Type: Required
+- Description: Your Umami Website ID.
+- Default: `-`
+- Example: `E738D82A-EE9E-4806-A81F-0CA3CAE57F65`
+
+[auth0-client-page]: https://manage.auth0.com/dashboard
+[azure-api-verion-url]: https://docs.microsoft.com/zh-cn/azure/developer/javascript/api-reference/es-modules/azure-sdk/ai-translation/translationconfiguration?view=azure-node-latest#api-version
+[openai-api-page]: https://platform.openai.com/account/api-keys
+[posthog-analytics-url]: https://posthog.com
+[umami-analytics-url]: https://umami.is