plugin-ai-api 1.0.23 → 1.0.25

package/src/server/collections/ai-api-role-permissions.ts

@@ -1,41 +1,41 @@
-/**
- * This file is part of the NocoBase (R) project.
- * Copyright (c) 2020-2024 NocoBase Co., Ltd.
- * Authors: NocoBase Team.
- *
- * This project is dual-licensed under AGPL-3.0 and NocoBase Commercial License.
- * For more information, please refer to: https://www.nocobase.com/agreement.
- */
-
-import { defineCollection } from '@nocobase/database';
-
-export default defineCollection({
-  name: 'aiApiRolePermissions',
-  autoGenId: true,
-  fields: [
-    {
-      name: 'roleName',
-      type: 'string',
-      unique: true,
-      comment: 'Role name (links to roles.name)',
-    },
-    {
-      name: 'enabled',
-      type: 'boolean',
-      defaultValue: false,
-      comment: 'Whether this role can use the AI API at all',
-    },
-    {
-      name: 'allowAllEmployees',
-      type: 'boolean',
-      defaultValue: true,
-      comment: 'If true, the role may use any AI Employee. If false, only those in allowedEmployees.',
-    },
-    {
-      name: 'allowedEmployees',
-      type: 'json',
-      defaultValue: [],
-      comment: 'Array of AI Employee usernames this role is allowed to use (when allowAllEmployees=false)',
-    },
-  ],
-});
+/**
+ * This file is part of the NocoBase (R) project.
+ * Copyright (c) 2020-2024 NocoBase Co., Ltd.
+ * Authors: NocoBase Team.
+ *
+ * This project is dual-licensed under AGPL-3.0 and NocoBase Commercial License.
+ * For more information, please refer to: https://www.nocobase.com/agreement.
+ */
+
+import { defineCollection } from '@nocobase/database';
+
+export default defineCollection({
+  name: 'aiApiRolePermissions',
+  autoGenId: true,
+  fields: [
+    {
+      name: 'roleName',
+      type: 'string',
+      unique: true,
+      comment: 'Role name (links to roles.name)',
+    },
+    {
+      name: 'enabled',
+      type: 'boolean',
+      defaultValue: false,
+      comment: 'Whether this role can use the AI API at all',
+    },
+    {
+      name: 'allowAllEmployees',
+      type: 'boolean',
+      defaultValue: true,
+      comment: 'If true, the role may use any AI Employee. If false, only those in allowedEmployees.',
+    },
+    {
+      name: 'allowedEmployees',
+      type: 'json',
+      defaultValue: [],
+      comment: 'Array of AI Employee usernames this role is allowed to use (when allowAllEmployees=false)',
+    },
+  ],
+});

package/src/server/collections/ai-api-usage-records.ts

@@ -32,6 +32,7 @@ export default defineCollection({
     { name: 'inputTokens', type: 'integer', allowNull: true },
     { name: 'outputTokens', type: 'integer', allowNull: true },
     { name: 'totalTokens', type: 'integer', allowNull: true },
+    { name: 'promptCacheTokens', type: 'integer', allowNull: true },
     { name: 'estimatedCost', type: 'decimal', allowNull: true, precision: 20, scale: 8 },
     { name: 'currency', type: 'string', allowNull: true },
     { name: 'costStatus', type: 'string', allowNull: true, index: true },

package/src/server/collections/ai-api-user-quota-policies.ts

@@ -22,6 +22,7 @@ export default defineCollection({
     { name: 'currency', type: 'string', allowNull: false, defaultValue: 'USD' },
     { name: 'rejectUnpricedModel', type: 'boolean', defaultValue: true },
     { name: 'missingUsageBehavior', type: 'string', allowNull: false, defaultValue: 'use_reserved' },
+    { name: 'contextOverflowBehavior', type: 'string', allowNull: false, defaultValue: 'reject' },
   ],
   indexes: [
     {

package/src/server/index.ts

@@ -1,10 +1,10 @@
-/**
- * This file is part of the NocoBase (R) project.
- * Copyright (c) 2020-2024 NocoBase Co., Ltd.
- * Authors: NocoBase Team.
- *
- * This project is dual-licensed under AGPL-3.0 and NocoBase Commercial License.
- * For more information, please refer to: https://www.nocobase.com/agreement.
- */
-
-export { default } from './plugin';
+/**
+ * This file is part of the NocoBase (R) project.
+ * Copyright (c) 2020-2024 NocoBase Co., Ltd.
+ * Authors: NocoBase Team.
+ *
+ * This project is dual-licensed under AGPL-3.0 and NocoBase Commercial License.
+ * For more information, please refer to: https://www.nocobase.com/agreement.
+ */
+
+export { default } from './plugin';

package/src/server/middleware/rate-limit.ts

@@ -1,70 +1,70 @@
-/**
- * This file is part of the NocoBase (R) project.
- * Copyright (c) 2020-2024 NocoBase Co., Ltd.
- * Authors: NocoBase Team.
- *
- * This project is dual-licensed under AGPL-3.0 and NocoBase Commercial License.
- * For more information, please refer to: https://www.nocobase.com/agreement.
- */
-
-import { Context } from '@nocobase/actions';
-import { RateLimiter } from '../utils/rate-limiter';
-import { toOpenAIError } from '../utils/openai-format';
-
-/**
- * Creates a rate-limiting check function for use in the AI API router.
- *
- * Must be called AFTER authenticateBearer() so ctx.state.currentUser is set.
- * Reads rateLimitPerMinute from aiApiConfig on each request (cheap single-row read,
- * allows config changes to take effect immediately without restart).
- * Falls back to 60 req/min if the config record is missing or the field is 0/null.
- *
- * Returns false (and writes the 429 response) when the rate limit is exceeded.
- * Returns true when the request is allowed.
- *
- * Sets OpenAI-compatible rate limit response headers on every request:
- *   X-RateLimit-Limit: <limit>
- *   X-RateLimit-Remaining: <remaining> (on 429: 0)
- *   Retry-After: <seconds>  (on 429 only)
- */
-export function createRateLimitMiddleware(limiter: RateLimiter) {
-  return async (ctx: Context): Promise<boolean> => {
-    const userId = ctx.state.currentUser?.id;
-    // Auth runs before this; if somehow missing, fail open (don't block the request).
-    if (userId === undefined || userId === null) return true;
-
-    let limit = 60;
-    try {
-      const config = await ctx.db.getRepository('aiApiConfig').findOne();
-      const configLimit = config?.rateLimitPerMinute;
-      if (configLimit && configLimit > 0) {
-        limit = configLimit;
-      }
-    } catch (configErr) {
-      // Config read failure: fail open — don't block legitimate requests
-      // Log at WARN so admins can detect DB connectivity issues
-      ctx.app?.logger?.warn('[ai-api] Rate limit config read failed, using default (60/min)', configErr);
-    }
-
-    const result = limiter.check(userId, limit);
-
-    if (!result.allowed) {
-      const retryAfterSec = Math.ceil((result as any).retryAfterMs / 1000);
-      ctx.set('Retry-After', String(retryAfterSec));
-      ctx.set('X-RateLimit-Limit', String(limit));
-      ctx.set('X-RateLimit-Remaining', '0');
-      ctx.status = 429;
-      ctx.body = toOpenAIError(
-        429,
-        `Rate limit exceeded. You have used all ${limit} requests allowed per minute. ` +
-          `Please wait ${retryAfterSec} second${retryAfterSec !== 1 ? 's' : ''} before retrying.`,
-        'requests',
-        'rate_limit_exceeded',
-      );
-      return false;
-    }
-
-    ctx.set('X-RateLimit-Limit', String(limit));
-    return true;
-  };
-}
+/**
+ * This file is part of the NocoBase (R) project.
+ * Copyright (c) 2020-2024 NocoBase Co., Ltd.
+ * Authors: NocoBase Team.
+ *
+ * This project is dual-licensed under AGPL-3.0 and NocoBase Commercial License.
+ * For more information, please refer to: https://www.nocobase.com/agreement.
+ */
+
+import { Context } from '@nocobase/actions';
+import { RateLimiter } from '../utils/rate-limiter';
+import { toOpenAIError } from '../utils/openai-format';
+
+/**
+ * Creates a rate-limiting check function for use in the AI API router.
+ *
+ * Must be called AFTER authenticateBearer() so ctx.state.currentUser is set.
+ * Reads rateLimitPerMinute from aiApiConfig on each request (cheap single-row read,
+ * allows config changes to take effect immediately without restart).
+ * Falls back to 60 req/min if the config record is missing or the field is 0/null.
+ *
+ * Returns false (and writes the 429 response) when the rate limit is exceeded.
+ * Returns true when the request is allowed.
+ *
+ * Sets OpenAI-compatible rate limit response headers on every request:
+ *   X-RateLimit-Limit: <limit>
+ *   X-RateLimit-Remaining: <remaining> (on 429: 0)
+ *   Retry-After: <seconds>  (on 429 only)
+ */
+export function createRateLimitMiddleware(limiter: RateLimiter) {
+  return async (ctx: Context): Promise<boolean> => {
+    const userId = ctx.state.currentUser?.id;
+    // Auth runs before this; if somehow missing, fail open (don't block the request).
+    if (userId === undefined || userId === null) return true;
+
+    let limit = 60;
+    try {
+      const config = await ctx.db.getRepository('aiApiConfig').findOne();
+      const configLimit = config?.rateLimitPerMinute;
+      if (configLimit && configLimit > 0) {
+        limit = configLimit;
+      }
+    } catch (configErr) {
+      // Config read failure: fail open — don't block legitimate requests
+      // Log at WARN so admins can detect DB connectivity issues
+      ctx.app?.logger?.warn('[ai-api] Rate limit config read failed, using default (60/min)', configErr);
+    }
+
+    const result = limiter.check(userId, limit);
+
+    if (!result.allowed) {
+      const retryAfterSec = Math.ceil((result as any).retryAfterMs / 1000);
+      ctx.set('Retry-After', String(retryAfterSec));
+      ctx.set('X-RateLimit-Limit', String(limit));
+      ctx.set('X-RateLimit-Remaining', '0');
+      ctx.status = 429;
+      ctx.body = toOpenAIError(
+        429,
+        `Rate limit exceeded. You have used all ${limit} requests allowed per minute. ` +
+          `Please wait ${retryAfterSec} second${retryAfterSec !== 1 ? 's' : ''} before retrying.`,
+        'requests',
+        'rate_limit_exceeded',
+      );
+      return false;
+    }
+
+    ctx.set('X-RateLimit-Limit', String(limit));
+    return true;
+  };
+}

package/src/server/migrations/20260813000000-add-prompt-cache-tokens.ts

@@ -0,0 +1,46 @@
+import { Migration } from '@nocobase/server';
+
+export default class AddPromptCacheTokensToUsageRecords extends Migration {
+  on = 'beforeLoad' as const;
+
+  async up() {
+    const collection = this.db.getCollection('aiApiUsageRecords');
+    if (!collection) return;
+
+    const field = collection.getField('promptCacheTokens');
+    if (!field) {
+      collection.addField('promptCacheTokens', { type: 'integer', allowNull: true });
+    }
+
+    if (await collection.existsInDb()) {
+      const tableName = collection.getTableNameWithSchema();
+      const exists = await this.tableColumnExists(tableName, 'promptCacheTokens');
+      if (!exists) {
+        await this.queryInterface.addColumn(tableName, 'promptCacheTokens', {
+          type: this.db.sequelize.getDialect() === 'sqlite' ? 'INTEGER' : 'INTEGER',
+          allowNull: true,
+        });
+      }
+    }
+  }
+
+  async down() {
+    const collection = this.db.getCollection('aiApiUsageRecords');
+    if (!collection) return;
+
+    if (await collection.existsInDb()) {
+      const tableName = collection.getTableNameWithSchema();
+      const exists = await this.tableColumnExists(tableName, 'promptCacheTokens');
+      if (exists) {
+        await this.queryInterface.removeColumn(tableName, 'promptCacheTokens');
+      }
+    }
+
+    collection.removeField('promptCacheTokens');
+  }
+
+  private async tableColumnExists(tableName: string, columnName: string): Promise<boolean> {
+    const columns = await this.queryInterface.describeTable(tableName);
+    return Object.prototype.hasOwnProperty.call(columns, columnName);
+  }
+}

package/src/server/plugin.ts

@@ -18,6 +18,12 @@ import { invalidateRolePermissionCache } from './middleware/role-permission';
 import { invalidateUserPermissionCache } from './utils/user-permissions';
 import { validateModelPrice, validateModelMetadata, validateQuotaPolicy } from './validation';
 import { AI_API_ACL_SNIPPET, AI_API_USER_PERMISSIONS_SNIPPET } from '../constants';
+import {
+  FileProcessorService,
+  base64FileForwarder,
+  httpFileUrlFetcher,
+  pdfFileProcessor,
+} from './services/file-processor';
 
 // Ensure dayjs timezone + utc plugins are loaded.
 // Some Docker builds ship an older @nocobase/utils whose dayjs.js does not
@@ -39,6 +45,12 @@ export class PluginAiApiServer extends Plugin {
    */
   rateLimiter = new RateLimiter(60_000);
 
+  /**
+   * Extensible file processor service. Other plugins can register custom processors
+   * to transform file/file_url content blocks before they reach the LLM.
+   */
+  fileProcessorService = new FileProcessorService();
+
   private gcInterval: NodeJS.Timeout | null = null;
 
   async afterAdd() {}
@@ -56,6 +68,13 @@ export class PluginAiApiServer extends Plugin {
   }
 
   async load() {
+    // Register default file processors. Custom plugins can register additional
+    // processors by retrieving this plugin instance and calling
+    // `fileProcessorService.register(processor)`.
+    this.fileProcessorService.register(base64FileForwarder);
+    this.fileProcessorService.register(httpFileUrlFetcher);
+    this.fileProcessorService.register(pdfFileProcessor);
+
     // 1. Claim body parsing for our own routes before the core bodyParser runs.
     //    Core registers koa-bodyparser with a global REQUEST_BODY_LIMIT (10mb by
     //    default) much earlier in the stack, so without this the gateway's own
@@ -159,6 +178,7 @@ export class PluginAiApiServer extends Plugin {
           enabledLlmServices: [],
           rateLimitPerMinute: 60,
           quotaEnabled: false,
+          pdfRenderPagesAsImages: false,
           defaultReservationOutputTokens: 4096,
         },
       });

package/src/server/resource/ai-api-config.ts

@@ -48,6 +48,7 @@ const aiApiConfigResource: ResourceOptions = {
             enabledLlmServices: [],
             rateLimitPerMinute: 60,
             maxRequestBodyMb: 10,
+            pdfRenderPagesAsImages: false,
             quotaEnabled: false,
             defaultReservationOutputTokens: 4096,
             options: {},
@@ -72,6 +73,7 @@ const aiApiConfigResource: ResourceOptions = {
             enabledLlmServices: values.enabledLlmServices ?? [],
             rateLimitPerMinute: values.rateLimitPerMinute ?? 60,
             maxRequestBodyMb: coerceMaxRequestBodyMb(values.maxRequestBodyMb ?? DEFAULT_MAX_REQUEST_BODY_MB),
+            pdfRenderPagesAsImages: values.pdfRenderPagesAsImages ?? false,
             quotaEnabled: values.quotaEnabled ?? false,
             defaultReservationOutputTokens: values.defaultReservationOutputTokens ?? 4096,
             options: values.options ?? {},
@@ -87,6 +89,9 @@ const aiApiConfigResource: ResourceOptions = {
         if (values.maxRequestBodyMb !== undefined) {
           updateData.maxRequestBodyMb = coerceMaxRequestBodyMb(values.maxRequestBodyMb);
         }
+        if (values.pdfRenderPagesAsImages !== undefined) {
+          updateData.pdfRenderPagesAsImages = Boolean(values.pdfRenderPagesAsImages);
+        }
         if (values.quotaEnabled !== undefined) updateData.quotaEnabled = values.quotaEnabled;
         if (values.defaultReservationOutputTokens !== undefined) {
           updateData.defaultReservationOutputTokens = values.defaultReservationOutputTokens;

package/src/server/resource/ai-api-usage-monitor.ts

@@ -7,6 +7,7 @@ interface UsageSummaryRow {
   inputTokens?: string | number;
   outputTokens?: string | number;
   totalTokens?: string | number;
+  promptCacheTokens?: string | number;
 }
 
 interface CostSummaryRow {
@@ -45,6 +46,7 @@ const aiApiUsageMonitorResource: ResourceOptions = {
           [fn('COALESCE', fn('SUM', col('inputTokens')), 0), 'inputTokens'],
           [fn('COALESCE', fn('SUM', col('outputTokens')), 0), 'outputTokens'],
           [fn('COALESCE', fn('SUM', col('totalTokens')), 0), 'totalTokens'],
+          [fn('COALESCE', fn('SUM', col('promptCacheTokens')), 0), 'promptCacheTokens'],
         ],
         where,
         raw: true,
@@ -61,6 +63,7 @@ const aiApiUsageMonitorResource: ResourceOptions = {
         inputTokens: Number(totals?.inputTokens ?? 0),
         outputTokens: Number(totals?.outputTokens ?? 0),
         totalTokens: Number(totals?.totalTokens ?? 0),
+        promptCacheTokens: Number(totals?.promptCacheTokens ?? 0),
         costsByCurrency: costs.map((item) => ({
           currency: item.currency || 'USD',
           totalCost: String(item.totalCost ?? 0),