@aigne/core 1.72.0-beta.2 → 1.72.0-beta.3

package/CHANGELOG.md

@@ -1,5 +1,19 @@
 # Changelog
 
+## [1.72.0-beta.3](https://github.com/AIGNE-io/aigne-framework/compare/core-v1.72.0-beta.2...core-v1.72.0-beta.3) (2025-12-19)
+
+
+### Features
+
+* add prompt caching for OpenAI/Gemini/Anthropic and cache token display ([#838](https://github.com/AIGNE-io/aigne-framework/issues/838)) ([46c628f](https://github.com/AIGNE-io/aigne-framework/commit/46c628f180572ea1b955d1a9888aad6145204842))
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @aigne/observability-api bumped to 0.11.14-beta.1
+
 ## [1.72.0-beta.2](https://github.com/AIGNE-io/aigne-framework/compare/core-v1.72.0-beta.1...core-v1.72.0-beta.2) (2025-12-19)
 
 

package/lib/cjs/agents/chat-model.d.ts

@@ -203,6 +203,13 @@ export interface ChatModelInputMessage {
      * Name of the message sender (for multi-agent scenarios)
      */
     name?: string;
+    /**
+     * Cache control marker for the entire message (only supported by Claude)
+     *
+     * This is syntactic sugar that applies cacheControl to the last content block
+     * of the message. See {@link CacheControl} for details.
+     */
+    cacheControl?: CacheControl;
 }
 /**
  * Type of input message content
@@ -218,27 +225,64 @@ export type ChatModelInputMessageContent = string | UnionContent[];
 export type TextContent = {
     type: "text";
     text: string;
+    /**
+     * Cache control marker (only supported by Claude)
+     *
+     * When set, this content block will be marked as a cache breakpoint.
+     * See {@link CacheControl} for details.
+     */
+    cacheControl?: CacheControl;
 };
 export declare const textContentSchema: z.ZodObject<{
     type: z.ZodLiteral<"text">;
     text: z.ZodString;
+    cacheControl: ZodType<{
+        type: "ephemeral";
+        ttl?: "5m" | "1h" | undefined;
+    } | undefined, z.ZodTypeDef, {
+        type: "ephemeral";
+        ttl?: "5m" | "1h" | undefined;
+    } | undefined>;
 }, "strip", z.ZodTypeAny, {
     type: "text";
     text: string;
+    cacheControl?: {
+        type: "ephemeral";
+        ttl?: "5m" | "1h" | undefined;
+    } | undefined;
 }, {
     type: "text";
     text: string;
+    cacheControl?: {
+        type: "ephemeral";
+        ttl?: "5m" | "1h" | undefined;
+    } | undefined;
 }>;
 export type UnionContent = TextContent | FileUnionContent;
 export declare const unionContentSchema: z.ZodDiscriminatedUnion<"type", [z.ZodObject<{
     type: z.ZodLiteral<"text">;
     text: z.ZodString;
+    cacheControl: ZodType<{
+        type: "ephemeral";
+        ttl?: "5m" | "1h" | undefined;
+    } | undefined, z.ZodTypeDef, {
+        type: "ephemeral";
+        ttl?: "5m" | "1h" | undefined;
+    } | undefined>;
 }, "strip", z.ZodTypeAny, {
     type: "text";
     text: string;
+    cacheControl?: {
+        type: "ephemeral";
+        ttl?: "5m" | "1h" | undefined;
+    } | undefined;
 }, {
     type: "text";
     text: string;
+    cacheControl?: {
+        type: "ephemeral";
+        ttl?: "5m" | "1h" | undefined;
+    } | undefined;
 }>, z.ZodObject<{
     filename: ZodType<string | undefined, z.ZodTypeDef, string | undefined>;
     mimeType: ZodType<string | undefined, z.ZodTypeDef, string | undefined>;
@@ -340,6 +384,14 @@ export interface ChatModelInputTool {
      * For example, Gemini's thought_signature
      */
     metadata?: Record<string, any>;
+    /**
+     * Cache control marker (only supported by Claude)
+     *
+     * When set, this tool definition will be marked as a cache breakpoint.
+     * Typically applied to the last tool in the tools array.
+     * See {@link CacheControl} for details.
+     */
+    cacheControl?: CacheControl;
 }
 /**
  * Tool selection strategy
@@ -362,6 +414,82 @@ export type ChatModelInputToolChoice = "auto" | "none" | "required" | {
     };
 };
 export type Modality = "text" | "image" | "audio";
+/**
+ * Cache control marker for prompt caching
+ *
+ * Used to mark content blocks, messages, or tools for caching.
+ * Currently only supported by Anthropic (Claude) models.
+ */
+export interface CacheControl {
+    /**
+     * Cache type (currently only "ephemeral" is supported)
+     */
+    type: "ephemeral";
+    /**
+     * Cache TTL (Time To Live)
+     * - "5m": 5 minutes (default)
+     * - "1h": 1 hour
+     */
+    ttl?: "5m" | "1h";
+}
+/**
+ * Cache configuration options
+ *
+ * Controls how prompt caching is used for supported providers.
+ * Prompt caching can significantly reduce costs and latency by reusing
+ * previously processed prompts (system messages, tool definitions, etc.).
+ */
+export interface CacheConfig {
+    /**
+     * Whether to enable prompt caching
+     *
+     * - OpenAI: Ignored (always enabled automatically)
+     * - Gemini: Controls explicit caching
+     * - Claude: Controls whether to add cache_control markers
+     *
+     * @default true
+     */
+    enabled?: boolean;
+    /**
+     * Cache TTL (Time To Live)
+     *
+     * - OpenAI: Ignored (automatic)
+     * - Gemini: Supports custom seconds
+     * - Claude: Only supports "5m" or "1h"
+     *
+     * @default "5m"
+     */
+    ttl?: "5m" | "1h" | number;
+    /**
+     * Caching strategy
+     *
+     * - "auto": Automatically add cache breakpoints at optimal locations
+     * - "manual": Require explicit cacheControl markers on messages/tools
+     *
+     * @default "auto"
+     */
+    strategy?: "auto" | "manual";
+    /**
+     * Auto cache breakpoint locations (only effective when strategy="auto")
+     *
+     * @default { tools: true, system: true, lastMessage: false }
+     */
+    autoBreakpoints?: {
+        /** Cache tool definitions */
+        tools?: boolean;
+        /** Cache system messages */
+        system?: boolean;
+        /** Cache last message in conversation history */
+        lastMessage?: boolean;
+    };
+}
+/**
+ * Default cache configuration
+ *
+ * Enables automatic caching for system messages and tool definitions,
+ * which typically provides the best cost/performance tradeoff.
+ */
+export declare const DEFAULT_CACHE_CONFIG: CacheConfig;
 /**
  * Model-specific configuration options
  *
@@ -395,6 +523,15 @@ export interface ChatModelInputOptions extends Record<string, unknown> {
     modalities?: Modality[];
     preferInputFileType?: "file" | "url";
     reasoningEffort?: number | "minimal" | "low" | "medium" | "high";
+    /**
+     * Cache configuration for prompt caching
+     *
+     * Enables caching of system messages, tool definitions, and conversation history
+     * to reduce costs and latency. See {@link CacheConfig} for details.
+     *
+     * @default DEFAULT_CACHE_CONFIG (enabled with auto strategy)
+     */
+    cacheConfig?: CacheConfig;
 }
 export type ChatModelInputOptionsWithGetter = GetterSchema<ChatModelInputOptions>;
 /**
@@ -492,6 +629,16 @@ export interface ChatModelOutputUsage {
      * AIGNE Hub credit usage
      */
     aigneHubCredits?: number;
+    /**
+     * Number of tokens written to cache (first time caching)
+     * Only applicable for providers that support explicit cache creation (e.g., Anthropic)
+     */
+    cacheCreationInputTokens?: number;
+    /**
+     * Number of tokens read from cache (cache hit)
+     * Supported by OpenAI, Anthropic, and Gemini
+     */
+    cacheReadInputTokens?: number;
     /**
      * Credit prefix
      */
@@ -501,15 +648,21 @@ export declare const chatModelOutputUsageSchema: z.ZodObject<{
     inputTokens: z.ZodNumber;
     outputTokens: z.ZodNumber;
     aigneHubCredits: ZodType<number | undefined, z.ZodTypeDef, number | undefined>;
+    cacheCreationInputTokens: ZodType<number | undefined, z.ZodTypeDef, number | undefined>;
+    cacheReadInputTokens: ZodType<number | undefined, z.ZodTypeDef, number | undefined>;
     creditPrefix: ZodType<"$" | "€" | "¥" | undefined, z.ZodTypeDef, "$" | "€" | "¥" | undefined>;
 }, "strip", z.ZodTypeAny, {
     inputTokens: number;
     outputTokens: number;
     aigneHubCredits?: number | undefined;
+    cacheCreationInputTokens?: number | undefined;
+    cacheReadInputTokens?: number | undefined;
     creditPrefix?: "$" | "€" | "¥" | undefined;
 }, {
     inputTokens: number;
     outputTokens: number;
     aigneHubCredits?: number | undefined;
+    cacheCreationInputTokens?: number | undefined;
+    cacheReadInputTokens?: number | undefined;
     creditPrefix?: "$" | "€" | "¥" | undefined;
 }>;

package/lib/cjs/agents/chat-model.js

@@ -33,7 +33,7 @@ var __importStar = (this && this.__importStar) || (function () {
     };
 })();
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.chatModelOutputUsageSchema = exports.unionContentSchema = exports.textContentSchema = exports.roleSchema = exports.ChatModel = exports.StructuredOutputError = void 0;
+exports.chatModelOutputUsageSchema = exports.DEFAULT_CACHE_CONFIG = exports.unionContentSchema = exports.textContentSchema = exports.roleSchema = exports.ChatModel = exports.StructuredOutputError = void 0;
 const index_js_1 = require("@aigne/platform-helpers/nodejs/index.js");
 const zod_1 = require("zod");
 const zod_from_json_schema_1 = require("zod-from-json-schema");
@@ -225,6 +225,10 @@ class ChatModel extends model_js_1.Model {
             options.context.usage.inputTokens += usage.inputTokens;
             if (usage.aigneHubCredits)
                 options.context.usage.aigneHubCredits += usage.aigneHubCredits;
+            if (usage.cacheCreationInputTokens)
+                options.context.usage.cacheCreationInputTokens += usage.cacheCreationInputTokens;
+            if (usage.cacheReadInputTokens)
+                options.context.usage.cacheReadInputTokens += usage.cacheReadInputTokens;
             if (usage.creditPrefix)
                 options.context.usage.creditPrefix = usage.creditPrefix;
         }
@@ -282,6 +286,10 @@ exports.roleSchema = zod_1.z.union([
 exports.textContentSchema = zod_1.z.object({
     type: zod_1.z.literal("text"),
     text: zod_1.z.string(),
+    cacheControl: (0, schema_js_1.optionalize)(zod_1.z.object({
+        type: zod_1.z.literal("ephemeral"),
+        ttl: (0, schema_js_1.optionalize)(zod_1.z.union([zod_1.z.literal("5m"), zod_1.z.literal("1h")])),
+    })),
 });
 exports.unionContentSchema = zod_1.z.discriminatedUnion("type", [
     exports.textContentSchema,
@@ -303,6 +311,10 @@ const chatModelInputMessageSchema = zod_1.z.object({
     }))),
     toolCallId: (0, schema_js_1.optionalize)(zod_1.z.string()),
     name: (0, schema_js_1.optionalize)(zod_1.z.string()),
+    cacheControl: (0, schema_js_1.optionalize)(zod_1.z.object({
+        type: zod_1.z.literal("ephemeral"),
+        ttl: (0, schema_js_1.optionalize)(zod_1.z.union([zod_1.z.literal("5m"), zod_1.z.literal("1h")])),
+    })),
 });
 const chatModelInputResponseFormatSchema = zod_1.z.discriminatedUnion("type", [
     zod_1.z.object({ type: zod_1.z.literal("text") }),
@@ -324,6 +336,10 @@ const chatModelInputToolSchema = zod_1.z.object({
         parameters: zod_1.z.record(zod_1.z.string(), zod_1.z.unknown()),
     }),
     metadata: (0, schema_js_1.optionalize)(zod_1.z.record(zod_1.z.string(), zod_1.z.unknown())),
+    cacheControl: (0, schema_js_1.optionalize)(zod_1.z.object({
+        type: zod_1.z.literal("ephemeral"),
+        ttl: (0, schema_js_1.optionalize)(zod_1.z.union([zod_1.z.literal("5m"), zod_1.z.literal("1h")])),
+    })),
 });
 const chatModelInputToolChoiceSchema = zod_1.z.union([
     zod_1.z.literal("auto"),
@@ -331,6 +347,22 @@ const chatModelInputToolChoiceSchema = zod_1.z.union([
     zod_1.z.literal("required"),
     chatModelInputToolSchema,
 ]);
+/**
+ * Default cache configuration
+ *
+ * Enables automatic caching for system messages and tool definitions,
+ * which typically provides the best cost/performance tradeoff.
+ */
+exports.DEFAULT_CACHE_CONFIG = {
+    enabled: true,
+    ttl: "5m",
+    strategy: "auto",
+    autoBreakpoints: {
+        tools: true,
+        system: true,
+        lastMessage: false,
+    },
+};
 const modelOptionsSchemaProperties = {
     model: zod_1.z.string(),
     temperature: zod_1.z.number(),
@@ -379,6 +411,8 @@ exports.chatModelOutputUsageSchema = zod_1.z.object({
     inputTokens: zod_1.z.number(),
     outputTokens: zod_1.z.number(),
     aigneHubCredits: (0, schema_js_1.optionalize)(zod_1.z.number()),
+    cacheCreationInputTokens: (0, schema_js_1.optionalize)(zod_1.z.number()),
+    cacheReadInputTokens: (0, schema_js_1.optionalize)(zod_1.z.number()),
     creditPrefix: (0, schema_js_1.optionalize)(zod_1.z.union([zod_1.z.literal("$"), zod_1.z.literal("€"), zod_1.z.literal("¥")])),
 });
 const chatModelOutputSchema = zod_1.z.object({

package/lib/cjs/agents/image-model.d.ts

@@ -196,16 +196,22 @@ export declare const imageModelOutputSchema: z.ZodObject<{
         inputTokens: z.ZodNumber;
         outputTokens: z.ZodNumber;
         aigneHubCredits: ZodType<number | undefined, z.ZodTypeDef, number | undefined>;
+        cacheCreationInputTokens: ZodType<number | undefined, z.ZodTypeDef, number | undefined>;
+        cacheReadInputTokens: ZodType<number | undefined, z.ZodTypeDef, number | undefined>;
         creditPrefix: ZodType<"$" | "€" | "¥" | undefined, z.ZodTypeDef, "$" | "€" | "¥" | undefined>;
     }, "strip", z.ZodTypeAny, {
         inputTokens: number;
         outputTokens: number;
         aigneHubCredits?: number | undefined;
+        cacheCreationInputTokens?: number | undefined;
+        cacheReadInputTokens?: number | undefined;
         creditPrefix?: "$" | "€" | "¥" | undefined;
     }, {
         inputTokens: number;
         outputTokens: number;
         aigneHubCredits?: number | undefined;
+        cacheCreationInputTokens?: number | undefined;
+        cacheReadInputTokens?: number | undefined;
         creditPrefix?: "$" | "€" | "¥" | undefined;
     }>>;
     model: z.ZodOptional<z.ZodString>;
@@ -231,6 +237,8 @@ export declare const imageModelOutputSchema: z.ZodObject<{
         inputTokens: number;
         outputTokens: number;
         aigneHubCredits?: number | undefined;
+        cacheCreationInputTokens?: number | undefined;
+        cacheReadInputTokens?: number | undefined;
         creditPrefix?: "$" | "€" | "¥" | undefined;
     } | undefined;
 }, {
@@ -255,6 +263,8 @@ export declare const imageModelOutputSchema: z.ZodObject<{
         inputTokens: number;
         outputTokens: number;
         aigneHubCredits?: number | undefined;
+        cacheCreationInputTokens?: number | undefined;
+        cacheReadInputTokens?: number | undefined;
         creditPrefix?: "$" | "€" | "¥" | undefined;
     } | undefined;
 }>;

package/lib/cjs/agents/video-model.d.ts

@@ -203,16 +203,22 @@ export declare const videoModelOutputSchema: z.ZodObject<{
         inputTokens: z.ZodNumber;
         outputTokens: z.ZodNumber;
         aigneHubCredits: ZodType<number | undefined, z.ZodTypeDef, number | undefined>;
+        cacheCreationInputTokens: ZodType<number | undefined, z.ZodTypeDef, number | undefined>;
+        cacheReadInputTokens: ZodType<number | undefined, z.ZodTypeDef, number | undefined>;
         creditPrefix: ZodType<"$" | "€" | "¥" | undefined, z.ZodTypeDef, "$" | "€" | "¥" | undefined>;
     }, "strip", z.ZodTypeAny, {
         inputTokens: number;
         outputTokens: number;
         aigneHubCredits?: number | undefined;
+        cacheCreationInputTokens?: number | undefined;
+        cacheReadInputTokens?: number | undefined;
         creditPrefix?: "$" | "€" | "¥" | undefined;
     }, {
         inputTokens: number;
         outputTokens: number;
         aigneHubCredits?: number | undefined;
+        cacheCreationInputTokens?: number | undefined;
+        cacheReadInputTokens?: number | undefined;
         creditPrefix?: "$" | "€" | "¥" | undefined;
     }>>;
     model: z.ZodOptional<z.ZodString>;
@@ -239,6 +245,8 @@ export declare const videoModelOutputSchema: z.ZodObject<{
         inputTokens: number;
         outputTokens: number;
         aigneHubCredits?: number | undefined;
+        cacheCreationInputTokens?: number | undefined;
+        cacheReadInputTokens?: number | undefined;
         creditPrefix?: "$" | "€" | "¥" | undefined;
     } | undefined;
     seconds?: number | undefined;
@@ -264,6 +272,8 @@ export declare const videoModelOutputSchema: z.ZodObject<{
         inputTokens: number;
         outputTokens: number;
         aigneHubCredits?: number | undefined;
+        cacheCreationInputTokens?: number | undefined;
+        cacheReadInputTokens?: number | undefined;
         creditPrefix?: "$" | "€" | "¥" | undefined;
     } | undefined;
     seconds?: number | undefined;

package/lib/cjs/aigne/usage.d.ts

@@ -8,6 +8,10 @@ export interface ContextUsage {
     creditPrefix?: "$" | "€" | "¥";
     agentCalls: number;
     duration: number;
+    /** Number of tokens written to cache (first time caching) */
+    cacheCreationInputTokens: number;
+    /** Number of tokens read from cache (cache hit) */
+    cacheReadInputTokens: number;
 }
 /**
  * @hidden

package/lib/cjs/aigne/usage.js

@@ -12,6 +12,8 @@ function newEmptyContextUsage() {
         aigneHubCredits: 0,
         agentCalls: 0,
         duration: 0,
+        cacheCreationInputTokens: 0,
+        cacheReadInputTokens: 0,
     };
 }
 function mergeContextUsage(usage, additional) {
@@ -25,4 +27,8 @@ function mergeContextUsage(usage, additional) {
         usage.agentCalls += additional.agentCalls;
     if (additional.duration)
         usage.duration += additional.duration;
+    if (additional.cacheCreationInputTokens)
+        usage.cacheCreationInputTokens += additional.cacheCreationInputTokens;
+    if (additional.cacheReadInputTokens)
+        usage.cacheReadInputTokens += additional.cacheReadInputTokens;
 }

package/lib/cjs/loader/agent-yaml.d.ts

@@ -72,6 +72,10 @@ export type Instructions = {
     role: Exclude<Role, "tool">;
     content: string;
     path: string;
+    cacheControl?: {
+        type: "ephemeral";
+        ttl?: "5m" | "1h";
+    };
 }[];
 export interface AIAgentSchema extends BaseAgentSchema {
     type: "ai";

package/lib/cjs/loader/agent-yaml.js

@@ -30,27 +30,37 @@ async function loadAgentFromYamlFile(path, options) {
     }, options), (error) => new Error(`Failed to validate agent definition from ${path}: ${error.message}`));
     return agent;
 }
-const instructionItemSchema = zod_1.z.union([
+const instructionItemSchema = (0, schema_js_1.camelizeSchema)(zod_1.z.union([
     zod_1.z.object({
         role: chat_model_js_1.roleSchema.default("system"),
         url: zod_1.z.string(),
+        cacheControl: (0, schema_js_1.optionalize)(zod_1.z.object({
+            type: zod_1.z.literal("ephemeral"),
+            ttl: (0, schema_js_1.optionalize)(zod_1.z.union([zod_1.z.literal("5m"), zod_1.z.literal("1h")])),
+        })),
     }),
     zod_1.z.object({
         role: chat_model_js_1.roleSchema.default("system"),
         content: zod_1.z.string(),
+        cacheControl: (0, schema_js_1.optionalize)(zod_1.z.object({
+            type: zod_1.z.literal("ephemeral"),
+            ttl: (0, schema_js_1.optionalize)(zod_1.z.union([zod_1.z.literal("5m"), zod_1.z.literal("1h")])),
+        })),
     }),
-]);
-const parseInstructionItem = ({ filepath }) => async ({ role, ...v }) => {
+]));
+const parseInstructionItem = ({ filepath }) => async ({ role, cacheControl, ...v }) => {
     if (role === "tool")
         throw new Error(`'tool' role is not allowed in instruction item in agent file ${filepath}`);
     if ("content" in v && typeof v.content === "string") {
-        return { role, content: v.content, path: filepath };
+        return { role, content: v.content, path: filepath, cacheControl };
     }
     if ("url" in v && typeof v.url === "string") {
         const url = index_js_1.nodejs.path.isAbsolute(v.url)
             ? v.url
             : index_js_1.nodejs.path.join(index_js_1.nodejs.path.dirname(filepath), v.url);
-        return index_js_1.nodejs.fs.readFile(url, "utf8").then((content) => ({ role, content, path: url }));
+        return index_js_1.nodejs.fs
+            .readFile(url, "utf8")
+            .then((content) => ({ role, content, path: url, cacheControl }));
     }
     throw new Error(`Invalid instruction item in agent file ${filepath}. Expected 'content' or 'url' property`);
 };