langchain 1.0.5 → 1.1.0

package/dist/agents/middleware/modelRetry.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"modelRetry.js","names":["config: ModelRetryMiddlewareConfig","error: Error","error","attemptsMade: number","content: string"],"sources":["../../../src/agents/middleware/modelRetry.ts"],"sourcesContent":["/**\n * Model retry middleware for agents.\n */\nimport { z } from \"zod/v3\";\nimport { AIMessage } from \"@langchain/core/messages\";\n\nimport { createMiddleware } from \"../middleware.js\";\nimport type { AgentMiddleware } from \"./types.js\";\nimport { sleep, calculateRetryDelay } from \"./utils.js\";\nimport { RetrySchema } from \"./constants.js\";\nimport { InvalidRetryConfigError } from \"./error.js\";\n\n/**\n * Configuration options for the Model Retry Middleware.\n */\nexport const ModelRetryMiddlewareOptionsSchema = z\n  .object({\n    /**\n     * Behavior when all retries are exhausted. Options:\n     * - `\"continue\"` (default): Return an AIMessage with error details, allowing\n     *   the agent to potentially handle the failure gracefully.\n     * - `\"error\"`: Re-raise the exception, stopping agent execution.\n     * - Custom function: Function that takes the exception and returns a string\n     *   for the AIMessage content, allowing custom error formatting.\n     */\n    onFailure: z\n      .union([\n        z.literal(\"error\"),\n        z.literal(\"continue\"),\n        z.function().args(z.instanceof(Error)).returns(z.string()),\n      ])\n      .default(\"continue\"),\n  })\n  .merge(RetrySchema);\n\nexport type ModelRetryMiddlewareConfig = z.input<\n  typeof ModelRetryMiddlewareOptionsSchema\n>;\n\n/**\n * Middleware that automatically retries failed model calls with configurable backoff.\n *\n * Supports retrying on specific exceptions and exponential backoff.\n *\n * @example Basic usage with default settings (2 retries, exponential backoff)\n * ```ts\n * import { createAgent, modelRetryMiddleware } from \"langchain\";\n *\n * const agent = createAgent({\n *   model: \"openai:gpt-4o\",\n *   tools: [searchTool],\n *   middleware: [modelRetryMiddleware()],\n * });\n * ```\n *\n * @example Retry specific exceptions only\n * ```ts\n * import { modelRetryMiddleware } from \"langchain\";\n *\n * const retry = modelRetryMiddleware({\n *   maxRetries: 4,\n *   retryOn: [TimeoutError, NetworkError],\n *   backoffFactor: 1.5,\n * });\n * ```\n *\n * @example Custom exception filtering\n * ```ts\n * function shouldRetry(error: Error): boolean {\n *   // Only retry on rate limit errors\n *   if (error.name === \"RateLimitError\") {\n *     return true;\n *   }\n *   // Or check for specific HTTP status codes\n *   if (error.name === \"HTTPError\" && \"statusCode\" in error) {\n *     const statusCode = (error as any).statusCode;\n *     return statusCode === 429 || statusCode === 503;\n *   }\n *   return false;\n * }\n *\n * const retry = modelRetryMiddleware({\n *   maxRetries: 3,\n *   retryOn: shouldRetry,\n * });\n * ```\n *\n * @example Return error message instead of raising\n * ```ts\n * const retry = modelRetryMiddleware({\n *   maxRetries: 4,\n *   onFailure: \"continue\", // Return AIMessage with error instead of throwing\n * });\n * ```\n *\n * @example Custom error message formatting\n * ```ts\n * const formatError = (error: Error) =>\n *   `Model call failed: ${error.message}. Please try again later.`;\n *\n * const retry = modelRetryMiddleware({\n *   maxRetries: 4,\n *   onFailure: formatError,\n * });\n * ```\n *\n * @example Constant backoff (no exponential growth)\n * ```ts\n * const retry = modelRetryMiddleware({\n *   maxRetries: 5,\n *   backoffFactor: 0.0, // No exponential growth\n *   initialDelayMs: 2000, // Always wait 2 seconds\n * });\n * ```\n *\n * @example Raise exception on failure\n * ```ts\n * const retry = modelRetryMiddleware({\n *   maxRetries: 2,\n *   onFailure: \"error\", // Re-raise exception instead of returning message\n * });\n * ```\n *\n * @param config - Configuration options for the retry middleware\n * @returns A middleware instance that handles model failures with retries\n */\nexport function modelRetryMiddleware(\n  config: ModelRetryMiddlewareConfig = {}\n): AgentMiddleware {\n  const { success, error, data } =\n    ModelRetryMiddlewareOptionsSchema.safeParse(config);\n  if (!success) {\n    throw new InvalidRetryConfigError(error);\n  }\n  const {\n    maxRetries,\n    retryOn,\n    onFailure,\n    backoffFactor,\n    initialDelayMs,\n    maxDelayMs,\n    jitter,\n  } = data;\n\n  /**\n   * Check if the exception should trigger a retry.\n   */\n  const shouldRetryException = (error: Error): boolean => {\n    if (typeof retryOn === \"function\") {\n      return retryOn(error);\n    }\n    // retryOn is an array of error constructors\n    return retryOn.some(\n      (ErrorConstructor) => error.constructor === ErrorConstructor\n    );\n  };\n\n  // Use the exported calculateRetryDelay function with our config\n  const delayConfig = { backoffFactor, initialDelayMs, maxDelayMs, jitter };\n\n  /**\n   * Format the failure message when retries are exhausted.\n   */\n  const formatFailureMessage = (error: Error, attemptsMade: number): string => {\n    const errorType = error.constructor.name;\n    const attemptWord = attemptsMade === 1 ? \"attempt\" : \"attempts\";\n    return `Model call failed after ${attemptsMade} ${attemptWord} with ${errorType}: ${error.message}`;\n  };\n\n  /**\n   * Handle failure when all retries are exhausted.\n   */\n  const handleFailure = (error: Error, attemptsMade: number): AIMessage => {\n    if (onFailure === \"error\") {\n      throw error;\n    }\n\n    let content: string;\n    if (typeof onFailure === \"function\") {\n      content = onFailure(error);\n    } else {\n      content = formatFailureMessage(error, attemptsMade);\n    }\n\n    return new AIMessage({\n      content,\n    });\n  };\n\n  return createMiddleware({\n    name: \"modelRetryMiddleware\",\n    contextSchema: ModelRetryMiddlewareOptionsSchema,\n    wrapModelCall: async (request, handler) => {\n      // Initial attempt + retries\n      for (let attempt = 0; attempt <= maxRetries; attempt++) {\n        try {\n          return await handler(request);\n        } catch (error) {\n          const attemptsMade = attempt + 1; // attempt is 0-indexed\n\n          // Ensure error is an Error instance\n          const err =\n            error && typeof error === \"object\" && \"message\" in error\n              ? (error as Error)\n              : new Error(String(error));\n\n          // Check if we should retry this exception\n          if (!shouldRetryException(err)) {\n            // Exception is not retryable, handle failure immediately\n            return handleFailure(err, attemptsMade);\n          }\n\n          // Check if we have more retries left\n          if (attempt < maxRetries) {\n            // Calculate and apply backoff delay\n            const delay = calculateRetryDelay(delayConfig, attempt);\n            if (delay > 0) {\n              await sleep(delay);\n            }\n            // Continue to next retry\n          } else {\n            // No more retries, handle failure\n            return handleFailure(err, attemptsMade);\n          }\n        }\n      }\n\n      // Unreachable: loop always returns via handler success or handleFailure\n      throw new Error(\"Unexpected: retry loop completed without returning\");\n    },\n  });\n}\n"],"mappings":";;;;;;;;;;;AAeA,MAAa,oCAAoC,EAC9C,OAAO,EASN,WAAW,EACR,MAAM;CACL,EAAE,QAAQ,QAAQ;CAClB,EAAE,QAAQ,WAAW;CACrB,EAAE,UAAU,CAAC,KAAK,EAAE,WAAW,MAAM,CAAC,CAAC,QAAQ,EAAE,QAAQ,CAAC;AAC3D,EAAC,CACD,QAAQ,WAAW,CACvB,EAAC,CACD,MAAM,YAAY;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AA6FrB,SAAgB,qBACdA,SAAqC,CAAE,GACtB;CACjB,MAAM,EAAE,SAAS,OAAO,MAAM,GAC5B,kCAAkC,UAAU,OAAO;AACrD,KAAI,CAAC,QACH,OAAM,IAAI,wBAAwB;CAEpC,MAAM,EACJ,YACA,SACA,WACA,eACA,gBACA,YACA,QACD,GAAG;;;;CAKJ,MAAM,uBAAuB,CAACC,YAA0B;AACtD,MAAI,OAAO,YAAY,WACrB,QAAO,QAAQC,QAAM;AAGvB,SAAO,QAAQ,KACb,CAAC,qBAAqBA,QAAM,gBAAgB,iBAC7C;CACF;CAGD,MAAM,cAAc;EAAE;EAAe;EAAgB;EAAY;CAAQ;;;;CAKzE,MAAM,uBAAuB,CAACD,SAAcE,iBAAiC;EAC3E,MAAM,YAAYD,QAAM,YAAY;EACpC,MAAM,cAAc,iBAAiB,IAAI,YAAY;AACrD,SAAO,CAAC,wBAAwB,EAAE,aAAa,CAAC,EAAE,YAAY,MAAM,EAAE,UAAU,EAAE,EAAEA,QAAM,SAAS;CACpG;;;;CAKD,MAAM,gBAAgB,CAACD,SAAcE,iBAAoC;AACvE,MAAI,cAAc,QAChB,OAAMD;EAGR,IAAIE;AACJ,MAAI,OAAO,cAAc,YACvB,UAAU,UAAUF,QAAM;OAE1B,UAAU,qBAAqBA,SAAO,aAAa;AAGrD,SAAO,IAAI,UAAU,EACnB,QACD;CACF;AAED,QAAO,iBAAiB;EACtB,MAAM;EACN,eAAe;EACf,eAAe,OAAO,SAAS,YAAY;AAEzC,QAAK,IAAI,UAAU,GAAG,WAAW,YAAY,UAC3C,KAAI;AACF,WAAO,MAAM,QAAQ,QAAQ;GAC9B,SAAQA,SAAO;IACd,MAAM,eAAe,UAAU;IAG/B,MAAM,MACJA,WAAS,OAAOA,YAAU,YAAY,aAAaA,UAC9CA,UACD,IAAI,MAAM,OAAOA,QAAM;AAG7B,QAAI,CAAC,qBAAqB,IAAI,CAE5B,QAAO,cAAc,KAAK,aAAa;AAIzC,QAAI,UAAU,YAAY;KAExB,MAAM,QAAQ,oBAAoB,aAAa,QAAQ;AACvD,SAAI,QAAQ,GACV,MAAM,MAAM,MAAM;IAGrB,MAEC,QAAO,cAAc,KAAK,aAAa;GAE1C;AAIH,SAAM,IAAI,MAAM;EACjB;CACF,EAAC;AACH"}

package/dist/agents/middleware/{promptCaching.cjs → provider/anthropic/promptCaching.cjs}

@@ -1,8 +1,8 @@
-const require_rolldown_runtime = require('../../_virtual/rolldown_runtime.cjs');
-const require_middleware = require('../middleware.cjs');
+const require_rolldown_runtime = require('../../../../_virtual/rolldown_runtime.cjs');
+const require_middleware = require('../../../middleware.cjs');
 const zod_v3 = require_rolldown_runtime.__toESM(require("zod/v3"));
 
-//#region src/agents/middleware/promptCaching.ts
+//#region src/agents/middleware/provider/anthropic/promptCaching.ts
 const DEFAULT_ENABLE_CACHING = true;
 const DEFAULT_TTL = "5m";
 const DEFAULT_MIN_MESSAGES_TO_CACHE = 3;

package/dist/agents/middleware/provider/anthropic/promptCaching.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"promptCaching.cjs","names":["z","message: string","middlewareOptions?: PromptCachingMiddlewareConfig","createMiddleware"],"sources":["../../../../../src/agents/middleware/provider/anthropic/promptCaching.ts"],"sourcesContent":["import { z } from \"zod/v3\";\nimport { ContentBlock } from \"@langchain/core/messages\";\nimport { InferInteropZodInput } from \"@langchain/core/utils/types\";\n\nimport { ConfigurableModel } from \"../../../../chat_models/universal.js\";\nimport { createMiddleware } from \"../../../middleware.js\";\n\nconst DEFAULT_ENABLE_CACHING = true;\nconst DEFAULT_TTL = \"5m\";\nconst DEFAULT_MIN_MESSAGES_TO_CACHE = 3;\nconst DEFAULT_UNSUPPORTED_MODEL_BEHAVIOR = \"warn\";\n\nconst contextSchema = z.object({\n  /**\n   * Whether to enable prompt caching.\n   * @default true\n   */\n  enableCaching: z.boolean().optional(),\n  /**\n   * The time-to-live for the cached prompt.\n   * @default \"5m\"\n   */\n  ttl: z.enum([\"5m\", \"1h\"]).optional(),\n  /**\n   * The minimum number of messages required before caching is applied.\n   * @default 3\n   */\n  minMessagesToCache: z.number().optional(),\n  /**\n   * The behavior to take when an unsupported model is used.\n   * - \"ignore\" will ignore the unsupported model and continue without caching.\n   * - \"warn\" will warn the user and continue without caching.\n   * - \"raise\" will raise an error and stop the agent.\n   * @default \"warn\"\n   */\n  unsupportedModelBehavior: z.enum([\"ignore\", \"warn\", \"raise\"]).optional(),\n});\nexport type PromptCachingMiddlewareConfig = Partial<\n  InferInteropZodInput<typeof contextSchema>\n>;\n\nclass PromptCachingMiddlewareError extends Error {\n  constructor(message: string) {\n    super(message);\n    this.name = \"PromptCachingMiddlewareError\";\n  }\n}\n\n/**\n * Creates a prompt caching middleware for Anthropic models to optimize API usage.\n *\n * This middleware automatically adds cache control headers to the last messages when using Anthropic models,\n * enabling their prompt caching feature. This can significantly reduce costs for applications with repetitive\n * prompts, long system messages, or extensive conversation histories.\n *\n * ## How It Works\n *\n * The middleware intercepts model requests and adds cache control metadata that tells Anthropic's\n * API to cache processed prompt prefixes. On subsequent requests with matching prefixes, the\n * cached representations are reused, skipping redundant token processing.\n *\n * ## Benefits\n *\n * - **Cost Reduction**: Avoid reprocessing the same tokens repeatedly (up to 90% savings on cached portions)\n * - **Lower Latency**: Cached prompts are processed faster as embeddings are pre-computed\n * - **Better Scalability**: Reduced computational load enables handling more requests\n * - **Consistent Performance**: Stable response times for repetitive queries\n *\n * @param middlewareOptions - Configuration options for the caching behavior\n * @param middlewareOptions.enableCaching - Whether to enable prompt caching (default: `true`)\n * @param middlewareOptions.ttl - Cache time-to-live: `\"5m\"` for 5 minutes or `\"1h\"` for 1 hour (default: `\"5m\"`)\n * @param middlewareOptions.minMessagesToCache - Minimum number of messages required before caching is applied (default: `3`)\n * @param middlewareOptions.unsupportedModelBehavior - The behavior to take when an unsupported model is used (default: `\"warn\"`)\n *\n * @returns A middleware instance that can be passed to `createAgent`\n *\n * @throws {Error} If used with non-Anthropic models\n *\n * @example\n * Basic usage with default settings\n * ```typescript\n * import { createAgent } from \"langchain\";\n * import { anthropicPromptCachingMiddleware } from \"langchain\";\n *\n * const agent = createAgent({\n *   model: \"anthropic:claude-3-5-sonnet\",\n *   middleware: [\n *     anthropicPromptCachingMiddleware()\n *   ]\n * });\n * ```\n *\n * @example\n * Custom configuration for longer conversations\n * ```typescript\n * const cachingMiddleware = anthropicPromptCachingMiddleware({\n *   ttl: \"1h\",  // Cache for 1 hour instead of default 5 minutes\n *   minMessagesToCache: 5  // Only cache after 5 messages\n * });\n *\n * const agent = createAgent({\n *   model: \"anthropic:claude-3-5-sonnet\",\n *   systemPrompt: \"You are a helpful assistant with deep knowledge of...\", // Long system prompt\n *   middleware: [cachingMiddleware]\n * });\n * ```\n *\n * @example\n * Conditional caching based on runtime context\n * ```typescript\n * const agent = createAgent({\n *   model: \"anthropic:claude-3-5-sonnet\",\n *   middleware: [\n *     anthropicPromptCachingMiddleware({\n *       enableCaching: true,\n *       ttl: \"5m\"\n *     })\n *   ]\n * });\n *\n * // Disable caching for specific requests\n * await agent.invoke(\n *   { messages: [new HumanMessage(\"Process this without caching\")] },\n *   {\n *     configurable: {\n *       middleware_context: { enableCaching: false }\n *     }\n *   }\n * );\n * ```\n *\n * @example\n * Optimal setup for customer support chatbot\n * ```typescript\n * const supportAgent = createAgent({\n *   model: \"anthropic:claude-3-5-sonnet\",\n *   systemPrompt: `You are a customer support agent for ACME Corp.\n *\n *     Company policies:\n *     - Always be polite and professional\n *     - Refer to knowledge base for product information\n *     - Escalate billing issues to human agents\n *     ... (extensive policies and guidelines)\n *   `,\n *   tools: [searchKnowledgeBase, createTicket, checkOrderStatus],\n *   middleware: [\n *     anthropicPromptCachingMiddleware({\n *       ttl: \"1h\",  // Long TTL for stable system prompt\n *       minMessagesToCache: 1  // Cache immediately due to large system prompt\n *     })\n *   ]\n * });\n * ```\n *\n * @remarks\n * - **Anthropic Only**: This middleware only works with Anthropic models and will throw an error if used with other providers\n * - **Automatic Application**: Caching is applied automatically when message count exceeds `minMessagesToCache`\n * - **Cache Scope**: Caches are isolated per API key and cannot be shared across different keys\n * - **TTL Options**: Only supports \"5m\" (5 minutes) and \"1h\" (1 hour) as TTL values per Anthropic's API\n * - **Best Use Cases**: Long system prompts, multi-turn conversations, repetitive queries, RAG applications\n * - **Cost Impact**: Cached tokens are billed at 10% of the base input token price, cache writes are billed at 25% of the base\n *\n * @see {@link createAgent} for agent creation\n * @see {@link https://docs.anthropic.com/en/docs/build-with-claude/prompt-caching} Anthropic's prompt caching documentation\n * @public\n */\nexport function anthropicPromptCachingMiddleware(\n  middlewareOptions?: PromptCachingMiddlewareConfig\n) {\n  return createMiddleware({\n    name: \"PromptCachingMiddleware\",\n    contextSchema,\n    wrapModelCall: (request, handler) => {\n      /**\n       * Prefer runtime context values over middleware options values over defaults\n       */\n      const enableCaching =\n        request.runtime.context.enableCaching ??\n        middlewareOptions?.enableCaching ??\n        DEFAULT_ENABLE_CACHING;\n      const ttl =\n        request.runtime.context.ttl ?? middlewareOptions?.ttl ?? DEFAULT_TTL;\n      const minMessagesToCache =\n        request.runtime.context.minMessagesToCache ??\n        middlewareOptions?.minMessagesToCache ??\n        DEFAULT_MIN_MESSAGES_TO_CACHE;\n      const unsupportedModelBehavior =\n        request.runtime.context.unsupportedModelBehavior ??\n        middlewareOptions?.unsupportedModelBehavior ??\n        DEFAULT_UNSUPPORTED_MODEL_BEHAVIOR;\n\n      // Skip if caching is disabled\n      if (!enableCaching || !request.model) {\n        return handler(request);\n      }\n\n      const isAnthropicModel =\n        request.model.getName() === \"ChatAnthropic\" ||\n        (request.model.getName() === \"ConfigurableModel\" &&\n          (request.model as ConfigurableModel)._defaultConfig?.modelProvider ===\n            \"anthropic\");\n      if (!isAnthropicModel) {\n        // Get model name for better error context\n        const modelName = request.model.getName();\n        const modelInfo =\n          request.model.getName() === \"ConfigurableModel\"\n            ? `${modelName} (${\n                (request.model as ConfigurableModel)._defaultConfig\n                  ?.modelProvider\n              })`\n            : modelName;\n\n        const baseMessage = `Unsupported model '${modelInfo}'. Prompt caching requires an Anthropic model`;\n\n        if (unsupportedModelBehavior === \"raise\") {\n          throw new PromptCachingMiddlewareError(\n            `${baseMessage} (e.g., 'anthropic:claude-4-0-sonnet').`\n          );\n        } else if (unsupportedModelBehavior === \"warn\") {\n          console.warn(\n            `PromptCachingMiddleware: Skipping caching for ${modelName}. Consider switching to an Anthropic model for caching benefits.`\n          );\n        }\n        return handler(request);\n      }\n\n      const messagesCount =\n        request.state.messages.length + (request.systemPrompt ? 1 : 0);\n\n      if (messagesCount < minMessagesToCache) {\n        return handler(request);\n      }\n\n      /**\n       * Add cache_control to the last message\n       */\n      const lastMessage = request.messages.at(-1);\n      if (!lastMessage) {\n        return handler(request);\n      }\n\n      const NewMessageConstructor =\n        Object.getPrototypeOf(lastMessage).constructor;\n      if (Array.isArray(lastMessage.content)) {\n        const newMessage = new NewMessageConstructor({\n          ...lastMessage,\n          content: [\n            ...lastMessage.content.slice(0, -1),\n            {\n              ...lastMessage.content.at(-1),\n              cache_control: {\n                type: \"ephemeral\",\n                ttl,\n              },\n            } as ContentBlock,\n          ],\n        });\n        return handler({\n          ...request,\n          messages: [...request.messages.slice(0, -1), newMessage],\n        });\n      } else if (typeof lastMessage.content === \"string\") {\n        const newMessage = new NewMessageConstructor({\n          ...lastMessage,\n          content: [\n            {\n              type: \"text\",\n              text: lastMessage.content,\n              cache_control: {\n                type: \"ephemeral\",\n                ttl,\n              },\n            },\n          ],\n        });\n        return handler({\n          ...request,\n          messages: [...request.messages.slice(0, -1), newMessage],\n        });\n      }\n\n      throw new PromptCachingMiddlewareError(\n        \"Last message content is not a string or array\"\n      );\n    },\n  });\n}\n"],"mappings":";;;;;AAOA,MAAM,yBAAyB;AAC/B,MAAM,cAAc;AACpB,MAAM,gCAAgC;AACtC,MAAM,qCAAqC;AAE3C,MAAM,gBAAgBA,SAAE,OAAO;CAK7B,eAAeA,SAAE,SAAS,CAAC,UAAU;CAKrC,KAAKA,SAAE,KAAK,CAAC,MAAM,IAAK,EAAC,CAAC,UAAU;CAKpC,oBAAoBA,SAAE,QAAQ,CAAC,UAAU;CAQzC,0BAA0BA,SAAE,KAAK;EAAC;EAAU;EAAQ;CAAQ,EAAC,CAAC,UAAU;AACzE,EAAC;AAKF,IAAM,+BAAN,cAA2C,MAAM;CAC/C,YAAYC,SAAiB;EAC3B,MAAM,QAAQ;EACd,KAAK,OAAO;CACb;AACF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAwHD,SAAgB,iCACdC,mBACA;AACA,QAAOC,oCAAiB;EACtB,MAAM;EACN;EACA,eAAe,CAAC,SAAS,YAAY;;;;GAInC,MAAM,gBACJ,QAAQ,QAAQ,QAAQ,iBACxB,mBAAmB,iBACnB;GACF,MAAM,MACJ,QAAQ,QAAQ,QAAQ,OAAO,mBAAmB,OAAO;GAC3D,MAAM,qBACJ,QAAQ,QAAQ,QAAQ,sBACxB,mBAAmB,sBACnB;GACF,MAAM,2BACJ,QAAQ,QAAQ,QAAQ,4BACxB,mBAAmB,4BACnB;AAGF,OAAI,CAAC,iBAAiB,CAAC,QAAQ,MAC7B,QAAO,QAAQ,QAAQ;GAGzB,MAAM,mBACJ,QAAQ,MAAM,SAAS,KAAK,mBAC3B,QAAQ,MAAM,SAAS,KAAK,uBAC1B,QAAQ,MAA4B,gBAAgB,kBACnD;AACN,OAAI,CAAC,kBAAkB;IAErB,MAAM,YAAY,QAAQ,MAAM,SAAS;IACzC,MAAM,YACJ,QAAQ,MAAM,SAAS,KAAK,sBACxB,GAAG,UAAU,EAAE,EACZ,QAAQ,MAA4B,gBACjC,cACL,CAAC,CAAC,GACH;IAEN,MAAM,cAAc,CAAC,mBAAmB,EAAE,UAAU,6CAA6C,CAAC;AAElG,QAAI,6BAA6B,QAC/B,OAAM,IAAI,6BACR,GAAG,YAAY,uCAAuC,CAAC;aAEhD,6BAA6B,QACtC,QAAQ,KACN,CAAC,8CAA8C,EAAE,UAAU,gEAAgE,CAAC,CAC7H;AAEH,WAAO,QAAQ,QAAQ;GACxB;GAED,MAAM,gBACJ,QAAQ,MAAM,SAAS,UAAU,QAAQ,eAAe,IAAI;AAE9D,OAAI,gBAAgB,mBAClB,QAAO,QAAQ,QAAQ;;;;GAMzB,MAAM,cAAc,QAAQ,SAAS,GAAG,GAAG;AAC3C,OAAI,CAAC,YACH,QAAO,QAAQ,QAAQ;GAGzB,MAAM,wBACJ,OAAO,eAAe,YAAY,CAAC;AACrC,OAAI,MAAM,QAAQ,YAAY,QAAQ,EAAE;IACtC,MAAM,aAAa,IAAI,sBAAsB;KAC3C,GAAG;KACH,SAAS,CACP,GAAG,YAAY,QAAQ,MAAM,GAAG,GAAG,EACnC;MACE,GAAG,YAAY,QAAQ,GAAG,GAAG;MAC7B,eAAe;OACb,MAAM;OACN;MACD;KACF,CACF;IACF;AACD,WAAO,QAAQ;KACb,GAAG;KACH,UAAU,CAAC,GAAG,QAAQ,SAAS,MAAM,GAAG,GAAG,EAAE,UAAW;IACzD,EAAC;GACH,WAAU,OAAO,YAAY,YAAY,UAAU;IAClD,MAAM,aAAa,IAAI,sBAAsB;KAC3C,GAAG;KACH,SAAS,CACP;MACE,MAAM;MACN,MAAM,YAAY;MAClB,eAAe;OACb,MAAM;OACN;MACD;KACF,CACF;IACF;AACD,WAAO,QAAQ;KACb,GAAG;KACH,UAAU,CAAC,GAAG,QAAQ,SAAS,MAAM,GAAG,GAAG,EAAE,UAAW;IACzD,EAAC;GACH;AAED,SAAM,IAAI,6BACR;EAEH;CACF,EAAC;AACH"}

package/dist/agents/middleware/{promptCaching.d.cts → provider/anthropic/promptCaching.d.cts}

@@ -1,8 +1,8 @@
-import { AgentMiddleware } from "./types.cjs";
+import { AgentMiddleware } from "../../types.cjs";
 import { InferInteropZodInput } from "@langchain/core/utils/types";
 import { z } from "zod/v3";
 
-//#region src/agents/middleware/promptCaching.d.ts
+//#region src/agents/middleware/provider/anthropic/promptCaching.d.ts
 declare const contextSchema: z.ZodObject<{
   /**
    * Whether to enable prompt caching.

package/dist/agents/middleware/{promptCaching.d.ts → provider/anthropic/promptCaching.d.ts}

@@ -1,8 +1,8 @@
-import { AgentMiddleware } from "./types.js";
+import { AgentMiddleware } from "../../types.js";
 import { z } from "zod/v3";
 import { InferInteropZodInput } from "@langchain/core/utils/types";
 
-//#region src/agents/middleware/promptCaching.d.ts
+//#region src/agents/middleware/provider/anthropic/promptCaching.d.ts
 declare const contextSchema: z.ZodObject<{
   /**
    * Whether to enable prompt caching.

package/dist/agents/middleware/{promptCaching.js → provider/anthropic/promptCaching.js}

@@ -1,7 +1,7 @@
-import { createMiddleware } from "../middleware.js";
+import { createMiddleware } from "../../../middleware.js";
 import { z } from "zod/v3";
 
-//#region src/agents/middleware/promptCaching.ts
+//#region src/agents/middleware/provider/anthropic/promptCaching.ts
 const DEFAULT_ENABLE_CACHING = true;
 const DEFAULT_TTL = "5m";
 const DEFAULT_MIN_MESSAGES_TO_CACHE = 3;

package/dist/agents/middleware/provider/anthropic/promptCaching.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"promptCaching.js","names":["message: string","middlewareOptions?: PromptCachingMiddlewareConfig"],"sources":["../../../../../src/agents/middleware/provider/anthropic/promptCaching.ts"],"sourcesContent":["import { z } from \"zod/v3\";\nimport { ContentBlock } from \"@langchain/core/messages\";\nimport { InferInteropZodInput } from \"@langchain/core/utils/types\";\n\nimport { ConfigurableModel } from \"../../../../chat_models/universal.js\";\nimport { createMiddleware } from \"../../../middleware.js\";\n\nconst DEFAULT_ENABLE_CACHING = true;\nconst DEFAULT_TTL = \"5m\";\nconst DEFAULT_MIN_MESSAGES_TO_CACHE = 3;\nconst DEFAULT_UNSUPPORTED_MODEL_BEHAVIOR = \"warn\";\n\nconst contextSchema = z.object({\n  /**\n   * Whether to enable prompt caching.\n   * @default true\n   */\n  enableCaching: z.boolean().optional(),\n  /**\n   * The time-to-live for the cached prompt.\n   * @default \"5m\"\n   */\n  ttl: z.enum([\"5m\", \"1h\"]).optional(),\n  /**\n   * The minimum number of messages required before caching is applied.\n   * @default 3\n   */\n  minMessagesToCache: z.number().optional(),\n  /**\n   * The behavior to take when an unsupported model is used.\n   * - \"ignore\" will ignore the unsupported model and continue without caching.\n   * - \"warn\" will warn the user and continue without caching.\n   * - \"raise\" will raise an error and stop the agent.\n   * @default \"warn\"\n   */\n  unsupportedModelBehavior: z.enum([\"ignore\", \"warn\", \"raise\"]).optional(),\n});\nexport type PromptCachingMiddlewareConfig = Partial<\n  InferInteropZodInput<typeof contextSchema>\n>;\n\nclass PromptCachingMiddlewareError extends Error {\n  constructor(message: string) {\n    super(message);\n    this.name = \"PromptCachingMiddlewareError\";\n  }\n}\n\n/**\n * Creates a prompt caching middleware for Anthropic models to optimize API usage.\n *\n * This middleware automatically adds cache control headers to the last messages when using Anthropic models,\n * enabling their prompt caching feature. This can significantly reduce costs for applications with repetitive\n * prompts, long system messages, or extensive conversation histories.\n *\n * ## How It Works\n *\n * The middleware intercepts model requests and adds cache control metadata that tells Anthropic's\n * API to cache processed prompt prefixes. On subsequent requests with matching prefixes, the\n * cached representations are reused, skipping redundant token processing.\n *\n * ## Benefits\n *\n * - **Cost Reduction**: Avoid reprocessing the same tokens repeatedly (up to 90% savings on cached portions)\n * - **Lower Latency**: Cached prompts are processed faster as embeddings are pre-computed\n * - **Better Scalability**: Reduced computational load enables handling more requests\n * - **Consistent Performance**: Stable response times for repetitive queries\n *\n * @param middlewareOptions - Configuration options for the caching behavior\n * @param middlewareOptions.enableCaching - Whether to enable prompt caching (default: `true`)\n * @param middlewareOptions.ttl - Cache time-to-live: `\"5m\"` for 5 minutes or `\"1h\"` for 1 hour (default: `\"5m\"`)\n * @param middlewareOptions.minMessagesToCache - Minimum number of messages required before caching is applied (default: `3`)\n * @param middlewareOptions.unsupportedModelBehavior - The behavior to take when an unsupported model is used (default: `\"warn\"`)\n *\n * @returns A middleware instance that can be passed to `createAgent`\n *\n * @throws {Error} If used with non-Anthropic models\n *\n * @example\n * Basic usage with default settings\n * ```typescript\n * import { createAgent } from \"langchain\";\n * import { anthropicPromptCachingMiddleware } from \"langchain\";\n *\n * const agent = createAgent({\n *   model: \"anthropic:claude-3-5-sonnet\",\n *   middleware: [\n *     anthropicPromptCachingMiddleware()\n *   ]\n * });\n * ```\n *\n * @example\n * Custom configuration for longer conversations\n * ```typescript\n * const cachingMiddleware = anthropicPromptCachingMiddleware({\n *   ttl: \"1h\",  // Cache for 1 hour instead of default 5 minutes\n *   minMessagesToCache: 5  // Only cache after 5 messages\n * });\n *\n * const agent = createAgent({\n *   model: \"anthropic:claude-3-5-sonnet\",\n *   systemPrompt: \"You are a helpful assistant with deep knowledge of...\", // Long system prompt\n *   middleware: [cachingMiddleware]\n * });\n * ```\n *\n * @example\n * Conditional caching based on runtime context\n * ```typescript\n * const agent = createAgent({\n *   model: \"anthropic:claude-3-5-sonnet\",\n *   middleware: [\n *     anthropicPromptCachingMiddleware({\n *       enableCaching: true,\n *       ttl: \"5m\"\n *     })\n *   ]\n * });\n *\n * // Disable caching for specific requests\n * await agent.invoke(\n *   { messages: [new HumanMessage(\"Process this without caching\")] },\n *   {\n *     configurable: {\n *       middleware_context: { enableCaching: false }\n *     }\n *   }\n * );\n * ```\n *\n * @example\n * Optimal setup for customer support chatbot\n * ```typescript\n * const supportAgent = createAgent({\n *   model: \"anthropic:claude-3-5-sonnet\",\n *   systemPrompt: `You are a customer support agent for ACME Corp.\n *\n *     Company policies:\n *     - Always be polite and professional\n *     - Refer to knowledge base for product information\n *     - Escalate billing issues to human agents\n *     ... (extensive policies and guidelines)\n *   `,\n *   tools: [searchKnowledgeBase, createTicket, checkOrderStatus],\n *   middleware: [\n *     anthropicPromptCachingMiddleware({\n *       ttl: \"1h\",  // Long TTL for stable system prompt\n *       minMessagesToCache: 1  // Cache immediately due to large system prompt\n *     })\n *   ]\n * });\n * ```\n *\n * @remarks\n * - **Anthropic Only**: This middleware only works with Anthropic models and will throw an error if used with other providers\n * - **Automatic Application**: Caching is applied automatically when message count exceeds `minMessagesToCache`\n * - **Cache Scope**: Caches are isolated per API key and cannot be shared across different keys\n * - **TTL Options**: Only supports \"5m\" (5 minutes) and \"1h\" (1 hour) as TTL values per Anthropic's API\n * - **Best Use Cases**: Long system prompts, multi-turn conversations, repetitive queries, RAG applications\n * - **Cost Impact**: Cached tokens are billed at 10% of the base input token price, cache writes are billed at 25% of the base\n *\n * @see {@link createAgent} for agent creation\n * @see {@link https://docs.anthropic.com/en/docs/build-with-claude/prompt-caching} Anthropic's prompt caching documentation\n * @public\n */\nexport function anthropicPromptCachingMiddleware(\n  middlewareOptions?: PromptCachingMiddlewareConfig\n) {\n  return createMiddleware({\n    name: \"PromptCachingMiddleware\",\n    contextSchema,\n    wrapModelCall: (request, handler) => {\n      /**\n       * Prefer runtime context values over middleware options values over defaults\n       */\n      const enableCaching =\n        request.runtime.context.enableCaching ??\n        middlewareOptions?.enableCaching ??\n        DEFAULT_ENABLE_CACHING;\n      const ttl =\n        request.runtime.context.ttl ?? middlewareOptions?.ttl ?? DEFAULT_TTL;\n      const minMessagesToCache =\n        request.runtime.context.minMessagesToCache ??\n        middlewareOptions?.minMessagesToCache ??\n        DEFAULT_MIN_MESSAGES_TO_CACHE;\n      const unsupportedModelBehavior =\n        request.runtime.context.unsupportedModelBehavior ??\n        middlewareOptions?.unsupportedModelBehavior ??\n        DEFAULT_UNSUPPORTED_MODEL_BEHAVIOR;\n\n      // Skip if caching is disabled\n      if (!enableCaching || !request.model) {\n        return handler(request);\n      }\n\n      const isAnthropicModel =\n        request.model.getName() === \"ChatAnthropic\" ||\n        (request.model.getName() === \"ConfigurableModel\" &&\n          (request.model as ConfigurableModel)._defaultConfig?.modelProvider ===\n            \"anthropic\");\n      if (!isAnthropicModel) {\n        // Get model name for better error context\n        const modelName = request.model.getName();\n        const modelInfo =\n          request.model.getName() === \"ConfigurableModel\"\n            ? `${modelName} (${\n                (request.model as ConfigurableModel)._defaultConfig\n                  ?.modelProvider\n              })`\n            : modelName;\n\n        const baseMessage = `Unsupported model '${modelInfo}'. Prompt caching requires an Anthropic model`;\n\n        if (unsupportedModelBehavior === \"raise\") {\n          throw new PromptCachingMiddlewareError(\n            `${baseMessage} (e.g., 'anthropic:claude-4-0-sonnet').`\n          );\n        } else if (unsupportedModelBehavior === \"warn\") {\n          console.warn(\n            `PromptCachingMiddleware: Skipping caching for ${modelName}. Consider switching to an Anthropic model for caching benefits.`\n          );\n        }\n        return handler(request);\n      }\n\n      const messagesCount =\n        request.state.messages.length + (request.systemPrompt ? 1 : 0);\n\n      if (messagesCount < minMessagesToCache) {\n        return handler(request);\n      }\n\n      /**\n       * Add cache_control to the last message\n       */\n      const lastMessage = request.messages.at(-1);\n      if (!lastMessage) {\n        return handler(request);\n      }\n\n      const NewMessageConstructor =\n        Object.getPrototypeOf(lastMessage).constructor;\n      if (Array.isArray(lastMessage.content)) {\n        const newMessage = new NewMessageConstructor({\n          ...lastMessage,\n          content: [\n            ...lastMessage.content.slice(0, -1),\n            {\n              ...lastMessage.content.at(-1),\n              cache_control: {\n                type: \"ephemeral\",\n                ttl,\n              },\n            } as ContentBlock,\n          ],\n        });\n        return handler({\n          ...request,\n          messages: [...request.messages.slice(0, -1), newMessage],\n        });\n      } else if (typeof lastMessage.content === \"string\") {\n        const newMessage = new NewMessageConstructor({\n          ...lastMessage,\n          content: [\n            {\n              type: \"text\",\n              text: lastMessage.content,\n              cache_control: {\n                type: \"ephemeral\",\n                ttl,\n              },\n            },\n          ],\n        });\n        return handler({\n          ...request,\n          messages: [...request.messages.slice(0, -1), newMessage],\n        });\n      }\n\n      throw new PromptCachingMiddlewareError(\n        \"Last message content is not a string or array\"\n      );\n    },\n  });\n}\n"],"mappings":";;;;AAOA,MAAM,yBAAyB;AAC/B,MAAM,cAAc;AACpB,MAAM,gCAAgC;AACtC,MAAM,qCAAqC;AAE3C,MAAM,gBAAgB,EAAE,OAAO;CAK7B,eAAe,EAAE,SAAS,CAAC,UAAU;CAKrC,KAAK,EAAE,KAAK,CAAC,MAAM,IAAK,EAAC,CAAC,UAAU;CAKpC,oBAAoB,EAAE,QAAQ,CAAC,UAAU;CAQzC,0BAA0B,EAAE,KAAK;EAAC;EAAU;EAAQ;CAAQ,EAAC,CAAC,UAAU;AACzE,EAAC;AAKF,IAAM,+BAAN,cAA2C,MAAM;CAC/C,YAAYA,SAAiB;EAC3B,MAAM,QAAQ;EACd,KAAK,OAAO;CACb;AACF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAwHD,SAAgB,iCACdC,mBACA;AACA,QAAO,iBAAiB;EACtB,MAAM;EACN;EACA,eAAe,CAAC,SAAS,YAAY;;;;GAInC,MAAM,gBACJ,QAAQ,QAAQ,QAAQ,iBACxB,mBAAmB,iBACnB;GACF,MAAM,MACJ,QAAQ,QAAQ,QAAQ,OAAO,mBAAmB,OAAO;GAC3D,MAAM,qBACJ,QAAQ,QAAQ,QAAQ,sBACxB,mBAAmB,sBACnB;GACF,MAAM,2BACJ,QAAQ,QAAQ,QAAQ,4BACxB,mBAAmB,4BACnB;AAGF,OAAI,CAAC,iBAAiB,CAAC,QAAQ,MAC7B,QAAO,QAAQ,QAAQ;GAGzB,MAAM,mBACJ,QAAQ,MAAM,SAAS,KAAK,mBAC3B,QAAQ,MAAM,SAAS,KAAK,uBAC1B,QAAQ,MAA4B,gBAAgB,kBACnD;AACN,OAAI,CAAC,kBAAkB;IAErB,MAAM,YAAY,QAAQ,MAAM,SAAS;IACzC,MAAM,YACJ,QAAQ,MAAM,SAAS,KAAK,sBACxB,GAAG,UAAU,EAAE,EACZ,QAAQ,MAA4B,gBACjC,cACL,CAAC,CAAC,GACH;IAEN,MAAM,cAAc,CAAC,mBAAmB,EAAE,UAAU,6CAA6C,CAAC;AAElG,QAAI,6BAA6B,QAC/B,OAAM,IAAI,6BACR,GAAG,YAAY,uCAAuC,CAAC;aAEhD,6BAA6B,QACtC,QAAQ,KACN,CAAC,8CAA8C,EAAE,UAAU,gEAAgE,CAAC,CAC7H;AAEH,WAAO,QAAQ,QAAQ;GACxB;GAED,MAAM,gBACJ,QAAQ,MAAM,SAAS,UAAU,QAAQ,eAAe,IAAI;AAE9D,OAAI,gBAAgB,mBAClB,QAAO,QAAQ,QAAQ;;;;GAMzB,MAAM,cAAc,QAAQ,SAAS,GAAG,GAAG;AAC3C,OAAI,CAAC,YACH,QAAO,QAAQ,QAAQ;GAGzB,MAAM,wBACJ,OAAO,eAAe,YAAY,CAAC;AACrC,OAAI,MAAM,QAAQ,YAAY,QAAQ,EAAE;IACtC,MAAM,aAAa,IAAI,sBAAsB;KAC3C,GAAG;KACH,SAAS,CACP,GAAG,YAAY,QAAQ,MAAM,GAAG,GAAG,EACnC;MACE,GAAG,YAAY,QAAQ,GAAG,GAAG;MAC7B,eAAe;OACb,MAAM;OACN;MACD;KACF,CACF;IACF;AACD,WAAO,QAAQ;KACb,GAAG;KACH,UAAU,CAAC,GAAG,QAAQ,SAAS,MAAM,GAAG,GAAG,EAAE,UAAW;IACzD,EAAC;GACH,WAAU,OAAO,YAAY,YAAY,UAAU;IAClD,MAAM,aAAa,IAAI,sBAAsB;KAC3C,GAAG;KACH,SAAS,CACP;MACE,MAAM;MACN,MAAM,YAAY;MAClB,eAAe;OACb,MAAM;OACN;MACD;KACF,CACF;IACF;AACD,WAAO,QAAQ;KACb,GAAG;KACH,UAAU,CAAC,GAAG,QAAQ,SAAS,MAAM,GAAG,GAAG,EAAE,UAAW;IACzD,EAAC;GACH;AAED,SAAM,IAAI,6BACR;EAEH;CACF,EAAC;AACH"}

package/dist/agents/middleware/provider/openai/moderation.cjs

@@ -0,0 +1,299 @@
+const require_rolldown_runtime = require('../../../../_virtual/rolldown_runtime.cjs');
+const require_chat_models_universal = require('../../../../chat_models/universal.cjs');
+const require_middleware = require('../../../middleware.cjs');
+const __langchain_core_messages = require_rolldown_runtime.__toESM(require("@langchain/core/messages"));
+
+//#region src/agents/middleware/provider/openai/moderation.ts
+/**
+* Check if the model is an OpenAI model that supports moderation.
+* @param model - The model to check.
+* @returns Whether the model is an OpenAI model that supports moderation.
+*/
+function isOpenAIModel(model) {
+	if (!model || typeof model !== "object" || model === null || !("client" in model) || !("_getClientOptions" in model) || typeof model._getClientOptions !== "function") return false;
+	/**
+	* client may not yet be initialized, so we need to check if the model has a _getClientOptions method.
+	*/
+	model._getClientOptions();
+	return typeof model.client === "object" && model.client !== null && "moderations" in model.client && typeof model.client.moderations === "object" && model.client.moderations !== null && "create" in model.client.moderations && typeof model.client.moderations.create === "function";
+}
+/**
+* Default template for violation messages.
+*/
+const DEFAULT_VIOLATION_TEMPLATE = "I'm sorry, but I can't comply with that request. It was flagged for {categories}.";
+/**
+* Error raised when OpenAI flags content and `exitBehavior` is set to `"error"`.
+*/
+var OpenAIModerationError = class extends Error {
+	content;
+	stage;
+	result;
+	originalMessage;
+	constructor({ content, stage, result, message }) {
+		super(message);
+		this.name = "OpenAIModerationError";
+		this.content = content;
+		this.stage = stage;
+		this.result = result;
+		this.originalMessage = message;
+	}
+};
+/**
+* Middleware that moderates agent traffic using OpenAI's moderation endpoint.
+*
+* This middleware checks messages for content policy violations at different stages:
+* - Input: User messages before they reach the model
+* - Output: AI model responses
+* - Tool results: Results returned from tool executions
+*
+* @param options - Configuration options for the middleware
+* @param options.model - OpenAI model to use for moderation. Can be either a model name or a BaseChatModel instance.
+* @param options.moderationModel - Moderation model to use.
+* @param options.checkInput - Whether to check user input messages.
+* @param options.checkOutput - Whether to check model output messages.
+* @param options.checkToolResults - Whether to check tool result messages.
+* @param options.exitBehavior - How to handle violations.
+* @param options.violationMessage - Custom template for violation messages.
+* @returns Middleware function that can be used to moderate agent traffic.
+*
+* @example  Using model instance
+* ```ts
+* import { createAgent, openAIModerationMiddleware } from "langchain";
+*
+* const middleware = openAIModerationMiddleware({
+*   checkInput: true,
+*   checkOutput: true,
+*   exitBehavior: "end"
+* });
+*
+* const agent = createAgent({
+*   model: "openai:gpt-4o",
+*   tools: [...],
+*   middleware: [middleware],
+* });
+* ```
+*
+* @example Using model name
+* ```ts
+* import { createAgent, openAIModerationMiddleware } from "langchain";
+*
+* const middleware = openAIModerationMiddleware({
+*   model: "gpt-4o-mini",
+*   checkInput: true,
+*   checkOutput: true,
+*   exitBehavior: "end"
+* });
+*
+* const agent = createAgent({
+*   model: "openai:gpt-4o",
+*   tools: [...],
+*   middleware: [middleware],
+* });
+* ```
+*
+* @example Custom violation message
+* ```ts
+* const middleware = openAIModerationMiddleware({
+*   violationMessage: "Content flagged: {categories}. Scores: {category_scores}"
+* });
+* ```
+*/
+function openAIModerationMiddleware(options) {
+	const { model, moderationModel = "omni-moderation-latest", checkInput = true, checkOutput = true, checkToolResults = false, exitBehavior = "end", violationMessage } = options;
+	let openaiModel;
+	const initModerationModel = async () => {
+		if (openaiModel) return openaiModel;
+		const resolvedModel = typeof model === "string" ? await require_chat_models_universal.initChatModel(model) : model;
+		/**
+		* Check if the model is an OpenAI model.
+		*/
+		if (!resolvedModel.getName().includes("ChatOpenAI")) throw new Error(`Model must be an OpenAI model to use moderation middleware. Got: ${resolvedModel.getName()}`);
+		/**
+		* check if OpenAI model package supports moderation.
+		*/
+		if (!isOpenAIModel(resolvedModel)) throw new Error("Model must support moderation to use moderation middleware.");
+		openaiModel = resolvedModel;
+		return openaiModel;
+	};
+	/**
+	* Extract text content from a message.
+	*/
+	const extractText = (message) => {
+		if (message.content == null) return null;
+		const text = message.text;
+		return text || null;
+	};
+	/**
+	* Find the last index of a message type in the messages array.
+	*/
+	const findLastIndex = (messages, messageType) => {
+		for (let idx = messages.length - 1; idx >= 0; idx--) if (messageType.isInstance(messages[idx])) return idx;
+		return null;
+	};
+	/**
+	* Format violation message from moderation result.
+	*/
+	const formatViolationMessage = (content, result) => {
+		const categories = [];
+		const categoriesObj = result.categories;
+		for (const [name, flagged] of Object.entries(categoriesObj)) if (flagged) categories.push(name.replace(/_/g, " "));
+		const categoryLabel = categories.length > 0 ? categories.join(", ") : "OpenAI's safety policies";
+		const template = violationMessage || DEFAULT_VIOLATION_TEMPLATE;
+		const scoresJson = JSON.stringify(result.category_scores, null, 2);
+		try {
+			return template.replace("{categories}", categoryLabel).replace("{category_scores}", scoresJson).replace("{original_content}", content);
+		} catch {
+			return template;
+		}
+	};
+	function moderateContent(input, params) {
+		const clientOptions = openaiModel?._getClientOptions?.();
+		const moderationModel$1 = params?.model ?? "omni-moderation-latest";
+		const moderationRequest = {
+			input,
+			model: moderationModel$1
+		};
+		return openaiModel.client.moderations.create(moderationRequest, clientOptions);
+	}
+	/**
+	* Apply violation handling based on exit behavior.
+	*/
+	const applyViolation = (messages, index, stage, content, result) => {
+		const violationText = formatViolationMessage(content, result);
+		if (exitBehavior === "error") throw new OpenAIModerationError({
+			content,
+			stage,
+			result,
+			message: violationText
+		});
+		if (exitBehavior === "end") return {
+			jumpTo: "end",
+			messages: [new __langchain_core_messages.AIMessage({ content: violationText })]
+		};
+		if (index == null) return void 0;
+		/**
+		* Replace the original message with a new message that contains the violation text.
+		*/
+		const newMessages = [...messages];
+		const original = newMessages[index];
+		const MessageConstructor = Object.getPrototypeOf(original).constructor;
+		newMessages[index] = new MessageConstructor({
+			...original,
+			content: violationText
+		});
+		return { messages: newMessages };
+	};
+	/**
+	* Moderate user input messages.
+	*/
+	const moderateUserMessage = async (messages) => {
+		const idx = findLastIndex(messages, __langchain_core_messages.HumanMessage);
+		if (idx == null) return null;
+		const message = messages[idx];
+		const text = extractText(message);
+		if (!text) return null;
+		await initModerationModel();
+		const response = await moderateContent(text, { model: moderationModel });
+		const flaggedResult = response.results.find((result) => result.flagged);
+		if (!flaggedResult) return null;
+		return applyViolation(messages, idx, "input", text, flaggedResult);
+	};
+	/**
+	* Moderate tool result messages.
+	*/
+	const moderateToolMessages = async (messages) => {
+		const lastAiIdx = findLastIndex(messages, __langchain_core_messages.AIMessage);
+		if (lastAiIdx == null) return null;
+		const working = [...messages];
+		let modified = false;
+		for (let idx = lastAiIdx + 1; idx < working.length; idx++) {
+			const msg = working[idx];
+			if (!__langchain_core_messages.ToolMessage.isInstance(msg)) continue;
+			const text = extractText(msg);
+			if (!text) continue;
+			await initModerationModel();
+			const response = await moderateContent(text, { model: moderationModel });
+			const flaggedResult = response.results.find((result) => result.flagged);
+			if (!flaggedResult) continue;
+			const action = applyViolation(working, idx, "tool", text, flaggedResult);
+			if (action) {
+				if ("jumpTo" in action) return action;
+				if ("messages" in action) {
+					working.splice(0, working.length, ...action.messages);
+					modified = true;
+				}
+			}
+		}
+		if (modified) return { messages: working };
+		return null;
+	};
+	/**
+	* Moderate model output messages.
+	*/
+	const moderateOutput = async (messages) => {
+		const lastAiIdx = findLastIndex(messages, __langchain_core_messages.AIMessage);
+		if (lastAiIdx == null) return null;
+		const aiMessage = messages[lastAiIdx];
+		const text = extractText(aiMessage);
+		if (!text) return null;
+		await initModerationModel();
+		const response = await moderateContent(text, { model: moderationModel });
+		const flaggedResult = response.results.find((result) => result.flagged);
+		if (!flaggedResult) return null;
+		return applyViolation(messages, lastAiIdx, "output", text, flaggedResult);
+	};
+	/**
+	* Moderate inputs (user messages and tool results) before model call.
+	*/
+	const moderateInputs = async (messages) => {
+		const working = [...messages];
+		let modified = false;
+		if (checkToolResults) {
+			const action = await moderateToolMessages(working);
+			if (action) {
+				if ("jumpTo" in action) return action;
+				if ("messages" in action) {
+					working.splice(0, working.length, ...action.messages);
+					modified = true;
+				}
+			}
+		}
+		if (checkInput) {
+			const action = await moderateUserMessage(working);
+			if (action) {
+				if ("jumpTo" in action) return action;
+				if ("messages" in action) {
+					working.splice(0, working.length, ...action.messages);
+					modified = true;
+				}
+			}
+		}
+		if (modified) return { messages: working };
+		return null;
+	};
+	return require_middleware.createMiddleware({
+		name: "OpenAIModerationMiddleware",
+		beforeModel: {
+			hook: async (state) => {
+				if (!checkInput && !checkToolResults) return void 0;
+				const messages = state.messages || [];
+				if (messages.length === 0) return void 0;
+				return await moderateInputs(messages) ?? void 0;
+			},
+			canJumpTo: ["end"]
+		},
+		afterModel: {
+			hook: async (state) => {
+				if (!checkOutput) return void 0;
+				const messages = state.messages || [];
+				if (messages.length === 0) return void 0;
+				return await moderateOutput(messages) ?? void 0;
+			},
+			canJumpTo: ["end"]
+		}
+	});
+}
+
+//#endregion
+exports.openAIModerationMiddleware = openAIModerationMiddleware;
+//# sourceMappingURL=moderation.cjs.map

package/dist/agents/middleware/provider/openai/moderation.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"moderation.cjs","names":["model: unknown","options: OpenAIModerationMiddlewareOptions","openaiModel: OpenAIModel | undefined","initChatModel","message: BaseMessage","messages: BaseMessage[]","messageType: typeof AIMessage | typeof HumanMessage | typeof ToolMessage","content: string","result: ModerationResult","categories: string[]","input: string | string[]","params?: { model?: ModerationModel; options?: unknown }","moderationModel","index: number | null","stage: ViolationStage","AIMessage","HumanMessage","ToolMessage","createMiddleware"],"sources":["../../../../../src/agents/middleware/provider/openai/moderation.ts"],"sourcesContent":["import type { BaseMessage } from \"@langchain/core/messages\";\nimport { AIMessage, HumanMessage, ToolMessage } from \"@langchain/core/messages\";\nimport type { BaseChatModel } from \"@langchain/core/language_models/chat_models\";\nimport { BaseLanguageModel } from \"@langchain/core/language_models/base\";\n\nimport { initChatModel } from \"../../../../chat_models/universal.js\";\nimport { createMiddleware } from \"../../../middleware.js\";\nimport type { MiddlewareResult, AgentMiddleware } from \"../../types.js\";\nimport type { AgentBuiltInState } from \"../../../runtime.js\";\n\n/**\n * OpenAI model interface.\n */\ninterface OpenAIModel extends BaseLanguageModel {\n  getName: () => string;\n  _getClientOptions: () => unknown;\n  client: {\n    moderations: {\n      create: (\n        input: {\n          input: string | string[];\n          model: string;\n        },\n        options?: unknown\n      ) => Promise<ModerationResponse>;\n    };\n  };\n}\n\n/**\n * Check if the model is an OpenAI model that supports moderation.\n * @param model - The model to check.\n * @returns Whether the model is an OpenAI model that supports moderation.\n */\nfunction isOpenAIModel(model: unknown): model is OpenAIModel {\n  if (\n    !model ||\n    typeof model !== \"object\" ||\n    model === null ||\n    !(\"client\" in model) ||\n    !(\"_getClientOptions\" in model) ||\n    typeof model._getClientOptions !== \"function\"\n  ) {\n    return false;\n  }\n\n  /**\n   * client may not yet be initialized, so we need to check if the model has a _getClientOptions method.\n   */\n  model._getClientOptions();\n  return (\n    typeof model.client === \"object\" &&\n    model.client !== null &&\n    \"moderations\" in model.client &&\n    typeof model.client.moderations === \"object\" &&\n    model.client.moderations !== null &&\n    \"create\" in model.client.moderations &&\n    typeof model.client.moderations.create === \"function\"\n  );\n}\n\n/**\n * Stage where a violation occurred.\n */\nexport type ViolationStage = \"input\" | \"output\" | \"tool\";\n\n/**\n * Default template for violation messages.\n */\nconst DEFAULT_VIOLATION_TEMPLATE =\n  \"I'm sorry, but I can't comply with that request. It was flagged for {categories}.\";\n\n/**\n * Result of moderation.\n * @see https://platform.openai.com/docs/api-reference/moderations/object\n */\ninterface ModerationResult {\n  flagged: boolean;\n  categories: Record<string, boolean>;\n  category_scores: Record<string, number>;\n  category_applied_input_types: Record<string, string[]>;\n}\n\n/**\n * Moderation response.\n * @see https://platform.openai.com/docs/api-reference/moderations/create\n */\ninterface ModerationResponse {\n  id: string;\n  model: string;\n  results: ModerationResult[];\n}\n\ntype ModerationModel =\n  | \"omni-moderation-latest\"\n  | \"omni-moderation-2024-09-26\"\n  | \"text-moderation-latest\"\n  | \"text-moderation-stable\";\n\n/**\n * Error raised when OpenAI flags content and `exitBehavior` is set to `\"error\"`.\n */\nexport class OpenAIModerationError extends Error {\n  content: string;\n  stage: ViolationStage;\n  result: ModerationResult;\n  originalMessage: string;\n\n  constructor({\n    content,\n    stage,\n    result,\n    message,\n  }: {\n    content: string;\n    stage: ViolationStage;\n    result: ModerationResult;\n    message: string;\n  }) {\n    super(message);\n    this.name = \"OpenAIModerationError\";\n    this.content = content;\n    this.stage = stage;\n    this.result = result;\n    this.originalMessage = message;\n  }\n}\n\n/**\n * Options for configuring the OpenAI Moderation middleware.\n */\nexport interface OpenAIModerationMiddlewareOptions {\n  /**\n   * OpenAI model to use for moderation. Can be either a model name or a BaseChatModel instance.\n   * @example\n   * ```ts\n   * const model = new ChatOpenAI({ model: \"gpt-4o-mini\" });\n   * const middleware = openAIModerationMiddleware({ model });\n   * const agent = createAgent({\n   *   model,\n   *   middleware: [middleware],\n   * });\n   * ```\n   * @example\n   * ```ts\n   * const middleware = openAIModerationMiddleware({ model: \"gpt-4o-mini\" });\n   * const agent = createAgent({\n   *   model: \"gpt-5\",\n   *   middleware: [middleware],\n   * });\n   * ```\n   */\n  model: string | BaseChatModel;\n\n  /**\n   * Moderation model to use.\n   * @default \"omni-moderation-latest\"\n   */\n  moderationModel?: ModerationModel;\n\n  /**\n   * Whether to check user input messages.\n   * @default true\n   */\n  checkInput?: boolean;\n\n  /**\n   * Whether to check model output messages.\n   * @default true\n   */\n  checkOutput?: boolean;\n\n  /**\n   * Whether to check tool result messages.\n   * @default false\n   */\n  checkToolResults?: boolean;\n\n  /**\n   * How to handle violations.\n   * - `\"error\"`: Throw an error when content is flagged\n   * - `\"end\"`: End the agent execution and return a violation message\n   * - `\"replace\"`: Replace the flagged content with a violation message\n   * @default \"end\"\n   */\n  exitBehavior?: \"error\" | \"end\" | \"replace\";\n\n  /**\n   * Custom template for violation messages.\n   * Available placeholders: `{categories}`, `{category_scores}`, `{original_content}`\n   */\n  violationMessage?: string;\n}\n\n/**\n * Middleware that moderates agent traffic using OpenAI's moderation endpoint.\n *\n * This middleware checks messages for content policy violations at different stages:\n * - Input: User messages before they reach the model\n * - Output: AI model responses\n * - Tool results: Results returned from tool executions\n *\n * @param options - Configuration options for the middleware\n * @param options.model - OpenAI model to use for moderation. Can be either a model name or a BaseChatModel instance.\n * @param options.moderationModel - Moderation model to use.\n * @param options.checkInput - Whether to check user input messages.\n * @param options.checkOutput - Whether to check model output messages.\n * @param options.checkToolResults - Whether to check tool result messages.\n * @param options.exitBehavior - How to handle violations.\n * @param options.violationMessage - Custom template for violation messages.\n * @returns Middleware function that can be used to moderate agent traffic.\n *\n * @example  Using model instance\n * ```ts\n * import { createAgent, openAIModerationMiddleware } from \"langchain\";\n *\n * const middleware = openAIModerationMiddleware({\n *   checkInput: true,\n *   checkOutput: true,\n *   exitBehavior: \"end\"\n * });\n *\n * const agent = createAgent({\n *   model: \"openai:gpt-4o\",\n *   tools: [...],\n *   middleware: [middleware],\n * });\n * ```\n *\n * @example Using model name\n * ```ts\n * import { createAgent, openAIModerationMiddleware } from \"langchain\";\n *\n * const middleware = openAIModerationMiddleware({\n *   model: \"gpt-4o-mini\",\n *   checkInput: true,\n *   checkOutput: true,\n *   exitBehavior: \"end\"\n * });\n *\n * const agent = createAgent({\n *   model: \"openai:gpt-4o\",\n *   tools: [...],\n *   middleware: [middleware],\n * });\n * ```\n *\n * @example Custom violation message\n * ```ts\n * const middleware = openAIModerationMiddleware({\n *   violationMessage: \"Content flagged: {categories}. Scores: {category_scores}\"\n * });\n * ```\n */\nexport function openAIModerationMiddleware(\n  options: OpenAIModerationMiddlewareOptions\n): AgentMiddleware {\n  const {\n    model,\n    moderationModel = \"omni-moderation-latest\",\n    checkInput = true,\n    checkOutput = true,\n    checkToolResults = false,\n    exitBehavior = \"end\",\n    violationMessage,\n  } = options;\n\n  let openaiModel: OpenAIModel | undefined;\n  const initModerationModel = async (): Promise<OpenAIModel> => {\n    if (openaiModel) {\n      return openaiModel;\n    }\n\n    const resolvedModel =\n      typeof model === \"string\" ? await initChatModel(model) : model;\n\n    /**\n     * Check if the model is an OpenAI model.\n     */\n    if (!resolvedModel.getName().includes(\"ChatOpenAI\")) {\n      throw new Error(\n        `Model must be an OpenAI model to use moderation middleware. Got: ${resolvedModel.getName()}`\n      );\n    }\n\n    /**\n     * check if OpenAI model package supports moderation.\n     */\n    if (!isOpenAIModel(resolvedModel)) {\n      throw new Error(\n        \"Model must support moderation to use moderation middleware.\"\n      );\n    }\n\n    openaiModel = resolvedModel as unknown as OpenAIModel;\n    return openaiModel;\n  };\n\n  /**\n   * Extract text content from a message.\n   */\n  const extractText = (message: BaseMessage): string | null => {\n    if (message.content == null) {\n      return null;\n    }\n    const text = message.text;\n    return text || null;\n  };\n\n  /**\n   * Find the last index of a message type in the messages array.\n   */\n  const findLastIndex = (\n    messages: BaseMessage[],\n    messageType: typeof AIMessage | typeof HumanMessage | typeof ToolMessage\n  ): number | null => {\n    for (let idx = messages.length - 1; idx >= 0; idx--) {\n      if (messageType.isInstance(messages[idx])) {\n        return idx;\n      }\n    }\n    return null;\n  };\n\n  /**\n   * Format violation message from moderation result.\n   */\n  const formatViolationMessage = (\n    content: string,\n    result: ModerationResult\n  ): string => {\n    // Convert categories to array of flagged category names\n    const categories: string[] = [];\n    const categoriesObj = result.categories as unknown as Record<\n      string,\n      boolean\n    >;\n    for (const [name, flagged] of Object.entries(categoriesObj)) {\n      if (flagged) {\n        categories.push(name.replace(/_/g, \" \"));\n      }\n    }\n\n    const categoryLabel =\n      categories.length > 0\n        ? categories.join(\", \")\n        : \"OpenAI's safety policies\";\n\n    const template = violationMessage || DEFAULT_VIOLATION_TEMPLATE;\n    const scoresJson = JSON.stringify(\n      result.category_scores as unknown as Record<string, number>,\n      null,\n      2\n    );\n\n    try {\n      return template\n        .replace(\"{categories}\", categoryLabel)\n        .replace(\"{category_scores}\", scoresJson)\n        .replace(\"{original_content}\", content);\n    } catch {\n      return template;\n    }\n  };\n\n  function moderateContent(\n    input: string | string[],\n    params?: { model?: ModerationModel; options?: unknown }\n  ): Promise<ModerationResponse> {\n    const clientOptions = openaiModel?._getClientOptions?.();\n    const moderationModel = params?.model ?? \"omni-moderation-latest\";\n    const moderationRequest = {\n      input,\n      model: moderationModel,\n    };\n    return openaiModel!.client.moderations.create(\n      moderationRequest,\n      clientOptions\n    );\n  }\n\n  /**\n   * Apply violation handling based on exit behavior.\n   */\n  const applyViolation = (\n    messages: BaseMessage[],\n    index: number | null,\n    stage: ViolationStage,\n    content: string,\n    result: ModerationResult\n  ): MiddlewareResult<Partial<AgentBuiltInState>> | undefined => {\n    const violationText = formatViolationMessage(content, result);\n\n    if (exitBehavior === \"error\") {\n      throw new OpenAIModerationError({\n        content,\n        stage,\n        result,\n        message: violationText,\n      });\n    }\n\n    if (exitBehavior === \"end\") {\n      return {\n        jumpTo: \"end\",\n        messages: [new AIMessage({ content: violationText })],\n      };\n    }\n\n    if (index == null) {\n      return undefined;\n    }\n\n    /**\n     * Replace the original message with a new message that contains the violation text.\n     */\n    const newMessages = [...messages];\n    const original = newMessages[index];\n    const MessageConstructor = Object.getPrototypeOf(original).constructor;\n    newMessages[index] = new MessageConstructor({\n      ...original,\n      content: violationText,\n    });\n\n    return { messages: newMessages };\n  };\n\n  /**\n   * Moderate user input messages.\n   */\n  const moderateUserMessage = async (\n    messages: BaseMessage[]\n  ): Promise<MiddlewareResult<Partial<AgentBuiltInState>> | null> => {\n    const idx = findLastIndex(messages, HumanMessage);\n    if (idx == null) {\n      return null;\n    }\n\n    const message = messages[idx];\n    const text = extractText(message);\n    if (!text) {\n      return null;\n    }\n\n    await initModerationModel();\n    const response = await moderateContent(text, {\n      model: moderationModel,\n    });\n\n    const flaggedResult = response.results.find((result) => result.flagged);\n    if (!flaggedResult) {\n      return null;\n    }\n\n    return applyViolation(messages, idx, \"input\", text, flaggedResult);\n  };\n\n  /**\n   * Moderate tool result messages.\n   */\n  const moderateToolMessages = async (\n    messages: BaseMessage[]\n  ): Promise<MiddlewareResult<Partial<AgentBuiltInState>> | null> => {\n    const lastAiIdx = findLastIndex(messages, AIMessage);\n    if (lastAiIdx == null) {\n      return null;\n    }\n\n    const working = [...messages];\n    let modified = false;\n\n    for (let idx = lastAiIdx + 1; idx < working.length; idx++) {\n      const msg = working[idx];\n      if (!ToolMessage.isInstance(msg)) {\n        continue;\n      }\n\n      const text = extractText(msg);\n      if (!text) {\n        continue;\n      }\n\n      await initModerationModel();\n      const response = await moderateContent(text, {\n        model: moderationModel,\n      });\n      const flaggedResult = response.results.find((result) => result.flagged);\n      if (!flaggedResult) {\n        continue;\n      }\n\n      const action = applyViolation(working, idx, \"tool\", text, flaggedResult);\n      if (action) {\n        if (\"jumpTo\" in action) {\n          return action;\n        }\n        if (\"messages\" in action) {\n          working.splice(\n            0,\n            working.length,\n            ...(action.messages as BaseMessage[])\n          );\n          modified = true;\n        }\n      }\n    }\n\n    if (modified) {\n      return { messages: working };\n    }\n\n    return null;\n  };\n\n  /**\n   * Moderate model output messages.\n   */\n  const moderateOutput = async (\n    messages: BaseMessage[]\n  ): Promise<MiddlewareResult<Partial<AgentBuiltInState>> | null> => {\n    const lastAiIdx = findLastIndex(messages, AIMessage);\n    if (lastAiIdx == null) {\n      return null;\n    }\n\n    const aiMessage = messages[lastAiIdx];\n    const text = extractText(aiMessage);\n    if (!text) {\n      return null;\n    }\n\n    await initModerationModel();\n    const response = await moderateContent(text, {\n      model: moderationModel,\n    });\n    const flaggedResult = response.results.find((result) => result.flagged);\n    if (!flaggedResult) {\n      return null;\n    }\n\n    return applyViolation(messages, lastAiIdx, \"output\", text, flaggedResult);\n  };\n\n  /**\n   * Moderate inputs (user messages and tool results) before model call.\n   */\n  const moderateInputs = async (\n    messages: BaseMessage[]\n  ): Promise<MiddlewareResult<Partial<AgentBuiltInState>> | null> => {\n    const working = [...messages];\n    let modified = false;\n\n    if (checkToolResults) {\n      const action = await moderateToolMessages(working);\n      if (action) {\n        if (\"jumpTo\" in action) {\n          return action;\n        }\n        if (\"messages\" in action) {\n          working.splice(\n            0,\n            working.length,\n            ...(action.messages as BaseMessage[])\n          );\n          modified = true;\n        }\n      }\n    }\n\n    if (checkInput) {\n      const action = await moderateUserMessage(working);\n      if (action) {\n        if (\"jumpTo\" in action) {\n          return action;\n        }\n        if (\"messages\" in action) {\n          working.splice(\n            0,\n            working.length,\n            ...(action.messages as BaseMessage[])\n          );\n          modified = true;\n        }\n      }\n    }\n\n    if (modified) {\n      return { messages: working };\n    }\n\n    return null;\n  };\n\n  return createMiddleware({\n    name: \"OpenAIModerationMiddleware\",\n    beforeModel: {\n      hook: async (\n        state\n      ): Promise<MiddlewareResult<Partial<AgentBuiltInState>> | undefined> => {\n        if (!checkInput && !checkToolResults) {\n          return undefined;\n        }\n\n        const messages = state.messages || [];\n        if (messages.length === 0) {\n          return undefined;\n        }\n\n        return (await moderateInputs(messages)) ?? undefined;\n      },\n      canJumpTo: [\"end\"],\n    },\n    afterModel: {\n      hook: async (\n        state\n      ): Promise<MiddlewareResult<Partial<AgentBuiltInState>> | undefined> => {\n        if (!checkOutput) {\n          return undefined;\n        }\n\n        const messages = state.messages || [];\n        if (messages.length === 0) {\n          return undefined;\n        }\n\n        return (await moderateOutput(messages)) ?? undefined;\n      },\n      canJumpTo: [\"end\"],\n    },\n  });\n}\n"],"mappings":";;;;;;;;;;;AAkCA,SAAS,cAAcA,OAAsC;AAC3D,KACE,CAAC,SACD,OAAO,UAAU,YACjB,UAAU,QACV,EAAE,YAAY,UACd,EAAE,uBAAuB,UACzB,OAAO,MAAM,sBAAsB,WAEnC,QAAO;;;;CAMT,MAAM,mBAAmB;AACzB,QACE,OAAO,MAAM,WAAW,YACxB,MAAM,WAAW,QACjB,iBAAiB,MAAM,UACvB,OAAO,MAAM,OAAO,gBAAgB,YACpC,MAAM,OAAO,gBAAgB,QAC7B,YAAY,MAAM,OAAO,eACzB,OAAO,MAAM,OAAO,YAAY,WAAW;AAE9C;;;;AAUD,MAAM,6BACJ;;;;AAgCF,IAAa,wBAAb,cAA2C,MAAM;CAC/C;CACA;CACA;CACA;CAEA,YAAY,EACV,SACA,OACA,QACA,SAMD,EAAE;EACD,MAAM,QAAQ;EACd,KAAK,OAAO;EACZ,KAAK,UAAU;EACf,KAAK,QAAQ;EACb,KAAK,SAAS;EACd,KAAK,kBAAkB;CACxB;AACF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAgID,SAAgB,2BACdC,SACiB;CACjB,MAAM,EACJ,OACA,kBAAkB,0BAClB,aAAa,MACb,cAAc,MACd,mBAAmB,OACnB,eAAe,OACf,kBACD,GAAG;CAEJ,IAAIC;CACJ,MAAM,sBAAsB,YAAkC;AAC5D,MAAI,YACF,QAAO;EAGT,MAAM,gBACJ,OAAO,UAAU,WAAW,MAAMC,4CAAc,MAAM,GAAG;;;;AAK3D,MAAI,CAAC,cAAc,SAAS,CAAC,SAAS,aAAa,CACjD,OAAM,IAAI,MACR,CAAC,iEAAiE,EAAE,cAAc,SAAS,EAAE;;;;AAOjG,MAAI,CAAC,cAAc,cAAc,CAC/B,OAAM,IAAI,MACR;EAIJ,cAAc;AACd,SAAO;CACR;;;;CAKD,MAAM,cAAc,CAACC,YAAwC;AAC3D,MAAI,QAAQ,WAAW,KACrB,QAAO;EAET,MAAM,OAAO,QAAQ;AACrB,SAAO,QAAQ;CAChB;;;;CAKD,MAAM,gBAAgB,CACpBC,UACAC,gBACkB;AAClB,OAAK,IAAI,MAAM,SAAS,SAAS,GAAG,OAAO,GAAG,MAC5C,KAAI,YAAY,WAAW,SAAS,KAAK,CACvC,QAAO;AAGX,SAAO;CACR;;;;CAKD,MAAM,yBAAyB,CAC7BC,SACAC,WACW;EAEX,MAAMC,aAAuB,CAAE;EAC/B,MAAM,gBAAgB,OAAO;AAI7B,OAAK,MAAM,CAAC,MAAM,QAAQ,IAAI,OAAO,QAAQ,cAAc,CACzD,KAAI,SACF,WAAW,KAAK,KAAK,QAAQ,MAAM,IAAI,CAAC;EAI5C,MAAM,gBACJ,WAAW,SAAS,IAChB,WAAW,KAAK,KAAK,GACrB;EAEN,MAAM,WAAW,oBAAoB;EACrC,MAAM,aAAa,KAAK,UACtB,OAAO,iBACP,MACA,EACD;AAED,MAAI;AACF,UAAO,SACJ,QAAQ,gBAAgB,cAAc,CACtC,QAAQ,qBAAqB,WAAW,CACxC,QAAQ,sBAAsB,QAAQ;EAC1C,QAAO;AACN,UAAO;EACR;CACF;CAED,SAAS,gBACPC,OACAC,QAC6B;EAC7B,MAAM,gBAAgB,aAAa,qBAAqB;EACxD,MAAMC,oBAAkB,QAAQ,SAAS;EACzC,MAAM,oBAAoB;GACxB;GACA,OAAOA;EACR;AACD,SAAO,YAAa,OAAO,YAAY,OACrC,mBACA,cACD;CACF;;;;CAKD,MAAM,iBAAiB,CACrBP,UACAQ,OACAC,OACAP,SACAC,WAC6D;EAC7D,MAAM,gBAAgB,uBAAuB,SAAS,OAAO;AAE7D,MAAI,iBAAiB,QACnB,OAAM,IAAI,sBAAsB;GAC9B;GACA;GACA;GACA,SAAS;EACV;AAGH,MAAI,iBAAiB,MACnB,QAAO;GACL,QAAQ;GACR,UAAU,CAAC,IAAIO,oCAAU,EAAE,SAAS,cAAe,EAAE;EACtD;AAGH,MAAI,SAAS,KACX,QAAO;;;;EAMT,MAAM,cAAc,CAAC,GAAG,QAAS;EACjC,MAAM,WAAW,YAAY;EAC7B,MAAM,qBAAqB,OAAO,eAAe,SAAS,CAAC;EAC3D,YAAY,SAAS,IAAI,mBAAmB;GAC1C,GAAG;GACH,SAAS;EACV;AAED,SAAO,EAAE,UAAU,YAAa;CACjC;;;;CAKD,MAAM,sBAAsB,OAC1BV,aACiE;EACjE,MAAM,MAAM,cAAc,UAAUW,uCAAa;AACjD,MAAI,OAAO,KACT,QAAO;EAGT,MAAM,UAAU,SAAS;EACzB,MAAM,OAAO,YAAY,QAAQ;AACjC,MAAI,CAAC,KACH,QAAO;EAGT,MAAM,qBAAqB;EAC3B,MAAM,WAAW,MAAM,gBAAgB,MAAM,EAC3C,OAAO,gBACR,EAAC;EAEF,MAAM,gBAAgB,SAAS,QAAQ,KAAK,CAAC,WAAW,OAAO,QAAQ;AACvE,MAAI,CAAC,cACH,QAAO;AAGT,SAAO,eAAe,UAAU,KAAK,SAAS,MAAM,cAAc;CACnE;;;;CAKD,MAAM,uBAAuB,OAC3BX,aACiE;EACjE,MAAM,YAAY,cAAc,UAAUU,oCAAU;AACpD,MAAI,aAAa,KACf,QAAO;EAGT,MAAM,UAAU,CAAC,GAAG,QAAS;EAC7B,IAAI,WAAW;AAEf,OAAK,IAAI,MAAM,YAAY,GAAG,MAAM,QAAQ,QAAQ,OAAO;GACzD,MAAM,MAAM,QAAQ;AACpB,OAAI,CAACE,sCAAY,WAAW,IAAI,CAC9B;GAGF,MAAM,OAAO,YAAY,IAAI;AAC7B,OAAI,CAAC,KACH;GAGF,MAAM,qBAAqB;GAC3B,MAAM,WAAW,MAAM,gBAAgB,MAAM,EAC3C,OAAO,gBACR,EAAC;GACF,MAAM,gBAAgB,SAAS,QAAQ,KAAK,CAAC,WAAW,OAAO,QAAQ;AACvE,OAAI,CAAC,cACH;GAGF,MAAM,SAAS,eAAe,SAAS,KAAK,QAAQ,MAAM,cAAc;AACxE,OAAI,QAAQ;AACV,QAAI,YAAY,OACd,QAAO;AAET,QAAI,cAAc,QAAQ;KACxB,QAAQ,OACN,GACA,QAAQ,QACR,GAAI,OAAO,SACZ;KACD,WAAW;IACZ;GACF;EACF;AAED,MAAI,SACF,QAAO,EAAE,UAAU,QAAS;AAG9B,SAAO;CACR;;;;CAKD,MAAM,iBAAiB,OACrBZ,aACiE;EACjE,MAAM,YAAY,cAAc,UAAUU,oCAAU;AACpD,MAAI,aAAa,KACf,QAAO;EAGT,MAAM,YAAY,SAAS;EAC3B,MAAM,OAAO,YAAY,UAAU;AACnC,MAAI,CAAC,KACH,QAAO;EAGT,MAAM,qBAAqB;EAC3B,MAAM,WAAW,MAAM,gBAAgB,MAAM,EAC3C,OAAO,gBACR,EAAC;EACF,MAAM,gBAAgB,SAAS,QAAQ,KAAK,CAAC,WAAW,OAAO,QAAQ;AACvE,MAAI,CAAC,cACH,QAAO;AAGT,SAAO,eAAe,UAAU,WAAW,UAAU,MAAM,cAAc;CAC1E;;;;CAKD,MAAM,iBAAiB,OACrBV,aACiE;EACjE,MAAM,UAAU,CAAC,GAAG,QAAS;EAC7B,IAAI,WAAW;AAEf,MAAI,kBAAkB;GACpB,MAAM,SAAS,MAAM,qBAAqB,QAAQ;AAClD,OAAI,QAAQ;AACV,QAAI,YAAY,OACd,QAAO;AAET,QAAI,cAAc,QAAQ;KACxB,QAAQ,OACN,GACA,QAAQ,QACR,GAAI,OAAO,SACZ;KACD,WAAW;IACZ;GACF;EACF;AAED,MAAI,YAAY;GACd,MAAM,SAAS,MAAM,oBAAoB,QAAQ;AACjD,OAAI,QAAQ;AACV,QAAI,YAAY,OACd,QAAO;AAET,QAAI,cAAc,QAAQ;KACxB,QAAQ,OACN,GACA,QAAQ,QACR,GAAI,OAAO,SACZ;KACD,WAAW;IACZ;GACF;EACF;AAED,MAAI,SACF,QAAO,EAAE,UAAU,QAAS;AAG9B,SAAO;CACR;AAED,QAAOa,oCAAiB;EACtB,MAAM;EACN,aAAa;GACX,MAAM,OACJ,UACsE;AACtE,QAAI,CAAC,cAAc,CAAC,iBAClB,QAAO;IAGT,MAAM,WAAW,MAAM,YAAY,CAAE;AACrC,QAAI,SAAS,WAAW,EACtB,QAAO;AAGT,WAAQ,MAAM,eAAe,SAAS,IAAK;GAC5C;GACD,WAAW,CAAC,KAAM;EACnB;EACD,YAAY;GACV,MAAM,OACJ,UACsE;AACtE,QAAI,CAAC,YACH,QAAO;IAGT,MAAM,WAAW,MAAM,YAAY,CAAE;AACrC,QAAI,SAAS,WAAW,EACtB,QAAO;AAGT,WAAQ,MAAM,eAAe,SAAS,IAAK;GAC5C;GACD,WAAW,CAAC,KAAM;EACnB;CACF,EAAC;AACH"}

package/dist/agents/middleware/provider/openai/moderation.d.cts

@@ -0,0 +1,133 @@
+import { AgentMiddleware } from "../../types.cjs";
+import { BaseChatModel } from "@langchain/core/language_models/chat_models";
+
+//#region src/agents/middleware/provider/openai/moderation.d.ts
+
+type ModerationModel = "omni-moderation-latest" | "omni-moderation-2024-09-26" | "text-moderation-latest" | "text-moderation-stable";
+/**
+ * Error raised when OpenAI flags content and `exitBehavior` is set to `"error"`.
+ */
+
+/**
+ * Options for configuring the OpenAI Moderation middleware.
+ */
+interface OpenAIModerationMiddlewareOptions {
+  /**
+   * OpenAI model to use for moderation. Can be either a model name or a BaseChatModel instance.
+   * @example
+   * ```ts
+   * const model = new ChatOpenAI({ model: "gpt-4o-mini" });
+   * const middleware = openAIModerationMiddleware({ model });
+   * const agent = createAgent({
+   *   model,
+   *   middleware: [middleware],
+   * });
+   * ```
+   * @example
+   * ```ts
+   * const middleware = openAIModerationMiddleware({ model: "gpt-4o-mini" });
+   * const agent = createAgent({
+   *   model: "gpt-5",
+   *   middleware: [middleware],
+   * });
+   * ```
+   */
+  model: string | BaseChatModel;
+  /**
+   * Moderation model to use.
+   * @default "omni-moderation-latest"
+   */
+  moderationModel?: ModerationModel;
+  /**
+   * Whether to check user input messages.
+   * @default true
+   */
+  checkInput?: boolean;
+  /**
+   * Whether to check model output messages.
+   * @default true
+   */
+  checkOutput?: boolean;
+  /**
+   * Whether to check tool result messages.
+   * @default false
+   */
+  checkToolResults?: boolean;
+  /**
+   * How to handle violations.
+   * - `"error"`: Throw an error when content is flagged
+   * - `"end"`: End the agent execution and return a violation message
+   * - `"replace"`: Replace the flagged content with a violation message
+   * @default "end"
+   */
+  exitBehavior?: "error" | "end" | "replace";
+  /**
+   * Custom template for violation messages.
+   * Available placeholders: `{categories}`, `{category_scores}`, `{original_content}`
+   */
+  violationMessage?: string;
+}
+/**
+ * Middleware that moderates agent traffic using OpenAI's moderation endpoint.
+ *
+ * This middleware checks messages for content policy violations at different stages:
+ * - Input: User messages before they reach the model
+ * - Output: AI model responses
+ * - Tool results: Results returned from tool executions
+ *
+ * @param options - Configuration options for the middleware
+ * @param options.model - OpenAI model to use for moderation. Can be either a model name or a BaseChatModel instance.
+ * @param options.moderationModel - Moderation model to use.
+ * @param options.checkInput - Whether to check user input messages.
+ * @param options.checkOutput - Whether to check model output messages.
+ * @param options.checkToolResults - Whether to check tool result messages.
+ * @param options.exitBehavior - How to handle violations.
+ * @param options.violationMessage - Custom template for violation messages.
+ * @returns Middleware function that can be used to moderate agent traffic.
+ *
+ * @example  Using model instance
+ * ```ts
+ * import { createAgent, openAIModerationMiddleware } from "langchain";
+ *
+ * const middleware = openAIModerationMiddleware({
+ *   checkInput: true,
+ *   checkOutput: true,
+ *   exitBehavior: "end"
+ * });
+ *
+ * const agent = createAgent({
+ *   model: "openai:gpt-4o",
+ *   tools: [...],
+ *   middleware: [middleware],
+ * });
+ * ```
+ *
+ * @example Using model name
+ * ```ts
+ * import { createAgent, openAIModerationMiddleware } from "langchain";
+ *
+ * const middleware = openAIModerationMiddleware({
+ *   model: "gpt-4o-mini",
+ *   checkInput: true,
+ *   checkOutput: true,
+ *   exitBehavior: "end"
+ * });
+ *
+ * const agent = createAgent({
+ *   model: "openai:gpt-4o",
+ *   tools: [...],
+ *   middleware: [middleware],
+ * });
+ * ```
+ *
+ * @example Custom violation message
+ * ```ts
+ * const middleware = openAIModerationMiddleware({
+ *   violationMessage: "Content flagged: {categories}. Scores: {category_scores}"
+ * });
+ * ```
+ */
+declare function openAIModerationMiddleware(options: OpenAIModerationMiddlewareOptions): AgentMiddleware;
+//#endregion
+export { OpenAIModerationMiddlewareOptions, openAIModerationMiddleware };
+//# sourceMappingURL=moderation.d.cts.map