qing-client 0.0.22 → 0.0.23

package/lib/client/index.d.ts

@@ -6,6 +6,7 @@ import { TokenService } from "../service/TokenService";
 import { UserService } from "../service/UserService";
 import { AuditLogService } from "../service/AuditLogService";
 import { ProviderService } from "../service/ProviderService";
+import { UsageService } from "../service/UsageService";
 import { ClientConfig, UserContext } from "../types";
 export declare class Client {
     protected config: ClientConfig;
@@ -17,6 +18,7 @@ export declare class Client {
     readonly ai: AiService;
     readonly audit: AuditLogService;
     readonly provider: ProviderService;
+    readonly usage: UsageService;
     protected isFrontendMode: boolean;
     constructor(config: ClientConfig);
     setUserContext(context: UserContext): this;

package/lib/client/index.js

@@ -9,6 +9,7 @@ const TokenService_1 = require("../service/TokenService");
 const UserService_1 = require("../service/UserService");
 const AuditLogService_1 = require("../service/AuditLogService");
 const ProviderService_1 = require("../service/ProviderService");
+const UsageService_1 = require("../service/UsageService");
 class Client {
     constructor(config) {
         this.config = config;
@@ -21,6 +22,7 @@ class Client {
         this.ai = new AiService_1.AiService(config);
         this.audit = new AuditLogService_1.AuditLogService(config);
         this.provider = new ProviderService_1.ProviderService(config);
+        this.usage = new UsageService_1.UsageService(config);
     }
     // 后端模式：设置用户上下文
     setUserContext(context) {
@@ -33,6 +35,7 @@ class Client {
             this.ai.setUserContext(context);
             this.audit.setUserContext(context);
             this.provider.setUserContext(context);
+            this.usage.setUserContext(context);
         }
         else {
             console.warn("setUserContext() 仅在后端模式下有效");
@@ -50,6 +53,7 @@ class Client {
             this.ai.setProjectId(projectId);
             this.audit.setProjectId(projectId);
             this.provider.setProjectId(projectId);
+            this.usage.setProjectId(projectId);
         }
         else {
             console.warn("setProjectId() 仅在前端模式下有效");
@@ -67,6 +71,7 @@ class Client {
             this.ai.setAppId(appId);
             this.audit.setAppId(appId);
             this.provider.setAppId(appId);
+            this.usage.setAppId(appId);
         }
         else {
             console.warn("setAppId() 仅在前端模式下有效");
@@ -84,6 +89,7 @@ class Client {
             this.ai.setProjectAndApp(projectId, appId);
             this.audit.setProjectAndApp(projectId, appId);
             this.provider.setProjectAndApp(projectId, appId);
+            this.usage.setProjectAndApp(projectId, appId);
         }
         else {
             console.warn("setProjectAndApp() 仅在前端模式下有效");
@@ -100,6 +106,7 @@ class Client {
         await this.ai.setToken(token);
         await this.audit.setToken(token);
         await this.provider.setToken(token);
+        await this.usage.setToken(token);
     }
     // 清除认证令牌（两种模式都需要）
     async clearToken() {
@@ -111,6 +118,7 @@ class Client {
         await this.ai.clearToken();
         await this.audit.clearToken();
         await this.provider.clearToken();
+        await this.usage.clearToken();
     }
 }
 exports.Client = Client;

package/lib/index.d.ts

@@ -8,6 +8,7 @@ export { AigcService } from './service/AigcService';
 export { AuditLogService } from "./service/AuditLogService";
 export { FrontHostService } from "./service/FrontHostService";
 export { ProviderService } from "./service/ProviderService";
+export { UsageService } from "./service/UsageService";
 export * from './types';
 export * from './types/msg';
 export * from './types/token';
@@ -19,3 +20,4 @@ export * from "./types/aigc";
 export { ApiSuccessResponse, ApiErrorResponse, PaginatedResponse, ChatCompletionRequest, ChatCompletionResponse, ChatCompletionStreamResponse, ProviderListItem, ProviderDetail, ProviderModel, ModelListItem, ModelDetail, ModelConfig, CreateAssistantRequest, UpdateAssistantRequest, AssistantResponse, AssistantListResponse, SessionMessage, SessionResponse, SessionListResponse, SessionDetailResponse, SessionStatistics, PaginatedSessionMessageResponse, SessionMessageDetail, BatchDeleteSessionsResponse, AssistantModelsResponse, ModelInfoResponse, AddMessageRequest, SwitchModelRequest, CreateSessionRequest, UpdateSessionRequest } from "./types/ai";
 export { BaseClient } from './client/BaseClient';
 export * from "./types/provider";
+export * from "./types/usage";

package/lib/index.js

@@ -14,7 +14,7 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.BaseClient = exports.ProviderService = exports.FrontHostService = exports.AuditLogService = exports.AigcService = exports.FileService = exports.UserService = exports.TokenService = exports.MsgService = exports.AuthService = exports.Client = void 0;
+exports.BaseClient = exports.UsageService = exports.ProviderService = exports.FrontHostService = exports.AuditLogService = exports.AigcService = exports.FileService = exports.UserService = exports.TokenService = exports.MsgService = exports.AuthService = exports.Client = void 0;
 // 导出核心客户端类
 var client_1 = require("./client");
 Object.defineProperty(exports, "Client", { enumerable: true, get: function () { return client_1.Client; } });
@@ -37,6 +37,8 @@ var FrontHostService_1 = require("./service/FrontHostService");
 Object.defineProperty(exports, "FrontHostService", { enumerable: true, get: function () { return FrontHostService_1.FrontHostService; } });
 var ProviderService_1 = require("./service/ProviderService");
 Object.defineProperty(exports, "ProviderService", { enumerable: true, get: function () { return ProviderService_1.ProviderService; } });
+var UsageService_1 = require("./service/UsageService");
+Object.defineProperty(exports, "UsageService", { enumerable: true, get: function () { return UsageService_1.UsageService; } });
 // 导出所有类型定义
 __exportStar(require("./types"), exports);
 __exportStar(require("./types/msg"), exports);
@@ -49,3 +51,4 @@ __exportStar(require("./types/aigc"), exports);
 var BaseClient_1 = require("./client/BaseClient");
 Object.defineProperty(exports, "BaseClient", { enumerable: true, get: function () { return BaseClient_1.BaseClient; } });
 __exportStar(require("./types/provider"), exports);
+__exportStar(require("./types/usage"), exports);

package/lib/service/UsageService.d.ts

@@ -0,0 +1,20 @@
+import { BaseClient } from "../client/BaseClient";
+import { ClientConfig, RequestOptions } from "../types";
+import { UsageBaseQuery, UsageByProviderQuery, UsageDailyQuery, UsageSummaryResponse, UsageDailyResponse, UsageByModelResponse, UsageByProviderResponse, UsageByUserResponse, UsageTopQuery, UsageTopResponse } from "../types/usage";
+/**
+ * Usage 服务（Usage Service）
+ * - 网关模式：前端 -> /api/providers/usage/...
+ * - 直连模式：后端 -> /api/v1/usage/...
+ * 说明：Usage 模块挂在 Provider 服务里，因此 serviceName 复用 "providers"
+ */
+export declare class UsageService extends BaseClient {
+    constructor(config: ClientConfig);
+    private path;
+    private normalizeParams;
+    summary(params?: UsageBaseQuery, options?: RequestOptions): Promise<UsageSummaryResponse>;
+    daily(params?: UsageDailyQuery, options?: RequestOptions): Promise<UsageDailyResponse>;
+    byModel(params?: UsageBaseQuery, options?: RequestOptions): Promise<UsageByModelResponse>;
+    byProvider(params?: UsageByProviderQuery, options?: RequestOptions): Promise<UsageByProviderResponse>;
+    byUser(params?: UsageBaseQuery, options?: RequestOptions): Promise<UsageByUserResponse>;
+    top(params?: UsageTopQuery, options?: RequestOptions): Promise<UsageTopResponse>;
+}

package/lib/service/UsageService.js

@@ -0,0 +1,72 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.UsageService = void 0;
+const BaseClient_1 = require("../client/BaseClient");
+/**
+ * Usage 服务（Usage Service）
+ * - 网关模式：前端 -> /api/providers/usage/...
+ * - 直连模式：后端 -> /api/v1/usage/...
+ * 说明：Usage 模块挂在 Provider 服务里，因此 serviceName 复用 "providers"
+ */
+class UsageService extends BaseClient_1.BaseClient {
+    constructor(config) {
+        super(config, "providers");
+    }
+    // 前端/后端路径兼容
+    path(p) {
+        return this.isFrontendMode ? p : `/api/v1${p}`;
+    }
+    normalizeParams(params) {
+        if (!params)
+            return undefined;
+        const normalized = {
+            ...params,
+            success: params.success === undefined ? undefined : String(params.success),
+        };
+        Object.keys(normalized).forEach((k) => normalized[k] === undefined && delete normalized[k]);
+        return normalized;
+    }
+    async summary(params, options) {
+        return this.request(this.path("/usage/summary"), {
+            ...options,
+            method: "GET",
+            params: this.normalizeParams(params),
+        });
+    }
+    async daily(params, options) {
+        return this.request(this.path("/usage/daily"), {
+            ...options,
+            method: "GET",
+            params: this.normalizeParams(params),
+        });
+    }
+    async byModel(params, options) {
+        return this.request(this.path("/usage/by-model"), {
+            ...options,
+            method: "GET",
+            params: this.normalizeParams(params),
+        });
+    }
+    async byProvider(params, options) {
+        return this.request(this.path("/usage/by-provider"), {
+            ...options,
+            method: "GET",
+            params: this.normalizeParams(params),
+        });
+    }
+    async byUser(params, options) {
+        return this.request(this.path("/usage/by-user"), {
+            ...options,
+            method: "GET",
+            params: this.normalizeParams(params),
+        });
+    }
+    async top(params, options) {
+        return this.request(this.path("/usage/top"), {
+            ...options,
+            method: "GET",
+            params: this.normalizeParams(params),
+        });
+    }
+}
+exports.UsageService = UsageService;

package/lib/types/index.d.ts

@@ -52,3 +52,4 @@ export interface RequestOptions {
     appId?: string;
 }
 export * from "./provider";
+export * from "./usage";

package/lib/types/index.js

@@ -15,3 +15,4 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./provider"), exports);
+__exportStar(require("./usage"), exports);

package/lib/types/usage.d.ts

@@ -0,0 +1,57 @@
+export interface UsageBaseQuery {
+    from?: string;
+    to?: string;
+    providerId?: string;
+    providerClass?: string;
+    fullModelName?: string;
+    modelId?: string;
+    actorId?: string;
+    success?: boolean;
+}
+export interface UsageDailyQuery extends UsageBaseQuery {
+    timezone?: string;
+}
+export interface UsageByProviderQuery extends UsageBaseQuery {
+    groupBy?: "providerId" | "providerClass";
+}
+export interface UsageTopQuery extends UsageBaseQuery {
+    by?: "model" | "provider" | "user";
+    limit?: number;
+}
+export interface UsageSumResult {
+    inputTokens: number;
+    outputTokens: number;
+    totalTokens: number;
+    count: number;
+}
+export interface UsageDailyRow extends UsageSumResult {
+    day: string;
+}
+export interface UsageGroupRow extends UsageSumResult {
+    key: string;
+}
+export interface UsageScope {
+    actorId: string | null;
+}
+export interface UsageSummaryResponse {
+    from: string;
+    to: string;
+    scope: UsageScope;
+    data: UsageSumResult;
+}
+export interface UsageDailyResponse {
+    from: string;
+    to: string;
+    scope: UsageScope;
+    rows: UsageDailyRow[];
+}
+export interface UsageGroupResponse {
+    from: string;
+    to: string;
+    scope: UsageScope;
+    rows: UsageGroupRow[];
+}
+export type UsageByModelResponse = UsageGroupResponse;
+export type UsageByProviderResponse = UsageGroupResponse;
+export type UsageByUserResponse = UsageGroupResponse;
+export type UsageTopResponse = UsageGroupResponse;

package/lib/types/usage.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "qing-client",
-  "version": "0.0.22",
+  "version": "0.0.23",
   "main": "lib/index.js",
   "types": "lib/index.d.ts",
   "scripts": {