docs: update README.md

iuiaoin · Jul 20, 2023 · c965de3 · c965de3
1 parent d127634
commit c965de3
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -68,6 +68,8 @@ Then fill in the configuration in `config.json`, the following is the descriptio
 {
   "openai_api_key": "YOUR API SECRET KEY",             # Fill in your OpenAI API Key
   "model": "gpt-3.5-turbo",                            # ID of the model to use, support gpt-3.5-turbo, gpt-4, gpt-4-32k etc.
+  "use_azure_chatgpt": false,                          # Whether use Azure OpenAI API
+  "azure_deployment_id": "",                           # Azure model deployment name
   "role_desc": "You are a helpful assistant.",         # Role description as system prompt
   "session_expired_duration": 3600,                    # Session memory kept duration
   "max_tokens": 1000,                                  # Max tokens of characters for session memory

diff --git a/README_ZH.md b/README_ZH.md
@@ -68,6 +68,8 @@ pip install -r requirements.txt
 {
   "openai_api_key": "YOUR API SECRET KEY",             # 填入你的 OpenAI API Key
   "model": "gpt-3.5-turbo",                            # 要使用的模型 ID, 支持 gpt-3.5-turbo, gpt-4, gpt-4-32k 等
+  "use_azure_chatgpt": false,                          # 是否使用 Azure OpenAI API
+  "azure_deployment_id": "",                           # Azure 模型部署名称
   "role_desc": "You are a helpful assistant.",         # 角色描述, 作为系统 prompt
   "session_expired_duration": 3600,                    # 对话记忆的保留时长
   "max_tokens": 1000,                                  # 对话记忆字符的最大 token 数量