Severian commited on
Commit
e79dce8
Β·
1 Parent(s): 660901a

Delete README.md

Browse files
Files changed (1) hide show
  1. README.md +0 -133
README.md DELETED
@@ -1,133 +0,0 @@
1
- **Expert**: Linguist and Technology Expert
2
- **Objective**: Provide a verbatim English translation of the given Chinese text.
3
- **Assumptions**: The text relates to the features and configuration of a ChatGPT-like project with various plugins and deployment instructions.
4
-
5
- ### Accurate English Translation of Chinese Text:
6
-
7
- **Main Features**
8
- Apart from plugin tools, it maintains consistency with the original project ChatGPT-Next-Web's main features. Plugin functionality implemented based on LangChain currently supports the following plugins, with more to be added in the future:
9
- - Search
10
- - SerpAPI
11
- - BingSerpAPI
12
- - DuckDuckGo
13
- - Calculation
14
- - Calculator
15
- - Web Requests
16
- - WebBrowser
17
- - Others
18
- - Wiki
19
- - DALL-E 3
20
- - DALL-E 3 plugin requires R2 storage configuration, please refer to the Cloudflare R2 service configuration guide for setup.
21
- - StableDiffusion
22
- - This plugin is currently in a test version and may undergo significant changes in the future, please use with caution.
23
- - Using this plugin requires certain expertise; issues related to Stable Diffusion itself are not covered in this project. If you decide to use this plugin, please configure it following the Stable Diffusion Plugin Configuration Guide.
24
- - StableDiffusion plugin requires R2 storage configuration, please refer to the Cloudflare R2 service configuration guide for setup.
25
- - Arxiv
26
-
27
- **Development Plans**
28
- - Support DuckDuckGo as the default search engine.
29
- - When SERPAPI_API_KEY is configured, SerpAPI is used as the search plugin by default. If not configured, DuckDuckGo is used by default.
30
- - When BING_SEARCH_API_KEY is configured, BingSerpAPI is used as the search plugin by default. If not configured, DuckDuckGo is used by default.
31
- - Priority: SerpAPI > BingSerpAPI > DuckDuckGo
32
- - Development of the plugin list page.
33
- - Support for toggling specific plugins.
34
- - Support for adding custom plugins.
35
- - Support for Agent parameter configuration (agentType, maxIterations, returnIntermediateSteps, etc.).
36
- - Support for ChatSession level plugin functionality toggle.
37
- - Plugin toggle appears only when using models other than 0301 and 0314; other models default to closed status, and the toggle will not display.
38
-
39
- **Known Issues**
40
- - When using plugins, you need to switch to the 0613 version model, such as gpt-3.5-turbo-0613.
41
- - Attempts to use agents like chat-conversational-react-description with plugins are not ideal, and support for other versions of the model is no longer considered.
42
- - Limitations modified so that models other than 0301 and 0314 can call plugins. #10
43
- - SERPAPI_API_KEY is currently required, but support for using DuckDuckGo to replace the search plugin will be added later.
44
- - Agent does not support custom interface addresses.
45
- - Plugins may fail in some scenarios.
46
- - Issue occurs due to parameter errors when using the Calculator for calculations, currently unable to intervene.
47
- - No feedback after plugin call failure.
48
-
49
- **Latest Updates**
50
- - πŸš€ v2.9.6 version released.
51
- - πŸš€ v2.9.5 official version released.
52
- - πŸš€ v2.9.1-plugin-preview preview version released.
53
-
54
- **Getting Started**
55
- - Prepare your OpenAI API Key.
56
- - Click the button on the right to start deployment: Deploy with Vercel, log in directly with your Github account, remember to fill in the API Key and page access password CODE on the environment variable page.
57
- - After deployment, you can start using it.
58
- - (Optional) Bind a custom domain: DNS of the domain assigned by Vercel may be contaminated in some areas, binding a custom domain can directly connect.
59
-
60
- **FAQ**
61
- - Simplified Chinese > Frequently Asked Questions
62
- - English > FAQ
63
- - Azure OpenAI
64
-
65
- **Configure Page Access Password**
66
- After configuring the password, users need to manually fill in the access code on the settings page to chat normally, otherwise, they will be prompted with an unauthorized status message.
67
- Warning: Please set the password long enough, preferably more than 7 characters, to prevent brute force attacks.
68
- This project provides limited permission control functionality, please add an environment variable named CODE on the Vercel project control panel's environment variable page, with values separated by English commas for custom passwords:
69
- - code1,code2,code3
70
- After adding or modifying this environment variable, please redeploy the project to make the changes take effect.
71
-
72
- **Environment Variables**
73
- Most of the project's configuration items are set through environment variables, tutorial: How to modify Vercel environment variables.
74
-
75
- - OPENAI_API_KEY (mandatory)
76
- - OpenAI key, your api key applied on the openai account page.
77
- - SERPAPI_API_KEY (optional)
78
- - SerpApi: Google Search API
79
- - BING_SEARCH_API_KEY (optional)
80
-
81
-
82
- - Web Search API | Microsoft Bing
83
- - CHOOSE_SEARCH_ENGINE (optional)
84
- - This item is for direct connection search engines, avoiding the trouble of small api trial amounts, but may not work due to network issues.
85
- - Optional items include:
86
- - google
87
- - baidu
88
- - CODE (optional)
89
- - Access password, optional, multiple passwords can be separated by commas.
90
- - Warning: If this item is not filled, anyone can directly use your deployed website, which may lead to rapid depletion of your token, it's recommended to fill this option.
91
- - BASE_URL (optional)
92
- - Default: https://api.openai.com
93
- - Examples: http://your-openai-proxy.com
94
- - OpenAI interface proxy URL, if you have manually configured an openai interface proxy, please fill this option.
95
- - If encountering SSL certificate issues, set the BASE_URL protocol to http.
96
- - OPENAI_ORG_ID (optional)
97
- - Specifies the organization ID in OpenAI.
98
- - HIDE_USER_API_KEY (optional)
99
- - If you don't want users to fill in the API Key themselves, set this environment variable to 1.
100
- - DISABLE_GPT4 (optional)
101
- - If you don't want users to use GPT-4, set this environment variable to 1.
102
- - HIDE_BALANCE_QUERY (optional)
103
- - If you don't want users to query the balance, set this environment variable to 1.
104
- - R2_ACCOUNT_ID (optional)
105
- - Cloudflare R2 account ID, required for using the DALL-E plugin.
106
- - R2_ACCESS_KEY_ID (optional)
107
- - Cloudflare R2 access key ID, required for using the DALL-E plugin.
108
- - R2_SECRET_ACCESS_KEY (optional)
109
- - Cloudflare R2 secret access key, required for using the DALL-E plugin.
110
- - R2_BUCKET (optional)
111
- - Cloudflare R2 Bucket name, required for using the DALL-E plugin.
112
-
113
- **Deployment**
114
- Container Deployment (Recommended)
115
- Docker version needs to be 20 or above, otherwise, it will prompt that the image is not found.
116
- ⚠️ Note: The docker version will most of the time lag behind the latest version by 1 to 2 days, so there will be continuous prompts for "updates available", which is normal.
117
-
118
- docker run -d -p 3000:3000 \
119
- -e OPENAI_API_KEY="sk-xxxx" \
120
- -e CODE="page access password" \
121
- gosuto/chatgpt-next-web-langchain
122
- You can also specify a proxy:
123
-
124
- docker run -d -p 3000:3000 \
125
- -e OPENAI_API_KEY="sk-xxxx" \
126
- -e CODE="page access password" \
127
- --net=host \
128
- -e PROXY_URL="http://127.0.0.1:7890" \
129
- gosuto/chatgpt-next-web-langchain
130
- If your local proxy requires a username and password, use:
131
-
132
- -e PROXY_URL="http://127.0.0.1:7890 user password"
133
- If you need to specify other environment variables, please add -e environment variable=environment variable value to the above command.