修复前端API用量查询显示功能 (#848)

* fix billing_data

* 整合sensitive_id的获取方式到config.py中及未填写UI提示

* sensitive_id支持环境变量

* 调整ui中获取余额失败的提示词

* refactor: 整理config_example.json

顺便清理了palm的key

* 加入 Google PaLM API Key 配置项

* i18n: 更新用量获取失败翻译

---------

Co-authored-by: Keldos <i@keldos.me>
Co-authored-by: Chuan Hu <51039745+GaiZhenbiao@users.noreply.github.com>

config_example.json

@@ -1,42 +1,40 @@
 {
-    // 你的OpenAI API Key，一般必填，
-    // 若缺省填为 "openai_api_key": "" 则必须再在图形界面中填入API Key
-    "openai_api_key": "",
-    "google_palm_api_key": "",
-    "xmchat_api_key": "",
-    "usage_limit": 120, // API Key的当月限额，单位：美元
-    // 你的xmchat API Key，与OpenAI API Key不同
-    // MiniMax的APIKey（见账户管理页面 https://api.minimax.chat/basic-information）和Group ID，用于MiniMax对话模型
-    "minimax_api_key": "",
-    "minimax_group_id": "",
-    "language": "auto",
-    // 支持自定义OpenAI API Base
-    // "openai_api_base": "https://api.openai.com",
-    // 如果使用代理，请取消注释下面的两行，并替换代理URL
-    // "https_proxy": "http://127.0.0.1:1079",
-    // "http_proxy": "http://127.0.0.1:1079",
+    // 各配置具体说明，见 [https://github.com/GaiZhenbiao/ChuanhuChatGPT/wiki/使用教程#配置-configjson]
+
+    //== API 配置 ==
+    "openai_api_key": "", // 你的 OpenAI API Key，一般必填，若空缺则需在图形界面中填入API Key
+    "sensitive_id": "", // 你 OpenAI 账户的 Sensitive ID，用于查询 API 用量
+    "usage_limit": 120, // 该 OpenAI API Key 的当月限额，单位：美元
+    "google_palm_api_key": "", // 你的 Google PaLM API Key，用于 Google PaLM 对话模型
+    "xmchat_api_key": "", // 你的 xmchat API Key，用于 XMChat 对话模型
+    "minimax_api_key": "", // 你的 MiniMax API Key，用于 MiniMax 对话模型
+    "minimax_group_id": "", // 你的 MiniMax Group ID，用于 MiniMax 对话模型
+
+    //== 基础配置 ==
+    "language": "auto", // 界面语言，可选"auto", "zh-CN", "en-US", "ja-JP", "ko-KR"
     "users": [], // 用户列表，[[用户名1, 密码1], [用户名2, 密码2], ...]
     "local_embedding": false, //是否在本地编制索引
     "hide_history_when_not_logged_in": false, //未登录情况下是否不展示对话历史
     "check_update": true, //是否启用检查更新
     "default_model": "gpt-3.5-turbo", // 默认模型
 
-    //川虎助理设置
-    "default_chuanhu_assistant_model": "gpt-4", //川虎助理使用的模型，可选gpt-3.5-turbo或者gpt-4
+    //== 川虎助理设置 ==
+    "default_chuanhu_assistant_model": "gpt-4", //川虎助理使用的模型，可选gpt-3.5-turbo或者gpt-4等
     "GOOGLE_CSE_ID": "", //谷歌搜索引擎ID，用于川虎助理Pro模式，获取方式请看 https://stackoverflow.com/questions/37083058/programmatically-searching-google-in-python-using-custom-search
     "GOOGLE_API_KEY": "", //谷歌API Key，用于川虎助理Pro模式
     "WOLFRAM_ALPHA_APPID": "", //Wolfram Alpha API Key，用于川虎助理Pro模式，获取方式请看 https://products.wolframalpha.com/api/
     "SERPAPI_API_KEY": "", //SerpAPI API Key，用于川虎助理Pro模式，获取方式请看 https://serpapi.com/
 
-    "latex_option": "default", // latex 公式显示方式，可选"default", "strict", "all"或者"disabled"
+    //== 文档处理与显示 ==
+    "latex_option": "default", // LaTeX 公式渲染策略，可选"default", "strict", "all"或者"disabled"
     "advance_docs": {
         "pdf": {
-            // 是否认为PDF是双栏的
-            "two_column": false,
-            // 是否使用OCR识别PDF中的公式
-            "formula_ocr": true
+            "two_column": false, // 是否认为PDF是双栏的
+            "formula_ocr": true // 是否使用OCR识别PDF中的公式
         }
     },
+
+    //== 高级配置 ==
     // 是否多个API Key轮换使用
     "multi_api_key": false,
     "api_key_list": [
@@ -44,7 +42,12 @@
         "sk-xxxxxxxxxxxxxxxxxxxxxxxx2",
         "sk-xxxxxxxxxxxxxxxxxxxxxxxx3"
     ],
-    // 如果使用自定义端口、自定义ip，请取消注释并替换对应内容
+    // 自定义OpenAI API Base
+    // "openai_api_base": "https://api.openai.com",
+    // 自定义使用代理（请替换代理URL）
+    // "https_proxy": "http://127.0.0.1:1079",
+    // "http_proxy": "http://127.0.0.1:1079",
+    // 自定义端口、自定义ip（请替换对应内容）
     // "server_name": "0.0.0.0",
     // "server_port": 7860,
     // 如果要share到gradio，设置为true

locale/en_US.json

@@ -41,7 +41,7 @@
     "在这里输入API-Host...": "Type in API-Host here...",
     "🔄 切换API地址": "🔄 Switch API Address",
     "在这里输入代理地址...": "Type in proxy address here...",
-    "代理地址（示例：http://127.0.0.1:10809）": "Proxy address (example: http://127.0.0.1:10809）",
+    "代理地址（示例：http://127.0.0.1:10809）": "Proxy address (example: http://127.0.0.1:10809)",
     "🔄 设置代理地址": "🔄 Set Proxy Address",
     "🔙 恢复网络默认设置": "🔙 Reset Network Settings",
     "🔄 检查更新...": "🔄 Check for Update...",
@@ -52,8 +52,10 @@
     "川虎Chat 🚀": "Chuanhu Chat 🚀",
     "开始实时传输回答……": "Start streaming output...",
     "Token 计数: ": "Token Count: ",
-    "，本次对话累计消耗了 ": "，Total cost for this dialogue is ",
+    "，本次对话累计消耗了 ": ", Total cost for this dialogue is ",
     "**获取API使用情况失败**": "**Failed to get API usage**",
+    "**获取API使用情况失败**，需在填写`config.json`中正确填写sensitive_id": "**Failed to get API usage**, correct sensitive_id needed in `config.json`",
+    "**获取API使用情况失败**，sensitive_id错误或已过期": "**Failed to get API usage**, wrong or expired sensitive_id",
     "**本月使用金额** ": "**Monthly usage** ",
     "本月使用金额": "Monthly usage",
     "获取API使用情况失败:": "Failed to get API usage:",

locale/ja_JP.json

@@ -54,6 +54,8 @@
     "Token 计数: ": "Token数: ",
     "，本次对话累计消耗了 ": ", 今の会話で消費合計 ",
     "**获取API使用情况失败**": "**API使用状況の取得に失敗しました**",
+    "**获取API使用情况失败**，需在填写`config.json`中正确填写sensitive_id": "**API使用状況の取得に失敗しました**、`config.json`に正しい`sensitive_id`を入力する必要があります",
+    "**获取API使用情况失败**，sensitive_id错误或已过期": "**API使用状況の取得に失敗しました**、sensitive_idが間違っているか、期限切れです",
     "**本月使用金额** ": "**今月の使用料金** ",
     "本月使用金额": "今月の使用料金",
     "获取API使用情况失败:": "API使用状況の取得に失敗しました:",

locale/ko_KR.json

@@ -55,6 +55,8 @@
     "Token 计数: ": "토큰 수: ",
     "，本次对话累计消耗了 ": "，이 대화의 전체 비용은 ",
     "**获取API使用情况失败**": "**API 사용량 가져오기 실패**",
+    "**获取API使用情况失败**，需在填写`config.json`中正确填写sensitive_id": "**API 사용량 가져오기 실패**. `config.json`에 올바른 `sensitive_id`를 입력해야 합니다",
+    "**获取API使用情况失败**，sensitive_id错误或已过期": "**API 사용량 가져오기 실패**. sensitive_id가 잘못되었거나 만료되었습니다",
     "**本月使用金额** ": "**이번 달 사용금액** ",
     "本月使用金额": "이번 달 사용금액",
     "获取API使用情况失败:": "API 사용량 가져오기 실패:",

modules/config.py

@@ -11,6 +11,7 @@ from . import presets
 
 __all__ = [
     "my_api_key",
+    "sensitive_id",
     "authflag",
     "auth_list",
     "dockerflag",
@@ -37,6 +38,9 @@ if os.path.exists("config.json"):
 else:
     config = {}
 
+sensitive_id = config.get("sensitive_id", "")
+sensitive_id = os.environ.get("SENSITIVE_ID", sensitive_id)
+
 lang_config = config.get("language", "auto")
 language = os.environ.get("LANGUAGE", lang_config)
 

modules/models/models.py

@@ -24,7 +24,7 @@ from ..presets import *
 from ..index_func import *
 from ..utils import *
 from .. import shared
-from ..config import retrieve_proxy, usage_limit
+from ..config import retrieve_proxy, usage_limit, sensitive_id
 from modules import config
 from .base_model import BaseLLMModel, ModelType
 
@@ -87,7 +87,11 @@ class OpenAIClient(BaseLLMModel):
             try:
                 usage_data = self._get_billing_data(usage_url)
             except Exception as e:
-                logging.error(f"获取API使用情况失败:" + str(e))
+                logging.error(f"获取API使用情况失败: " + str(e))
+                if "Invalid authorization header" in str(e):
+                    return i18n("**获取API使用情况失败**，需在填写`config.json`中正确填写sensitive_id")
+                elif "Incorrect API key provided: sess" in str(e):
+                    return i18n("**获取API使用情况失败**，sensitive_id错误或已过期")
                 return i18n("**获取API使用情况失败**")
             # rounded_usage = "{:.5f}".format(usage_data["total_usage"] / 100)
             rounded_usage = round(usage_data["total_usage"] / 100, 5)
@@ -176,8 +180,9 @@ class OpenAIClient(BaseLLMModel):
     def _refresh_header(self):
         self.headers = {
             "Content-Type": "application/json",
-            "Authorization": f"Bearer {self.api_key}",
+            "Authorization": f"Bearer {sensitive_id}",
         }
+        
 
     def _get_billing_data(self, billing_url):
         with retrieve_proxy():