COST_ON_INLET feature test passed

Author: VariantConst

.env.example

@@ -11,6 +11,7 @@ API_KEY=your-api-key-here # Used for authentication when sending requests to Mon
 # DEFAULT_MODEL_OUTPUT_PRICE=60  # Default output price for models
 # DEFAULT_MODEL_PER_MSG_PRICE=-1 # Default price per message for models, -1 means charging by tokens
 # INIT_BALANCE=0 # Initial balance for users, optional
+# COST_ON_INLET=0 # Pre-deduction amount on inlet, can be a fixed number (e.g. 0.1) or model-specific (e.g. gpt-4:0.32,gpt-3.5:0.01)
 
 # PostgreSQL Database Configuration (Optional, configure these if using external database)
 # POSTGRES_HOST=

README.md

@@ -43,14 +43,14 @@ sudo docker compose up -d
 
 ### Optional
 
-| Variable Name               | Description                                           | Default Value |
-| --------------------------- | ----------------------------------------------------- | ------------- |
-| DEFAULT_MODEL_INPUT_PRICE   | Default model input price, in USD per million tokens  | `60`          |
-| DEFAULT_MODEL_OUTPUT_PRICE  | Default model output price, in USD per million tokens | `60`          |
-| DEFAULT_MODEL_PER_MSG_PRICE | Default model price for each message, in USD          | `-1`          |
-| INIT_BALANCE                | Initial user balance                                  | `0`           |
+| Variable Name               | Description                                                                                                                                 | Default Value |
+| --------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------- | ------------- |
+| DEFAULT_MODEL_INPUT_PRICE   | Default model input price, in USD per million tokens                                                                                        | `60`          |
+| DEFAULT_MODEL_OUTPUT_PRICE  | Default model output price, in USD per million tokens                                                                                       | `60`          |
+| DEFAULT_MODEL_PER_MSG_PRICE | Default model price for each message, in USD                                                                                                | `-1`          |
+| INIT_BALANCE                | Initial user balance                                                                                                                        | `0`           |
+| COST_ON_INLET               | Pre-deduction amount on inlet. Can be a fixed number for all models (e.g. `0.1`), or model-specific format (e.g. `gpt-4:0.32,gpt-3.5:0.01`) | `0`           |
 
 <h2>Gallery</h2>
 
 ![](https://github.com/user-attachments/assets/63f23bfd-f271-41e8-a71c-2016be1d501a)
-

app/api/v1/outlet/route.ts

@@ -3,6 +3,7 @@ import { encode } from "gpt-tokenizer/model/gpt-4";
 import { Pool, PoolClient } from "pg";
 import { createClient } from "@vercel/postgres";
 import { query, getClient } from "@/lib/db/client";
+import { getModelInletCost } from "@/lib/utils/inlet-cost";
 
 const isVercel = process.env.VERCEL === "1";
 
@@ -128,10 +129,12 @@ export async function POST(req: Request) {
     }
 
     // 获取 inlet 时预扣的费用
-    const inletCost = data.inlet_cost || 0;
+    const inletCost = getModelInletCost(modelId);
+    console.log("outlet时获取inletCost:", inletCost);
 
     // 实际需要扣除的费用 = 总费用 - 预扣费用
     const actualCost = totalCost - inletCost;
+    console.log("outlet时实际需要扣除的费用:", actualCost);
 
     // 获取并更新用户余额
     const userResult = await query(
@@ -150,7 +153,7 @@ export async function POST(req: Request) {
     }
 
     const newBalance = Number(userResult.rows[0].balance);
-
+    console.log("outlet时获取newBalance:", newBalance);
     if (newBalance > 999999.9999) {
       throw new Error("Balance exceeds maximum allowed value");
     }

docker-compose.yml

@@ -1,19 +1,17 @@
 services:
   app:
-    image: docker.io/variantconst/openwebui-monitor:latest
+    #image: docker.io/variantconst/openwebui-monitor:latest
+    build: .
     ports:
       - "7878:3000"
+    env_file:
+      - .env
     environment:
       - POSTGRES_HOST=${POSTGRES_HOST:-db}
       - POSTGRES_PORT=${POSTGRES_PORT:-5432}
       - POSTGRES_USER=${POSTGRES_USER:-postgres}
       - POSTGRES_PASSWORD=${POSTGRES_PASSWORD:-openwebui}
       - POSTGRES_DATABASE=${POSTGRES_DATABASE:-openwebui_monitor}
-      - OPENWEBUI_DOMAIN=${OPENWEBUI_DOMAIN}
-      - OPENWEBUI_API_KEY=${OPENWEBUI_API_KEY}
-      - API_KEY=${API_KEY}
-      - INIT_BALANCE=${INIT_BALANCE:-1}
-      - ACCESS_TOKEN=${ACCESS_TOKEN}
     depends_on:
       db:
         condition: service_healthy

lib/utils/inlet-cost.ts

@@ -29,6 +29,9 @@ function parseInletCostConfig(config: string | undefined): ModelInletCost {
 }
 
 export function getModelInletCost(modelId: string): number {
+  if (!process.env.COST_ON_INLET) {
+    return 0;
+  }
   const costConfig = parseInletCostConfig(process.env.COST_ON_INLET);
   return costConfig[modelId] ?? costConfig["default"] ?? 0;
 }

middleware.ts

@@ -15,24 +15,30 @@ export async function middleware(request: NextRequest) {
   ) {
     // API 请求验证
     if (!API_KEY) {
-      console.error("未设置 API_KEY 环境变量");
-      return NextResponse.json({ error: "服务器配置错误" }, { status: 500 });
+      console.error("API Key is not set");
+      return NextResponse.json(
+        { error: "Server configuration error" },
+        { status: 500 }
+      );
     }
 
     const authHeader = request.headers.get("authorization");
     const providedKey = authHeader?.replace("Bearer ", "");
 
     if (!providedKey || providedKey !== API_KEY) {
-      console.log("API密钥无效");
-      return NextResponse.json({ error: "无效的API密钥" }, { status: 401 });
+      console.log("Invalid API key");
+      return NextResponse.json({ error: "Invalid API key" }, { status: 401 });
     }
 
     return NextResponse.next();
   } else if (!pathname.startsWith("/api/")) {
     // 页面访问验证
     if (!ACCESS_TOKEN) {
-      console.error("未设置 ACCESS_TOKEN 环境变量");
-      return NextResponse.json({ error: "服务器配置错误" }, { status: 500 });
+      console.error("ACCESS_TOKEN is not set");
+      return NextResponse.json(
+        { error: "Server configuration error" },
+        { status: 500 }
+      );
     }
 
     // 如果是令牌验证页面，直接允许访问

resources/tutorials/en/deployment_guide.md

@@ -18,6 +18,9 @@ OpenWebUI Monitor is designed to work alongside [OpenWebUI](https://github.com/o
 - `API_KEY`: This is the key you'll use later in the OpenWebUI function plugin configuration as the `Api Key`. Use a strong password generator like [1Password](https://1password.com/) to create this. The length must be less than 56 characters.
 - `ACCESS_TOKEN`: A password required to access the OpenWebUI Monitor webpage.
 - `INIT_BALANCE` (optional): The initial balance for users, e.g., `1.14`.
+- `COST_ON_INLET` (optional): Pre-deduction amount when a chat starts. Can be configured as:
+  - A fixed number for all models, e.g., `0.1`
+  - Model-specific format, e.g., `gpt-4:0.32,gpt-3.5:0.01`
 
 3. Navigate to the **Storage** section of the project and create or connect to a Neon Postgres database.
    <img width="1138" alt="image" src="https://github.com/user-attachments/assets/365e6dea-5d25-42ab-9421-766e2633f389">

resources/tutorials/zh-cn/README_zh.md

@@ -43,14 +43,14 @@ sudo docker compose up -d
 
 ### 可选
 
-| 变量名                      | 说明                                          | 默认值 |
-| --------------------------- | --------------------------------------------- | ------ |
-| DEFAULT_MODEL_INPUT_PRICE   | 默认模型输入价格，单位为元/百万 tokens        | `60`   |
-| DEFAULT_MODEL_OUTPUT_PRICE  | 默认模型输出价格，单位为元/百万 tokens        | `60`   |
-| DEFAULT_MODEL_PER_MSG_PRICE | 模型默认每条消息价格，设为负数将按 token 计费 | `-1`   |
-| INIT_BALANCE                | 用户初始余额                                  | `0`    |
+| 变量名                      | 说明                                                                                                                       | 默认值 |
+| --------------------------- | -------------------------------------------------------------------------------------------------------------------------- | ------ |
+| DEFAULT_MODEL_INPUT_PRICE   | 默认模型输入价格，单位为元/百万 tokens                                                                                     | `60`   |
+| DEFAULT_MODEL_OUTPUT_PRICE  | 默认模型输出价格，单位为元/百万 tokens                                                                                     | `60`   |
+| DEFAULT_MODEL_PER_MSG_PRICE | 模型默认每条消息价格，设为负数将按 token 计费                                                                              | `-1`   |
+| INIT_BALANCE                | 用户初始余额                                                                                                               | `0`    |
+| COST_ON_INLET               | inlet 时的预扣费金额。可以是所有模型统一的固定数字（如 `0.1`），也可以是针对不同模型的配置（如 `gpt-4:0.32,gpt-3.5:0.01`） | `0`    |
 
 <h2>Gallery</h2>
 
 ![](https://github.com/user-attachments/assets/2777c1fc-a8c6-4397-9665-a6a559d4bab1)
-

resources/tutorials/zh-cn/deployment_guide_zh.md

@@ -18,6 +18,9 @@ OpenWebUI Monitor 是搭配 [OpenWebUI](https://github.com/open-webui/open-webui
 - `API_KEY`：这是你稍后要填写在 OpenWebUI 函数插件中 `Api Key` 的，用于向 OpenWebUI Monitor 服务器发送请求的鉴权。建议使用 [1Password](https://1password.com/) 生成一个少于 56 个字符的强密码。
 - `ACCESS_TOKEN`：访问 OpenWebUI Monitor 网页时要输入的访问密钥
 - `INIT_BALANCE`（可选）：用户初始余额，例如 `1.14`
+- `COST_ON_INLET`（可选）：开始对话时的预扣费金额。可以配置为：
+  - 所有模型统一的固定数字，例如 `0.1`
+  - 针对不同模型的配置，例如 `gpt-4:0.32,gpt-3.5:0.01`
 
 3. 前往项目中的 Storage 选项，Create 或者 Connect 到一个 Neon Postgres 数据库<img width="1138" alt="image" src="https://github.com/user-attachments/assets/365e6dea-5d25-42ab-9421-766e2633f389">