From 6e160833fdaafe8c7ccb69a4e594c3c699c29b2d Mon Sep 17 00:00:00 2001 From: Agustin Carrasco Date: Wed, 27 Dec 2023 00:45:34 -0300 Subject: [PATCH] style(lobe chat): adjust description file --- apps/lobe-chat/config.json | 3 ++- apps/lobe-chat/metadata/description.md | 14 +++++++------- 2 files changed, 9 insertions(+), 8 deletions(-) diff --git a/apps/lobe-chat/config.json b/apps/lobe-chat/config.json index 49a1f343..d544d686 100644 --- a/apps/lobe-chat/config.json +++ b/apps/lobe-chat/config.json @@ -37,5 +37,6 @@ "required": false, "env_variable": "ACCESS_CODE" } - ] + ], + "supported_architectures": ["arm64", "amd64"] } diff --git a/apps/lobe-chat/metadata/description.md b/apps/lobe-chat/metadata/description.md index f56fe8bd..0aed4a3e 100644 --- a/apps/lobe-chat/metadata/description.md +++ b/apps/lobe-chat/metadata/description.md @@ -2,12 +2,12 @@ LobeChat is an open-source, high-performance chatbot framework that supports speech synthesis, multimodal, and extensible -([Function Call](https://sspai.com/post/81986)) plugin system. +([Function Call](https://platform.openai.com/docs/guides/function-calling)) plugin system. ## Settings -| Environment Variable | Required | Description | Example | -| -------------------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | -| `OPENAI_API_KEY` | Yes | This is the API key you apply on the OpenAI account page | `sk-xxxxxx...xxxxxx` | -| `OPENAI_PROXY_URL` | No | If you manually configure the OpenAI interface proxy, you can use this configuration item to override the default OpenAI API request base URL | `https://api.chatanywhere.cn/v1`
The default value is
`https://api.openai.com/v1` | -| `ACCESS_CODE` | No | Add a password to access this service; you can set a long password to avoid leaking. If this value contains a comma, it is a password array. | `awCTe)re_r74` or `rtrt_ewee3@09!` or `code1,code2,code3` | -| `CUSTOM_MODELS` | No | Used to control the model list. Use `+` to add a model, `-` to hide a model, and `model_name=display_name` to customize the display name of a model, separated by commas. | `qwen-7b-chat,+glm-6b,-gpt-3.5-turbo` | +| Environment Variable | Required | Description | Example | +| -------------------- | -------- | ------------| --------| +| `OPENAI_API_KEY` | Yes | API key for OpenAI. You can generate it on [your OpenAI account page](https://platform.openai.com/api-keys). **Note:** Keep your `OPENAI_API_KEY` secure to prevent unauthorized access. | `sk-xxxxxx...xxxxxx` | +| `OPENAI_PROXY_URL` | No | Override the default OpenAI API base URL for requests. **Caution:** Only use a trusted proxy to ensure the security of your data. | `https://api.chatanywhere.cn/v1`
The default value is
`https://api.openai.com/v1` | +| `ACCESS_CODE` | No | Password to avoid leaking. If you want to have multiple passwords, use a comma separated list. **Security Best Practice:** Avoid storing passwords directly in environment variables. Use a secrets management service to protect sensitive information. | `awCTe)re_r74` or `rtrt_ewee3@09!` or `code1,code2,code3` | +| `CUSTOM_MODELS` | No | Control the model list. Use `+` to add a model, `-` to hide a model, and `model_name=display_name` to customize the display name of a model, separated by commas. | `qwen-7b-chat,+glm-6b,-gpt-3.5-turbo` |