Skip to content

Commit

Permalink
merge main to develop/ChatGSE-Next (#8)
Browse files Browse the repository at this point in the history
* Update chat.tsx

* Update chat.tsx

* [ADDED] MacOS detect

* [FIXED] now the default key should be CMD on MacOS

* [FIXED] now it should detects all macintosh

* UI Page [Auth Page]

[+] feat(auth.tsx): add support for resetting access token in resetAccessCode function
[+] fix(auth.tsx): fix formatting issue in resetAccessCode function
[+] feat(locales): add support for sub tips in Auth component for multiple languages :
  - Add sub tips in Arabic locale (ar.ts)
  - Add sub tips in Bengali locale (bn.ts)
  - Add sub tips in Chinese locale (cn.ts)
  - Add sub tips in English locale (en.ts)
  - Add sub tips in Indonesian locale (id.ts)

* Feat & Fix UI Page [Auth Page]

[+] feat(auth.tsx): add goChat function to navigate to chat page
[+] fix(auth.tsx): change onClick event from goHome to goChat

* Refactor Locale Indonesia

[+] refactor(id.ts): remove unused import and isApp variable
[+] fix(id.ts): update Unauthorized error message

* Fix & Refactor UI Page [Auth Page]

[+] fix(auth.tsx): fix conditional rendering of token input field
[+] refactor(auth.tsx): improve code readability by using conditional rendering for token input field

* Client App [Notification]

[+] feat(global.d.ts): add support for window.__TAURI__.notification methods
[+] feat(update.ts): add notification for new version availability
[+] fix(Cargo.toml): add tauri feature "notification-all" to enable notifications
[+] fix(tauri.conf.json): enable all notification features in tauri configuration

* Client App Fix Issue [Bug] 'export' button does not work ChatGPTNextWeb#2884

[+] fix(exporter.tsx): add async keyword to download function
[+] feat(exporter.tsx): add support for saving image file using window.__TAURI__ API
[+] feat(global.d.ts): add types for window.__TAURI__ API methods
[+] feat(locales): add translations for download success and failure messages
[+] feat(sync.ts): add support for generating backup file name with date and time
[+] fix(utils.ts): add async keyword to downloadAs function and add support for saving file using window.__TAURI__ API

* Fix & Feat Client App [Notification]

[+] fix(update.ts): remove unnecessary notification sending when permission is not granted
[+] feat(update.ts): add notification for already up to date version

* Feat & Fix "Client App [Notification]"

[+] feat(update.ts): add support for localization in update notifications
[+] fix(update.ts): add missing semicolon in useUpdateStore function

* Change log

-   config.ts
    -   line 72 remove type confirmation of x as x always has type 'number'
    -   line 135 remove redundant local variable
-   chat.ts
    -   delete unused import

* Change log

-   config.ts
    -   line 72: remove type confirmation of x as x always has type 'number'
    -   line 135: remove the redundant local variable
-   chat.ts
    -   delete the unused import

* Improve tw locale

* Update tauri.conf.json

* 修改界面

似乎这里引入了一个逻辑判断错误,会导致打包之后的界面变宽变高。

* Update tauri.conf.json

* fix: ChatGPTNextWeb#2981 full screen button not works

* Fix type in sync.ts

Simple typo fix.

* Refactor Mask UI Page [Masks]

[+] refactor(mask.tsx): refactor simple search to be case-insensitive

* 提供同步聊天记录教程,同时翻译多国语言

* Update constant.ts

* 已拆分单个文件、翻译多国语言版本

* docs: fix typo in app/masks/en.ts

* fix serviceWorker cache

* Fix typo in README.md

passsword -> password

* Update README.md

* feat: close ChatGPTNextWeb#3031 user can set larger font size

* Update synchronise-chat-logs-cn.md

* Update README_CN.md

* Update README_KO.md

* Update README_KO.md

* Revert "fix serviceWorker cache: auto caching files by workbox"

* merge upstream/main to main (#6)

* Update chat.tsx

* Update chat.tsx

* [ADDED] MacOS detect

* [FIXED] now the default key should be CMD on MacOS

* [FIXED] now it should detects all macintosh

* UI Page [Auth Page]

[+] feat(auth.tsx): add support for resetting access token in resetAccessCode function
[+] fix(auth.tsx): fix formatting issue in resetAccessCode function
[+] feat(locales): add support for sub tips in Auth component for multiple languages :
  - Add sub tips in Arabic locale (ar.ts)
  - Add sub tips in Bengali locale (bn.ts)
  - Add sub tips in Chinese locale (cn.ts)
  - Add sub tips in English locale (en.ts)
  - Add sub tips in Indonesian locale (id.ts)

* Feat & Fix UI Page [Auth Page]

[+] feat(auth.tsx): add goChat function to navigate to chat page
[+] fix(auth.tsx): change onClick event from goHome to goChat

* Refactor Locale Indonesia

[+] refactor(id.ts): remove unused import and isApp variable
[+] fix(id.ts): update Unauthorized error message

* Fix & Refactor UI Page [Auth Page]

[+] fix(auth.tsx): fix conditional rendering of token input field
[+] refactor(auth.tsx): improve code readability by using conditional rendering for token input field

* Client App [Notification]

[+] feat(global.d.ts): add support for window.__TAURI__.notification methods
[+] feat(update.ts): add notification for new version availability
[+] fix(Cargo.toml): add tauri feature "notification-all" to enable notifications
[+] fix(tauri.conf.json): enable all notification features in tauri configuration

* Client App Fix Issue [Bug] 'export' button does not work ChatGPTNextWeb#2884

[+] fix(exporter.tsx): add async keyword to download function
[+] feat(exporter.tsx): add support for saving image file using window.__TAURI__ API
[+] feat(global.d.ts): add types for window.__TAURI__ API methods
[+] feat(locales): add translations for download success and failure messages
[+] feat(sync.ts): add support for generating backup file name with date and time
[+] fix(utils.ts): add async keyword to downloadAs function and add support for saving file using window.__TAURI__ API

* Fix & Feat Client App [Notification]

[+] fix(update.ts): remove unnecessary notification sending when permission is not granted
[+] feat(update.ts): add notification for already up to date version

* Feat & Fix "Client App [Notification]"

[+] feat(update.ts): add support for localization in update notifications
[+] fix(update.ts): add missing semicolon in useUpdateStore function

* Change log

-   config.ts
    -   line 72 remove type confirmation of x as x always has type 'number'
    -   line 135 remove redundant local variable
-   chat.ts
    -   delete unused import

* Change log

-   config.ts
    -   line 72: remove type confirmation of x as x always has type 'number'
    -   line 135: remove the redundant local variable
-   chat.ts
    -   delete the unused import

* Improve tw locale

* Update tauri.conf.json

* 修改界面

似乎这里引入了一个逻辑判断错误,会导致打包之后的界面变宽变高。

* Update tauri.conf.json

* fix: ChatGPTNextWeb#2981 full screen button not works

* Fix type in sync.ts

Simple typo fix.

* Refactor Mask UI Page [Masks]

[+] refactor(mask.tsx): refactor simple search to be case-insensitive

* 提供同步聊天记录教程,同时翻译多国语言

* Update constant.ts

* 已拆分单个文件、翻译多国语言版本

* docs: fix typo in app/masks/en.ts

* fix serviceWorker cache

* Fix typo in README.md

passsword -> password

* Update README.md

* feat: close ChatGPTNextWeb#3031 user can set larger font size

* Update synchronise-chat-logs-cn.md

* Update README_CN.md

* Update README_KO.md

* Update README_KO.md

* Revert "fix serviceWorker cache: auto caching files by workbox"

---------

Co-authored-by: Algorithm5838 <[email protected]>
Co-authored-by: Yifei Zhang <[email protected]>
Co-authored-by: Eric R <[email protected]>
Co-authored-by: H0llyW00dzZ <[email protected]>
Co-authored-by: KeithHello <[email protected]>
Co-authored-by: Peter Dave Hello <[email protected]>
Co-authored-by: GH Action - Upstream Sync <[email protected]>
Co-authored-by: Kong Gaowen <[email protected]>
Co-authored-by: Jason O'Gray <[email protected]>
Co-authored-by: H0llyW00dzZ <[email protected]>
Co-authored-by: mcheping520 <[email protected]>
Co-authored-by: Surav Shrestha <[email protected]>
Co-authored-by: Jesse <[email protected]>
Co-authored-by: Ikko Eltociear Ashimine <[email protected]>

* Feat Models [GPT-4] [GPT-3.5] [128K context]

[+] feat(constant.ts): add new models to DEFAULT_MODELS array

* Fix Typo [GPT-4]

[+] fix(constant.ts): fix typo in model name, change "ggpt-4-1106-preview" to "gpt-4-1106-preview"

* Refactor KnowledgeCutoff

[+] fix(constant.ts): update DEFAULT_SYSTEM_TEMPLATE to include knowledgeCutoff and time variables
[+] feat(chat.ts): add support for injecting system prompts based on model configuration

* fix: ChatGPTNextWeb#3016 disable sidebar transition on ios

* fix: ChatGPTNextWeb#3152 system prompt should be injected

* feat: default disable balance query

* feat: close ChatGPTNextWeb#2908 allow to disable parse settings from link

* fixup

* feat: sort model by name

* Update tauri.conf.json

* docs: up to date

* docs: fix typo in ChatGPTNextWeb#3171

* Update cloudflare-pages-cn.md

cloudflare 构建命令

* feat: close ChatGPTNextWeb#2954 chat summary should be copyable

* fix: ChatGPTNextWeb#3174 should prompt to confirm to delete chat

* feat: close ChatGPTNextWeb#3187 use CUSTOM_MODELS to control model list

* fix: ChatGPTNextWeb#3186 enable max_tokens in chat payload

* fix: ChatGPTNextWeb#3192 use smaller max_tokens as default

* fix: ChatGPTNextWeb#3196 3.5-turbo-1106 should use old cutoff date

* feat: wont send max_tokens

* feat: close ChatGPTNextWeb#935 add azure support

* fixup

* doc: update azure env vars

* Update README.md

* Update README.md

* fix: ChatGPTNextWeb#3207 ensure corner case

* Update tauri.conf.json

* fixbug

* Update constant.ts

* Update README_CN.md

* feat: ChatGPTNextWeb#3224 auto switch to first avaliable model

* feat: CUSTOM_MODELS support mapper

* chore: update doc for mapped `CUSTOM_MODELS`

* feat: close ChatGPTNextWeb#3222 share message list should start from clear context index

* Feat UI/UX Page Local Language [Exporter Message]

[+] fix(exporter.tsx): update the text in the ExportMessageModal component to use the localized title from the locale file
[+] feat(cn.ts, en.ts, id.ts): add localized title for the Exporter Description in the respective locale files

* Fix UI/UX Page Local Language [Exporter Message]

fix(locales): fix incorrect description title in en.ts and id.ts
 - Change "Only messages after clearing the context will be displayed" to "Only messages before clearing the context will be displayed" in en.ts
 - Change "Hanya pesan setelah menghapus konteks yang akan ditampilkan" to "Hanya pesan sebelum menghapus konteks yang akan ditampilkan" in id.ts

* Revert "Fix UI/UX Page Local Language [Exporter Message]"

This reverts commit a46f081.
Reason : better after instead of before

* UI (model selection): hide unavailable model options

* fix: ChatGPTNextWeb#3189 should correct math eq in exporter

* fix: ChatGPTNextWeb#2841 dollar sign conflict with latex math

* fix: ChatGPTNextWeb#3241 should not ensure openai url non-empty

* Update README.md

* chore(deps-dev): bump @types/node from 20.3.3 to 20.9.0

Bumps [@types/node](https://github.com/DefinitelyTyped/DefinitelyTyped/tree/HEAD/types/node) from 20.3.3 to 20.9.0.
- [Release notes](https://github.com/DefinitelyTyped/DefinitelyTyped/releases)
- [Commits](https://github.com/DefinitelyTyped/DefinitelyTyped/commits/HEAD/types/node)

---
updated-dependencies:
- dependency-name: "@types/node"
  dependency-type: direct:development
  update-type: version-update:semver-minor
...

Signed-off-by: dependabot[bot] <[email protected]>

* chore(deps-dev): bump @types/spark-md5 from 3.0.2 to 3.0.4

Bumps [@types/spark-md5](https://github.com/DefinitelyTyped/DefinitelyTyped/tree/HEAD/types/spark-md5) from 3.0.2 to 3.0.4.
- [Release notes](https://github.com/DefinitelyTyped/DefinitelyTyped/releases)
- [Commits](https://github.com/DefinitelyTyped/DefinitelyTyped/commits/HEAD/types/spark-md5)

---
updated-dependencies:
- dependency-name: "@types/spark-md5"
  dependency-type: direct:development
  update-type: version-update:semver-patch
...

Signed-off-by: dependabot[bot] <[email protected]>

* chore(deps): bump mermaid from 10.3.1 to 10.6.1

Bumps [mermaid](https://github.com/mermaid-js/mermaid) from 10.3.1 to 10.6.1.
- [Release notes](https://github.com/mermaid-js/mermaid/releases)
- [Changelog](https://github.com/mermaid-js/mermaid/blob/develop/CHANGELOG.md)
- [Commits](mermaid-js/mermaid@v10.3.1...v10.6.1)

---
updated-dependencies:
- dependency-name: mermaid
  dependency-type: direct:production
  update-type: version-update:semver-minor
...

Signed-off-by: dependabot[bot] <[email protected]>

* chore(deps): bump emoji-picker-react from 4.5.1 to 4.5.15

Bumps [emoji-picker-react](https://github.com/ealush/emoji-picker-react) from 4.5.1 to 4.5.15.
- [Release notes](https://github.com/ealush/emoji-picker-react/releases)
- [Commits](https://github.com/ealush/emoji-picker-react/commits)

---
updated-dependencies:
- dependency-name: emoji-picker-react
  dependency-type: direct:production
  update-type: version-update:semver-patch
...

Signed-off-by: dependabot[bot] <[email protected]>

* chore(deps): bump nanoid from 4.0.2 to 5.0.3

Bumps [nanoid](https://github.com/ai/nanoid) from 4.0.2 to 5.0.3.
- [Release notes](https://github.com/ai/nanoid/releases)
- [Changelog](https://github.com/ai/nanoid/blob/main/CHANGELOG.md)
- [Commits](ai/nanoid@4.0.2...5.0.3)

---
updated-dependencies:
- dependency-name: nanoid
  dependency-type: direct:production
  update-type: version-update:semver-major
...

Signed-off-by: dependabot[bot] <[email protected]>

* Fix UI/UX Page [Settings]

[+] fix(settings.tsx): fix condition to show balance query in settings component
[+] fix(settings.tsx): add condition to hide balance query for app clients

* fix: ChatGPTNextWeb#3275 refuse on server side if hide user api key

* config: exclude hkg1 from the deployment regions of the edge function

* Update tauri.conf.json

* chore: update gh actions nodejs version to 18

* config: disable ip forward in vercel json config

* Update vercel.json

* Update vercel.json

* Translation of the application into Brazilian Portuguese

* Update vercel.json

* feat: animate streaming response to make more smooth

* feat: close ChatGPTNextWeb#3301 enable or diable default models with -all / +all

* feat: close ChatGPTNextWeb#3304 use `=` instead of `:` to map model name in CUSTOM_MODELS

* feat: close ChatGPTNextWeb#3300 support multiple api keys

* feat: better animation speed

* fix(locales): type error in pt.ts

* fix(CUSTOM_MODELS):ChatGPTNextWeb#3349 Dependency chatStore otherwise the session and view will not updated

* Update README.md

* Update README.md

* Fix UI/UX Page Chats [Memory Prompt] [Stored Local Storage]

- [+] fix(chat.ts): update the memory prompt in onFinish callback
- [+] feat(chat.ts): update the current session with lastSummarizeIndex and memoryPrompt

* Fix Api Common [Server Side] [Console Log]

- [+] fix(common.ts): fix console.log statement for [Org ID] to handle undefined value

* Fixup Api Common [Server Side] [Console Log]

- [+] fix(common.ts): fix condition to check if serverConfig.openaiOrgId is not undefined

* Chore Docs (README.md)

- [+] chore(README.md): add support for Korean and Indonesian languages

* Fix & Refactor UI/UX Page [Auth]

- [+] fix(auth.tsx): fix condition to set custom endpoint to true if it's app
- [+] refactor(auth.tsx): update accessStore to set useCustomConfig to true

* Feat UI/UX Page [Settings]

- [+] feat(settings.tsx): set useCustomConfig to true if clientConfig.isApp is truthy

* Revert "Fix & Refactor UI/UX Page [Auth]"

This reverts commit d76e744.

Reason: Move to commits bf5e7aa

* Fix & Refactor UI/UX Page [Settings]

- [+] fix(settings.tsx): fix conditional rendering of ListItem based on clientConfig.isApp
- [+] refactor(settings.tsx): improve readability of conditional rendering code

* Update README.md

* Update README_CN.md

* update .env.template and docker-compose.yml

---------

Signed-off-by: dependabot[bot] <[email protected]>
Co-authored-by: Algorithm5838 <[email protected]>
Co-authored-by: Yifei Zhang <[email protected]>
Co-authored-by: Eric R <[email protected]>
Co-authored-by: H0llyW00dzZ <[email protected]>
Co-authored-by: KeithHello <[email protected]>
Co-authored-by: Peter Dave Hello <[email protected]>
Co-authored-by: GH Action - Upstream Sync <[email protected]>
Co-authored-by: Kong Gaowen <[email protected]>
Co-authored-by: Jason O'Gray <[email protected]>
Co-authored-by: H0llyW00dzZ <[email protected]>
Co-authored-by: mcheping520 <[email protected]>
Co-authored-by: Surav Shrestha <[email protected]>
Co-authored-by: Jesse <[email protected]>
Co-authored-by: Ikko Eltociear Ashimine <[email protected]>
Co-authored-by: fengsh <[email protected]>
Co-authored-by: 安忆 <[email protected]>
Co-authored-by: bob <[email protected]>
Co-authored-by: Ensteinjun <[email protected]>
Co-authored-by: nanaya <[email protected]>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Co-authored-by: Eric-2369 <[email protected]>
Co-authored-by: Yuri Filipe <[email protected]>
Co-authored-by: durian <[email protected]>
  • Loading branch information
1 parent abc2dee commit 2c4d5b2
Show file tree
Hide file tree
Showing 66 changed files with 1,556 additions and 1,213 deletions.
29 changes: 2 additions & 27 deletions .env.template
Original file line number Diff line number Diff line change
@@ -1,33 +1,8 @@

# Your openai api key. (required)
OPENAI_API_KEY=sk-xxxx

# Access passsword, separated by comma. (optional)
CODE=your-password

# You can start service behind a proxy
PROXY_URL=http://localhost:7890

# Override openai api request base url. (optional)
# Default: https://api.openai.com
# Examples: http://your-openai-proxy.com
BASE_URL=
# biochatter server url. (required)
BASE_URL= http://127.0.0.1:5000

# Specify OpenAI organization ID.(optional)
# Default: Empty
OPENAI_ORG_ID=

# (optional)
# Default: Empty
# If you do not want users to input their own API key, set this value to 1.
HIDE_USER_API_KEY=

# (optional)
# Default: Empty
# If you do not want users to use GPT-4, set this value to 1.
DISABLE_GPT4=

# (optional)
# Default: Empty
# If you do not want users to query balance, set this value to 1.
HIDE_BALANCE_QUERY=
4 changes: 2 additions & 2 deletions .github/workflows/app.yml
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ jobs:
- name: setup node
uses: actions/setup-node@v3
with:
node-version: 16
node-version: 18
- name: get version
run: echo "PACKAGE_VERSION=$(node -p "require('./src-tauri/tauri.conf.json').package.version")" >> $GITHUB_ENV
- name: create release
Expand Down Expand Up @@ -59,7 +59,7 @@ jobs:
- name: setup node
uses: actions/setup-node@v3
with:
node-version: 16
node-version: 18
- name: install Rust stable
uses: dtolnay/rust-toolchain@stable
with:
Expand Down
51 changes: 43 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@

<h1 align="center">ChatGPT Next Web</h1>

English / [简体中文](./README_CN.md) / [日本語](./README_JA.md)
English / [简体中文](./README_CN.md)

One-Click to get well-designed cross-platform ChatGPT web UI.

Expand Down Expand Up @@ -62,6 +62,7 @@ One-Click to get well-designed cross-platform ChatGPT web UI.
- 🚀 v2.0 is released, now you can create prompt templates, turn your ideas into reality! Read this: [ChatGPT Prompt Engineering Tips: Zero, One and Few Shot Prompting](https://www.allabtai.com/prompt-engineering-tips-zero-one-and-few-shot-prompting/).
- 🚀 v2.7 let's share conversations as image, or share to ShareGPT!
- 🚀 v2.8 now we have a client that runs across all platforms!
- 🚀 v2.9.11 you can use azure endpoint now.

## 主要功能

Expand All @@ -74,7 +75,7 @@ One-Click to get well-designed cross-platform ChatGPT web UI.
- 预制角色功能(面具),方便地创建、分享和调试你的个性化对话
- 海量的内置 prompt 列表,来自[中文](https://github.com/PlexPt/awesome-chatgpt-prompts-zh)[英文](https://github.com/f/awesome-chatgpt-prompts)
- 自动压缩上下文聊天记录,在节省 Token 的同时支持超长对话
- 多国语言支持:English, 简体中文, 繁体中文, 日本語, Español, Italiano, Türkçe, Deutsch, Tiếng Việt, Русский, Čeština
- 多国语言支持:English, 简体中文, 繁体中文, 日本語, Español, Italiano, Türkçe, Deutsch, Tiếng Việt, Русский, Čeština, 한국어, Indonesia
- 拥有自己的域名?好上加好,绑定后即可在任何地方**无障碍**快速访问

## 开发计划
Expand All @@ -93,6 +94,7 @@ One-Click to get well-designed cross-platform ChatGPT web UI.
- 💡 想要更方便地随时随地使用本项目?可以试下这款桌面插件:https://github.com/mushan0x0/AI0x0.com
- 🚀 v2.7 现在可以将会话分享为图片了,也可以分享到 ShareGPT 的在线链接。
- 🚀 v2.8 发布了横跨 Linux/Windows/MacOS 的体积极小的客户端。
- 🚀 v2.9.11 现在可以使用自定义 Azure 服务了。

## Get Started

Expand Down Expand Up @@ -153,14 +155,14 @@ After adding or modifying this environment variable, please redeploy the project

> [简体中文 > 如何配置 api key、访问密码、接口代理](./README_CN.md#环境变量)
### `OPENAI_API_KEY` (required)

Your openai api key.

### `CODE` (optional)

Access password, separated by comma.

### `OPENAI_API_KEY` (required)

Your openai api key, join multiple api keys with comma.

### `BASE_URL` (optional)

> Default: `https://api.openai.com`
Expand All @@ -173,6 +175,20 @@ Override openai api request base url.

Specify OpenAI organization ID.

### `AZURE_URL` (optional)

> Example: https://{azure-resource-url}/openai/deployments/{deploy-name}
Azure deploy url.

### `AZURE_API_KEY` (optional)

Azure Api Key.

### `AZURE_API_VERSION` (optional)

Azure Api Version, find it at [Azure Documentation](https://learn.microsoft.com/en-us/azure/ai-services/openai/reference#chat-completions).

### `HIDE_USER_API_KEY` (optional)

> Default: Empty
Expand All @@ -185,11 +201,26 @@ If you do not want users to input their own API key, set this value to 1.
If you do not want users to use GPT-4, set this value to 1.

### `HIDE_BALANCE_QUERY` (optional)
### `ENABLE_BALANCE_QUERY` (optional)

> Default: Empty
If you do want users to query balance, set this value to 1, or you should set it to 0.

### `DISABLE_FAST_LINK` (optional)

> Default: Empty
If you do not want users to query balance, set this value to 1.
If you want to disable parse settings from url, set this to 1.

### `CUSTOM_MODELS` (optional)

> Default: Empty
> Example: `+llama,+claude-2,-gpt-3.5-turbo,gpt-4-1106-preview=gpt-4-turbo` means add `llama, claude-2` to model list, and remove `gpt-3.5-turbo` from list, and display `gpt-4-1106-preview` as `gpt-4-turbo`.
To control custom models, use `+` to add a custom model, use `-` to hide a model, use `name=displayName` to customize model name, separated by comma.

User `-all` to disable all default models, `+all` to enable all default models.

## Requirements

Expand Down Expand Up @@ -314,6 +345,10 @@ If you want to add a new translation, read this [document](./docs/translation.md
[@synwith](https://github.com/synwith)
[@piksonGit](https://github.com/piksonGit)
[@ouyangzhiping](https://github.com/ouyangzhiping)
[@wenjiavv](https://github.com/wenjiavv)
[@LeXwDeX](https://github.com/LeXwDeX)
[@Licoy](https://github.com/Licoy)
[@shangmin2009](https://github.com/shangmin2009)

### Contributor

Expand Down
34 changes: 30 additions & 4 deletions README_CN.md
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,7 @@ code1,code2,code3
### `OPENAI_API_KEY` (必填项)

OpanAI 密钥,你在 openai 账户页面申请的 api key。
OpanAI 密钥,你在 openai 账户页面申请的 api key,使用英文逗号隔开多个 key,这样可以随机轮询这些 key

### `CODE` (可选)

Expand All @@ -90,6 +90,20 @@ OpenAI 接口代理 URL,如果你手动配置了 openai 接口代理,请填

指定 OpenAI 中的组织 ID。

### `AZURE_URL` (可选)

> 形如:https://{azure-resource-url}/openai/deployments/{deploy-name}
Azure 部署地址。

### `AZURE_API_KEY` (可选)

Azure 密钥。

### `AZURE_API_VERSION` (可选)

Azure Api 版本,你可以在这里找到:[Azure 文档](https://learn.microsoft.com/en-us/azure/ai-services/openai/reference#chat-completions)

### `HIDE_USER_API_KEY` (可选)

如果你不想让用户自行填入 API Key,将此环境变量设置为 1 即可。
Expand All @@ -98,9 +112,20 @@ OpenAI 接口代理 URL,如果你手动配置了 openai 接口代理,请填

如果你不想让用户使用 GPT-4,将此环境变量设置为 1 即可。

### `HIDE_BALANCE_QUERY` (可选)
### `ENABLE_BALANCE_QUERY` (可选)

如果你不想让用户查询余额,将此环境变量设置为 1 即可。
如果你想启用余额查询功能,将此环境变量设置为 1 即可。

### `DISABLE_FAST_LINK` (可选)

如果你想禁用从链接解析预制设置,将此环境变量设置为 1 即可。

### `CUSTOM_MODELS` (可选)

> 示例:`+qwen-7b-chat,+glm-6b,-gpt-3.5-turbo,gpt-4-1106-preview=gpt-4-turbo` 表示增加 `qwen-7b-chat``glm-6b` 到模型列表,而从列表中删除 `gpt-3.5-turbo`,并将 `gpt-4-1106-preview` 模型名字展示为 `gpt-4-turbo`
> 如果你想先禁用所有模型,再启用指定模型,可以使用 `-all,+gpt-3.5-turbo`,则表示仅启用 `gpt-3.5-turbo`
用来控制模型列表,使用 `+` 增加一个模型,使用 `-` 来隐藏一个模型,使用 `模型名=展示名` 来自定义模型的展示名,用英文逗号隔开。

## 开发

Expand All @@ -114,7 +139,7 @@ OpenAI 接口代理 URL,如果你手动配置了 openai 接口代理,请填
OPENAI_API_KEY=<your api key here>
# 中国大陆用户,可以使用本项目自带的代理进行开发,你也可以自由选择其他代理地址
BASE_URL=https://nb.nextweb.fun/api/proxy
BASE_URL=https://b.nextweb.fun/api/proxy
```

### 本地开发
Expand Down Expand Up @@ -181,6 +206,7 @@ bash <(curl -s https://raw.githubusercontent.com/Yidadaa/ChatGPT-Next-Web/main/s
[见项目贡献者列表](https://github.com/Yidadaa/ChatGPT-Next-Web/graphs/contributors)

### 相关项目

- [one-api](https://github.com/songquanpeng/one-api): 一站式大模型额度管理平台,支持市面上所有主流大语言模型

## 开源协议
Expand Down
Loading

0 comments on commit 2c4d5b2

Please sign in to comment.