@celljs/ai-core 3.4.3 → 3.4.4

package/lib/common/error/error.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"error.d.ts","sourceRoot":"","sources":["../../../src/common/error/error.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,cAAc,CAAC;AAE3C,qBAAa,OAAQ,SAAQ,WAAW;gBACxB,OAAO,EAAE,MAAM;CAG9B"}
+{"version":3,"file":"error.d.ts","sourceRoot":"","sources":["../../../src/common/error/error.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,cAAc,CAAC;AAE3C,qBAAa,OAAQ,SAAQ,WAAW;gBACxB,OAAO,EAAE,MAAM;CAG9B;AAED,qBAAa,aAAc,SAAQ,OAAO;gBAC1B,OAAO,EAAE,MAAM;CAG9B"}

package/lib/common/error/error.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.AIError = void 0;
+exports.NotFoundError = exports.AIError = void 0;
 const core_1 = require("@celljs/core");
 class AIError extends core_1.CustomError {
     constructor(message) {
@@ -8,4 +8,10 @@ class AIError extends core_1.CustomError {
     }
 }
 exports.AIError = AIError;
+class NotFoundError extends AIError {
+    constructor(message) {
+        super(message);
+    }
+}
+exports.NotFoundError = NotFoundError;
 //# sourceMappingURL=error.js.map

package/lib/common/error/error.js.map

@@ -1 +1 @@
-{"version":3,"file":"error.js","sourceRoot":"","sources":["../../../src/common/error/error.ts"],"names":[],"mappings":";;;AAAA,uCAA2C;AAE3C,MAAa,OAAQ,SAAQ,kBAAW;IACpC,YAAY,OAAe;QACvB,KAAK,CAAC,OAAO,CAAC,CAAC;IACnB,CAAC;CACJ;AAJD,0BAIC"}
+{"version":3,"file":"error.js","sourceRoot":"","sources":["../../../src/common/error/error.ts"],"names":[],"mappings":";;;AAAA,uCAA2C;AAE3C,MAAa,OAAQ,SAAQ,kBAAW;IACpC,YAAY,OAAe;QACvB,KAAK,CAAC,OAAO,CAAC,CAAC;IACnB,CAAC;CACJ;AAJD,0BAIC;AAED,MAAa,aAAc,SAAQ,OAAO;IACtC,YAAY,OAAe;QACvB,KAAK,CAAC,OAAO,CAAC,CAAC;IACnB,CAAC;CACJ;AAJD,sCAIC"}

package/lib/common/model/function/function-callback-register.d.ts

@@ -0,0 +1,9 @@
+import { FunctionCallback, FunctionCallbackRegister, ToolContext } from './function-protocol';
+export declare class FunctionCallbackRegisterImpl implements FunctionCallbackRegister {
+    private functionCallbacks;
+    register(functionCallback: FunctionCallback): void;
+    unregister(functionName: string): void;
+    call(functionName: string, functionArguments: string, toolContext: ToolContext): Promise<string>;
+    resolve(functionNames: string[]): FunctionCallback[];
+}
+//# sourceMappingURL=function-callback-register.d.ts.map

package/lib/common/model/function/function-callback-register.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"function-callback-register.d.ts","sourceRoot":"","sources":["../../../../src/common/model/function/function-callback-register.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,gBAAgB,EAAE,wBAAwB,EAAE,WAAW,EAAE,MAAM,qBAAqB,CAAC;AAG9F,qBACa,4BAA6B,YAAW,wBAAwB;IAEzE,OAAO,CAAC,iBAAiB,CAAsE;IAE/F,QAAQ,CAAC,gBAAgB,EAAE,gBAAgB,GAAG,IAAI;IAIlD,UAAU,CAAC,YAAY,EAAE,MAAM,GAAG,IAAI;IAItC,IAAI,CAAC,YAAY,EAAE,MAAM,EAAE,iBAAiB,EAAE,MAAM,EAAE,WAAW,EAAE,WAAW,GAAG,OAAO,CAAC,MAAM,CAAC;IAQhG,OAAO,CAAC,aAAa,EAAE,MAAM,EAAE,GAAG,gBAAgB,EAAE;CAYvD"}

package/lib/common/model/function/function-callback-register.js

@@ -0,0 +1,43 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.FunctionCallbackRegisterImpl = void 0;
+const tslib_1 = require("tslib");
+const core_1 = require("@celljs/core");
+const function_protocol_1 = require("./function-protocol");
+const error_1 = require("../../error");
+let FunctionCallbackRegisterImpl = class FunctionCallbackRegisterImpl {
+    constructor() {
+        this.functionCallbacks = new Map();
+    }
+    register(functionCallback) {
+        this.functionCallbacks.set(functionCallback.name, functionCallback);
+    }
+    unregister(functionName) {
+        this.functionCallbacks.delete(functionName);
+    }
+    call(functionName, functionArguments, toolContext) {
+        const functionCallback = this.functionCallbacks.get(functionName);
+        if (functionCallback) {
+            return functionCallback.call(functionArguments, toolContext);
+        }
+        throw new error_1.NotFoundError(`Function ${functionName} not found`);
+    }
+    resolve(functionNames) {
+        const functionCallbacks = [];
+        new Set(functionNames).forEach(functionName => {
+            const functionCallback = this.functionCallbacks.get(functionName);
+            if (functionCallback) {
+                functionCallbacks.push(functionCallback);
+            }
+            else {
+                throw new error_1.NotFoundError(`No function callback found for name: ${functionName}`);
+            }
+        });
+        return functionCallbacks;
+    }
+};
+FunctionCallbackRegisterImpl = tslib_1.__decorate([
+    (0, core_1.Component)(function_protocol_1.FunctionCallbackRegister)
+], FunctionCallbackRegisterImpl);
+exports.FunctionCallbackRegisterImpl = FunctionCallbackRegisterImpl;
+//# sourceMappingURL=function-callback-register.js.map

package/lib/common/model/function/function-callback-register.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"function-callback-register.js","sourceRoot":"","sources":["../../../../src/common/model/function/function-callback-register.ts"],"names":[],"mappings":";;;;AAAA,uCAAyC;AACzC,2DAA8F;AAC9F,uCAA4C;AAGrC,IAAM,4BAA4B,GAAlC,MAAM,4BAA4B;IAAlC;QAEK,sBAAiB,GAAkC,IAAI,GAAG,EAA4B,CAAC;IA8BnG,CAAC;IA5BG,QAAQ,CAAC,gBAAkC;QACvC,IAAI,CAAC,iBAAiB,CAAC,GAAG,CAAC,gBAAgB,CAAC,IAAI,EAAE,gBAAgB,CAAC,CAAC;IACxE,CAAC;IAED,UAAU,CAAC,YAAoB;QAC3B,IAAI,CAAC,iBAAiB,CAAC,MAAM,CAAC,YAAY,CAAC,CAAC;IAChD,CAAC;IAED,IAAI,CAAC,YAAoB,EAAE,iBAAyB,EAAE,WAAwB;QAC1E,MAAM,gBAAgB,GAAG,IAAI,CAAC,iBAAiB,CAAC,GAAG,CAAC,YAAY,CAAC,CAAC;QAClE,IAAI,gBAAgB,EAAE;YAClB,OAAO,gBAAgB,CAAC,IAAI,CAAC,iBAAiB,EAAE,WAAW,CAAC,CAAC;SAChE;QACD,MAAM,IAAI,qBAAa,CAAC,YAAY,YAAY,YAAY,CAAC,CAAC;IAClE,CAAC;IAED,OAAO,CAAC,aAAuB;QAC3B,MAAM,iBAAiB,GAAuB,EAAE,CAAC;QACjD,IAAI,GAAG,CAAC,aAAa,CAAC,CAAC,OAAO,CAAC,YAAY,CAAC,EAAE;YAC1C,MAAM,gBAAgB,GAAG,IAAI,CAAC,iBAAiB,CAAC,GAAG,CAAC,YAAY,CAAC,CAAC;YAClE,IAAI,gBAAgB,EAAE;gBAClB,iBAAiB,CAAC,IAAI,CAAC,gBAAgB,CAAC,CAAC;aAC5C;iBAAM;gBACH,MAAM,IAAI,qBAAa,CAAC,wCAAwC,YAAY,EAAE,CAAC,CAAC;aACnF;QACL,CAAC,CAAC,CAAC;QACH,OAAO,iBAAiB,CAAC;IAC7B,CAAC;CACJ,CAAA;AAhCY,4BAA4B;IADxC,IAAA,gBAAS,EAAC,4CAAwB,CAAC;GACvB,4BAA4B,CAgCxC;AAhCY,oEAA4B"}

package/lib/common/model/function/function-protocol.d.ts

@@ -1,4 +1,10 @@
 import { ChatOptions } from '../../chat/prompt';
+export declare const FunctionCallbackRegister: unique symbol;
+export interface ToolContext extends Record<string, any> {
+}
+export declare namespace ToolContext {
+    const TOOL_CALL_HISTORY = "TOOL_CALL_HISTORY";
+}
 /**
  * Represents a model function call handler. Implementations are registered with the
  * Models and called on prompts that trigger the function call.
@@ -23,9 +29,10 @@ export interface FunctionCallback {
      * @param functionArguments JSON string with the function arguments to be passed to the
      * function. The arguments are defined as JSON schema usually registered with the the
      * model.
+     * @param toolContext Optional tool context to be passed to the function call.
      * @return String containing the function call response.
      */
-    call(functionArguments: string): Promise<string>;
+    call(functionArguments: string, toolContext?: ToolContext): Promise<string>;
 }
 export interface FunctionCallingOptions {
     /**
@@ -40,10 +47,29 @@ export interface FunctionCallingOptions {
      * List of function names from the ChatClient registry to be used in the next
      * chat completion requests.
      */
-    functions: Set<String>;
+    functions: Set<string>;
+    proxyToolCalls?: boolean;
+    toolContext?: ToolContext;
 }
 export declare namespace FunctionCallingOptions {
     function is(obj: any): obj is FunctionCallingOptions;
+    function getEnabledFunctionsToCall(runtimeFunctionOptions: FunctionCallingOptions): Set<string>;
+    /**
+     * Check if the proxyToolCalls is enabled for the given prompt or the default tool
+     * call options. The prompt options take precedence over the default options. When the
+     * proxyToolCalls is enabled the ChatModel implementation will pass the proxyToolCalls to the
+     * function call.
+     * @param chatOptions the chat options to check.
+     * @param defaultOptions the default tool call options to check.
+     * @return true if the proxyToolCalls is enabled, false otherwise.
+     */
+    function isProxyToolCalls(chatOptions: ChatOptions, defaultOptions: FunctionCallingOptions): boolean;
+}
+export interface FunctionCallbackRegister {
+    resolve(functionNames: string[]): FunctionCallback[];
+    register(functionCallback: FunctionCallback): void;
+    unregister(functionName: string): void;
+    call(functionName: string, functionArguments: string, toolContext: ToolContext): Promise<string>;
 }
 export interface PortableFunctionCallingOptions extends FunctionCallingOptions, ChatOptions {
 }

package/lib/common/model/function/function-protocol.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"function-protocol.d.ts","sourceRoot":"","sources":["../../../../src/common/model/function/function-protocol.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,mBAAmB,CAAC;AAEhD;;;GAGG;AACH,MAAM,WAAW,gBAAgB;IAE7B;;OAEG;IACH,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IAEtB;;;OAGG;IACH,QAAQ,CAAC,WAAW,EAAE,MAAM,CAAC;IAE7B;;OAEG;IACH,QAAQ,CAAC,eAAe,EAAE,MAAM,CAAC;IAEjC;;;;;;;OAOG;IACH,IAAI,CAAC,iBAAiB,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC;CAEpD;AAED,MAAM,WAAW,sBAAsB;IAEnC;;;;;;OAMG;IACH,iBAAiB,EAAE,gBAAgB,EAAE,CAAC;IAEtC;;;OAGG;IACH,SAAS,EAAE,GAAG,CAAC,MAAM,CAAC,CAAC;CAC1B;AAED,yBAAiB,sBAAsB,CAAC;IACpC,SAAgB,EAAE,CAAC,GAAG,EAAE,GAAG,GAAG,GAAG,IAAI,sBAAsB,CAE1D;CACJ;AAED,MAAM,WAAW,8BAA+B,SAAQ,sBAAsB,EAAE,WAAW;CAE1F"}
+{"version":3,"file":"function-protocol.d.ts","sourceRoot":"","sources":["../../../../src/common/model/function/function-protocol.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,mBAAmB,CAAC;AAEhD,eAAO,MAAM,wBAAwB,eAAqC,CAAC;AAE3E,MAAM,WAAW,WAAY,SAAQ,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC;CAAG;AAE3D,yBAAiB,WAAW,CAAC;IAClB,MAAM,iBAAiB,sBAAsB,CAAC;CACxD;AAED;;;GAGG;AACH,MAAM,WAAW,gBAAgB;IAE7B;;OAEG;IACH,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IAEtB;;;OAGG;IACH,QAAQ,CAAC,WAAW,EAAE,MAAM,CAAC;IAE7B;;OAEG;IACH,QAAQ,CAAC,eAAe,EAAE,MAAM,CAAC;IAEjC;;;;;;;;OAQG;IACH,IAAI,CAAC,iBAAiB,EAAE,MAAM,EAAE,WAAW,CAAC,EAAE,WAAW,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC;CAE/E;AAED,MAAM,WAAW,sBAAsB;IAEnC;;;;;;OAMG;IACH,iBAAiB,EAAE,gBAAgB,EAAE,CAAC;IAEtC;;;OAGG;IACH,SAAS,EAAE,GAAG,CAAC,MAAM,CAAC,CAAC;IAEvB,cAAc,CAAC,EAAE,OAAO,CAAC;IAEzB,WAAW,CAAC,EAAE,WAAW,CAAC;CAC7B;AAED,yBAAiB,sBAAsB,CAAC;IACpC,SAAgB,EAAE,CAAC,GAAG,EAAE,GAAG,GAAG,GAAG,IAAI,sBAAsB,CAE1D;IAED,SAAgB,yBAAyB,CAAC,sBAAsB,EAAE,sBAAsB,GAAG,GAAG,CAAC,MAAM,CAAC,CAkBrG;IAED;;;;;;;;OAQG;IACH,SAAgB,gBAAgB,CAAC,WAAW,EAAE,WAAW,EAAE,cAAc,EAAE,sBAAsB,GAAG,OAAO,CAK1G;CAEJ;AAED,MAAM,WAAW,wBAAwB;IACrC,OAAO,CAAC,aAAa,EAAE,MAAM,EAAE,GAAG,gBAAgB,EAAE,CAAC;IACrD,QAAQ,CAAC,gBAAgB,EAAE,gBAAgB,GAAG,IAAI,CAAC;IACnD,UAAU,CAAC,YAAY,EAAE,MAAM,GAAG,IAAI,CAAC;IACvC,IAAI,CAAC,YAAY,EAAE,MAAM,EAAE,iBAAiB,EAAE,MAAM,EAAE,WAAW,EAAE,WAAW,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC;CACpG;AAED,MAAM,WAAW,8BAA+B,SAAQ,sBAAsB,EAAE,WAAW;CAE1F"}

package/lib/common/model/function/function-protocol.js

@@ -1,11 +1,52 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.FunctionCallingOptions = void 0;
+exports.FunctionCallingOptions = exports.ToolContext = exports.FunctionCallbackRegister = void 0;
+exports.FunctionCallbackRegister = Symbol('FunctionCallbackRegister');
+var ToolContext;
+(function (ToolContext) {
+    ToolContext.TOOL_CALL_HISTORY = 'TOOL_CALL_HISTORY';
+})(ToolContext = exports.ToolContext || (exports.ToolContext = {}));
 var FunctionCallingOptions;
 (function (FunctionCallingOptions) {
     function is(obj) {
         return obj && obj.functionCallbacks !== undefined && obj.functions !== undefined;
     }
     FunctionCallingOptions.is = is;
+    function getEnabledFunctionsToCall(runtimeFunctionOptions) {
+        const enabledFunctionsToCall = new Set();
+        if (runtimeFunctionOptions) {
+            // Add the explicitly enabled functions.
+            if (runtimeFunctionOptions.functions) {
+                runtimeFunctionOptions.functions.forEach(fn => {
+                    enabledFunctionsToCall.add(fn);
+                });
+            }
+            if (runtimeFunctionOptions.functionCallbacks) {
+                runtimeFunctionOptions.functionCallbacks.forEach(functionCallback => {
+                    // Automatically enable the function, usually from prompt callback.
+                    enabledFunctionsToCall.add(functionCallback.name);
+                });
+            }
+        }
+        return enabledFunctionsToCall;
+    }
+    FunctionCallingOptions.getEnabledFunctionsToCall = getEnabledFunctionsToCall;
+    /**
+     * Check if the proxyToolCalls is enabled for the given prompt or the default tool
+     * call options. The prompt options take precedence over the default options. When the
+     * proxyToolCalls is enabled the ChatModel implementation will pass the proxyToolCalls to the
+     * function call.
+     * @param chatOptions the chat options to check.
+     * @param defaultOptions the default tool call options to check.
+     * @return true if the proxyToolCalls is enabled, false otherwise.
+     */
+    function isProxyToolCalls(chatOptions, defaultOptions) {
+        var _a;
+        if (FunctionCallingOptions.is(chatOptions) && chatOptions.proxyToolCalls !== undefined) {
+            return chatOptions.proxyToolCalls;
+        }
+        return (_a = defaultOptions.proxyToolCalls) !== null && _a !== void 0 ? _a : false;
+    }
+    FunctionCallingOptions.isProxyToolCalls = isProxyToolCalls;
 })(FunctionCallingOptions = exports.FunctionCallingOptions || (exports.FunctionCallingOptions = {}));
 //# sourceMappingURL=function-protocol.js.map

package/lib/common/model/function/function-protocol.js.map

@@ -1 +1 @@
-{"version":3,"file":"function-protocol.js","sourceRoot":"","sources":["../../../../src/common/model/function/function-protocol.ts"],"names":[],"mappings":";;;AAsDA,IAAiB,sBAAsB,CAItC;AAJD,WAAiB,sBAAsB;IACnC,SAAgB,EAAE,CAAC,GAAQ;QACvB,OAAO,GAAG,IAAI,GAAG,CAAC,iBAAiB,KAAK,SAAS,IAAI,GAAG,CAAC,SAAS,KAAK,SAAS,CAAC;IACrF,CAAC;IAFe,yBAAE,KAEjB,CAAA;AACL,CAAC,EAJgB,sBAAsB,GAAtB,8BAAsB,KAAtB,8BAAsB,QAItC"}
+{"version":3,"file":"function-protocol.js","sourceRoot":"","sources":["../../../../src/common/model/function/function-protocol.ts"],"names":[],"mappings":";;;AAEa,QAAA,wBAAwB,GAAG,MAAM,CAAC,0BAA0B,CAAC,CAAC;AAI3E,IAAiB,WAAW,CAE3B;AAFD,WAAiB,WAAW;IACX,6BAAiB,GAAG,mBAAmB,CAAC;AACzD,CAAC,EAFgB,WAAW,GAAX,mBAAW,KAAX,mBAAW,QAE3B;AA2DD,IAAiB,sBAAsB,CAyCtC;AAzCD,WAAiB,sBAAsB;IACnC,SAAgB,EAAE,CAAC,GAAQ;QACvB,OAAO,GAAG,IAAI,GAAG,CAAC,iBAAiB,KAAK,SAAS,IAAI,GAAG,CAAC,SAAS,KAAK,SAAS,CAAC;IACrF,CAAC;IAFe,yBAAE,KAEjB,CAAA;IAED,SAAgB,yBAAyB,CAAC,sBAA8C;QACpF,MAAM,sBAAsB,GAAG,IAAI,GAAG,EAAU,CAAC;QACjD,IAAI,sBAAsB,EAAE;YACxB,wCAAwC;YACxC,IAAI,sBAAsB,CAAC,SAAS,EAAE;gBAClC,sBAAsB,CAAC,SAAS,CAAC,OAAO,CAAC,EAAE,CAAC,EAAE;oBAC1C,sBAAsB,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;gBACnC,CAAC,CAAC,CAAC;aACN;YAED,IAAI,sBAAsB,CAAC,iBAAiB,EAAE;gBAC1C,sBAAsB,CAAC,iBAAiB,CAAC,OAAO,CAAC,gBAAgB,CAAC,EAAE;oBAChE,mEAAmE;oBACnE,sBAAsB,CAAC,GAAG,CAAC,gBAAgB,CAAC,IAAI,CAAC,CAAC;gBACtD,CAAC,CAAC,CAAC;aACN;SACJ;QACD,OAAO,sBAAsB,CAAC;IAClC,CAAC;IAlBe,gDAAyB,4BAkBxC,CAAA;IAED;;;;;;;;OAQG;IACH,SAAgB,gBAAgB,CAAC,WAAwB,EAAE,cAAsC;;QAC7F,IAAI,sBAAsB,CAAC,EAAE,CAAC,WAAW,CAAC,IAAI,WAAW,CAAC,cAAc,KAAK,SAAS,EAAE;YACpF,OAAO,WAAW,CAAC,cAAc,CAAC;SACrC;QACD,OAAO,MAAA,cAAc,CAAC,cAAc,mCAAI,KAAK,CAAC;IAClD,CAAC;IALe,uCAAgB,mBAK/B,CAAA;AAEL,CAAC,EAzCgB,sBAAsB,GAAtB,8BAAsB,KAAtB,8BAAsB,QAyCtC"}

package/lib/common/model/function/index.d.ts

@@ -1,2 +1,3 @@
 export * from './function-protocol';
+export * from './function-callback-register';
 //# sourceMappingURL=index.d.ts.map

package/lib/common/model/function/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/common/model/function/index.ts"],"names":[],"mappings":"AAAA,cAAc,qBAAqB,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/common/model/function/index.ts"],"names":[],"mappings":"AAAA,cAAc,qBAAqB,CAAC;AACpC,cAAc,8BAA8B,CAAC"}

package/lib/common/model/function/index.js

@@ -2,4 +2,5 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 const tslib_1 = require("tslib");
 tslib_1.__exportStar(require("./function-protocol"), exports);
+tslib_1.__exportStar(require("./function-callback-register"), exports);
 //# sourceMappingURL=index.js.map

package/lib/common/model/function/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/common/model/function/index.ts"],"names":[],"mappings":";;;AAAA,8DAAoC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/common/model/function/index.ts"],"names":[],"mappings":";;;AAAA,8DAAoC;AACpC,uEAA6C"}

package/lib/common/utils/index.d.ts

@@ -1,3 +1,4 @@
 export * from './prompt-util';
 export * from './sse-util';
+export * from './usage-util';
 //# sourceMappingURL=index.d.ts.map

package/lib/common/utils/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/common/utils/index.ts"],"names":[],"mappings":"AAAA,cAAc,eAAe,CAAC;AAC9B,cAAc,YAAY,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/common/utils/index.ts"],"names":[],"mappings":"AAAA,cAAc,eAAe,CAAC;AAC9B,cAAc,YAAY,CAAC;AAC3B,cAAc,cAAc,CAAC"}

package/lib/common/utils/index.js

@@ -3,4 +3,5 @@ Object.defineProperty(exports, "__esModule", { value: true });
 const tslib_1 = require("tslib");
 tslib_1.__exportStar(require("./prompt-util"), exports);
 tslib_1.__exportStar(require("./sse-util"), exports);
+tslib_1.__exportStar(require("./usage-util"), exports);
 //# sourceMappingURL=index.js.map

package/lib/common/utils/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/common/utils/index.ts"],"names":[],"mappings":";;;AAAA,wDAA8B;AAC9B,qDAA2B"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/common/utils/index.ts"],"names":[],"mappings":";;;AAAA,wDAA8B;AAC9B,qDAA2B;AAC3B,uDAA6B"}

package/lib/common/utils/sse-util.d.ts

@@ -3,7 +3,7 @@ import { StreamEvent } from '../sse';
 /**
  * SSE utility class.
  */
-export declare class SSEUtil {
+export declare abstract class SSEUtil {
     static toObservable<Data>(readableStream: ReadableStream, controller?: AbortController): Observable<StreamEvent<Data>>;
     private static handleSSE;
     private static readableStreamAsyncIterable;

package/lib/common/utils/sse-util.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"sse-util.d.ts","sourceRoot":"","sources":["../../../src/common/utils/sse-util.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAc,MAAM,MAAM,CAAC;AAC9C,OAAO,EAAE,WAAW,EAA+B,MAAM,QAAQ,CAAC;AAGlE;;GAEG;AACH,qBAAa,OAAO;IAEhB,MAAM,CAAC,YAAY,CAAC,IAAI,EAAE,cAAc,EAAE,cAAc,EAAE,UAAU,CAAC,EAAE,eAAe,GAAG,UAAU,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC;IAyCtH,OAAO,CAAC,MAAM,CAAC,SAAS;IAsCxB,OAAO,CAAC,MAAM,CAAC,2BAA2B;CA0B7C"}
+{"version":3,"file":"sse-util.d.ts","sourceRoot":"","sources":["../../../src/common/utils/sse-util.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAc,MAAM,MAAM,CAAC;AAC9C,OAAO,EAAE,WAAW,EAA+B,MAAM,QAAQ,CAAC;AAGlE;;GAEG;AACH,8BAAsB,OAAO;IAEzB,MAAM,CAAC,YAAY,CAAC,IAAI,EAAE,cAAc,EAAE,cAAc,EAAE,UAAU,CAAC,EAAE,eAAe,GAAG,UAAU,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC;IAyCtH,OAAO,CAAC,MAAM,CAAC,SAAS;IAsCxB,OAAO,CAAC,MAAM,CAAC,2BAA2B;CA0B7C"}

package/lib/common/utils/sse-util.js.map

@@ -1 +1 @@
-{"version":3,"file":"sse-util.js","sourceRoot":"","sources":["../../../src/common/utils/sse-util.ts"],"names":[],"mappings":";;;AAAA,+BAA8C;AAC9C,gCAAkE;AAGlE;;GAEG;AACH,MAAa,OAAO;IAEhB,MAAM,CAAC,YAAY,CAAO,cAA8B,EAAE,UAA4B;QAClF,OAAO,IAAI,iBAAU,CAAoB,UAAU,CAAC,EAAE;YAClD,CAAC,KAAK,IAAI,EAAE;gBACR,MAAM,OAAO,GAAG,IAAI,gBAAU,EAAE,CAAC;gBACjC,MAAM,WAAW,GAAG,IAAI,qBAAe,EAAE,CAAC;gBAE1C,IAAI;oBACA,MAAM,QAAQ,GAAG,IAAI,CAAC,2BAA2B,CAAQ,cAAc,CAAC,CAAC;oBACzE,IAAI,KAAK,EAAE,MAAM,KAAK,IAAI,QAAQ,EAAE;wBAChC,MAAM,KAAK,GAAG,WAAW,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;wBACxC,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE;4BACtB,MAAM,GAAG,GAAG,OAAO,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;4BACjC,IAAI,CAAC,SAAS,CAAC,GAAG,EAAE,UAAU,EAAE,UAAU,CAAC,CAAC;yBAC/C;qBACJ;oBAED,MAAM,cAAc,GAAG,WAAW,CAAC,KAAK,EAAE,CAAC;oBAC3C,KAAK,MAAM,IAAI,IAAI,cAAc,EAAE;wBAC/B,MAAM,GAAG,GAAG,OAAO,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;wBACjC,IAAI,GAAG,EAAE;4BACL,IAAI,CAAC,SAAS,CAAC,GAAG,EAAE,UAAU,EAAE,UAAU,CAAC,CAAC;yBAC/C;qBACJ;oBAED,UAAU,CAAC,QAAQ,EAAE,CAAC;iBACzB;gBAAC,OAAO,CAAC,EAAE;oBACR,IAAI,CAAC,YAAY,KAAK,IAAI,CAAC,CAAC,IAAI,KAAK,YAAY,EAAE;wBAC/C,UAAU,CAAC,QAAQ,EAAE,CAAC;qBACzB;yBAAM;wBACH,UAAU,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;qBACvB;iBACJ;wBAAS;oBACN,UAAU,aAAV,UAAU,uBAAV,UAAU,CAAE,KAAK,EAAE,CAAC;iBACvB;YAEL,CAAC,CAAC,EAAE,CAAC;QAET,CAAC,CAAC,CAAC;IAEP,CAAC;IAEO,MAAM,CAAC,SAAS,CAAO,GAAoC,EAAE,UAAyC,EAAE,UAA4B;QACxI,IAAI,GAAG,EAAE;YACL,IAAI,GAAG,CAAC,IAAI,CAAC,UAAU,CAAC,QAAQ,CAAC,EAAE;gBAC/B,UAAU,CAAC,QAAQ,EAAE,CAAC;gBACtB,UAAU,aAAV,UAAU,uBAAV,UAAU,CAAE,KAAK,EAAE,CAAC;gBACpB,OAAO;aACV;YAED,IAAI,CAAC,GAAG,CAAC,KAAK,IAAI,GAAG,CAAC,KAAK,KAAK,OAAO,EAAE;gBACrC,IAAI,IAAI,CAAC;gBACT,IAAI;oBACA,IAAI,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;iBAC/B;gBAAC,OAAO,CAAC,EAAE;oBACR,OAAO,CAAC,KAAK,CAAC,oCAAoC,EAAE,GAAG,CAAC,IAAI,CAAC,CAAC;oBAC9D,OAAO,CAAC,KAAK,CAAC,aAAa,EAAE,GAAG,CAAC,GAAG,CAAC,CAAC;oBACtC,UAAU,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;oBACpB,OAAO;iBACV;gBAED,IAAI,IAAI,IAAI,IAAI,CAAC,KAAK,EAAE;oBACpB,UAAU,CAAC,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;oBAC7B,OAAO;iBACV;gBAED,UAAU,CAAC,IAAI,CAAC;oBACZ,KAAK,EAAE,GAAG,CAAC,KAAK;oBAChB,IAAI;oBACJ,GAAG,EAAE,GAAG,CAAC,GAAG;iBACf,CAAC,CAAC;gBAEH,IAAI,IAAI,CAAC,IAAI,KAAK,IAAI,EAAE;oBACpB,UAAU,CAAC,QAAQ,EAAE,CAAC;oBACtB,UAAU,aAAV,UAAU,uBAAV,UAAU,CAAE,KAAK,EAAE,CAAC;iBACvB;aACJ;SACJ;IACL,CAAC;IAEO,MAAM,CAAC,2BAA2B,CAAI,MAAW;QACrD,IAAI,MAAM,CAAC,MAAM,CAAC,aAAa,CAAC,EAAE;YAAC,OAAO,MAAM,CAAC;SAAE;QAEnD,MAAM,MAAM,GAAG,MAAM,CAAC,SAAS,EAAE,CAAC;QAClC,OAAO;YACH,KAAK,CAAC,IAAI;gBACN,IAAI;oBACA,MAAM,MAAM,GAAG,MAAM,MAAM,CAAC,IAAI,EAAE,CAAC;oBACnC,IAAI,MAAM,aAAN,MAAM,uBAAN,MAAM,CAAE,IAAI,EAAE;wBAAC,MAAM,CAAC,WAAW,EAAE,CAAC;qBAAE;oBAC1C,OAAO,MAAM,CAAC;iBACjB;gBAAC,OAAO,CAAC,EAAE;oBACR,MAAM,CAAC,WAAW,EAAE,CAAC;oBACrB,MAAM,CAAC,CAAC;iBACX;YACL,CAAC;YACD,KAAK,CAAC,MAAM;gBACR,MAAM,aAAa,GAAG,MAAM,CAAC,MAAM,EAAE,CAAC;gBACtC,MAAM,CAAC,WAAW,EAAE,CAAC;gBACrB,MAAM,aAAa,CAAC;gBACpB,OAAO,EAAE,IAAI,EAAE,IAAI,EAAE,KAAK,EAAE,SAAS,EAAE,CAAC;YAC5C,CAAC;YACD,CAAC,MAAM,CAAC,aAAa,CAAC;gBAClB,OAAO,IAAI,CAAC;YAChB,CAAC;SACJ,CAAC;IACN,CAAC;CACJ;AA3GD,0BA2GC"}
+{"version":3,"file":"sse-util.js","sourceRoot":"","sources":["../../../src/common/utils/sse-util.ts"],"names":[],"mappings":";;;AAAA,+BAA8C;AAC9C,gCAAkE;AAGlE;;GAEG;AACH,MAAsB,OAAO;IAEzB,MAAM,CAAC,YAAY,CAAO,cAA8B,EAAE,UAA4B;QAClF,OAAO,IAAI,iBAAU,CAAoB,UAAU,CAAC,EAAE;YAClD,CAAC,KAAK,IAAI,EAAE;gBACR,MAAM,OAAO,GAAG,IAAI,gBAAU,EAAE,CAAC;gBACjC,MAAM,WAAW,GAAG,IAAI,qBAAe,EAAE,CAAC;gBAE1C,IAAI;oBACA,MAAM,QAAQ,GAAG,IAAI,CAAC,2BAA2B,CAAQ,cAAc,CAAC,CAAC;oBACzE,IAAI,KAAK,EAAE,MAAM,KAAK,IAAI,QAAQ,EAAE;wBAChC,MAAM,KAAK,GAAG,WAAW,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;wBACxC,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE;4BACtB,MAAM,GAAG,GAAG,OAAO,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;4BACjC,IAAI,CAAC,SAAS,CAAC,GAAG,EAAE,UAAU,EAAE,UAAU,CAAC,CAAC;yBAC/C;qBACJ;oBAED,MAAM,cAAc,GAAG,WAAW,CAAC,KAAK,EAAE,CAAC;oBAC3C,KAAK,MAAM,IAAI,IAAI,cAAc,EAAE;wBAC/B,MAAM,GAAG,GAAG,OAAO,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;wBACjC,IAAI,GAAG,EAAE;4BACL,IAAI,CAAC,SAAS,CAAC,GAAG,EAAE,UAAU,EAAE,UAAU,CAAC,CAAC;yBAC/C;qBACJ;oBAED,UAAU,CAAC,QAAQ,EAAE,CAAC;iBACzB;gBAAC,OAAO,CAAC,EAAE;oBACR,IAAI,CAAC,YAAY,KAAK,IAAI,CAAC,CAAC,IAAI,KAAK,YAAY,EAAE;wBAC/C,UAAU,CAAC,QAAQ,EAAE,CAAC;qBACzB;yBAAM;wBACH,UAAU,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;qBACvB;iBACJ;wBAAS;oBACN,UAAU,aAAV,UAAU,uBAAV,UAAU,CAAE,KAAK,EAAE,CAAC;iBACvB;YAEL,CAAC,CAAC,EAAE,CAAC;QAET,CAAC,CAAC,CAAC;IAEP,CAAC;IAEO,MAAM,CAAC,SAAS,CAAO,GAAoC,EAAE,UAAyC,EAAE,UAA4B;QACxI,IAAI,GAAG,EAAE;YACL,IAAI,GAAG,CAAC,IAAI,CAAC,UAAU,CAAC,QAAQ,CAAC,EAAE;gBAC/B,UAAU,CAAC,QAAQ,EAAE,CAAC;gBACtB,UAAU,aAAV,UAAU,uBAAV,UAAU,CAAE,KAAK,EAAE,CAAC;gBACpB,OAAO;aACV;YAED,IAAI,CAAC,GAAG,CAAC,KAAK,IAAI,GAAG,CAAC,KAAK,KAAK,OAAO,EAAE;gBACrC,IAAI,IAAI,CAAC;gBACT,IAAI;oBACA,IAAI,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;iBAC/B;gBAAC,OAAO,CAAC,EAAE;oBACR,OAAO,CAAC,KAAK,CAAC,oCAAoC,EAAE,GAAG,CAAC,IAAI,CAAC,CAAC;oBAC9D,OAAO,CAAC,KAAK,CAAC,aAAa,EAAE,GAAG,CAAC,GAAG,CAAC,CAAC;oBACtC,UAAU,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;oBACpB,OAAO;iBACV;gBAED,IAAI,IAAI,IAAI,IAAI,CAAC,KAAK,EAAE;oBACpB,UAAU,CAAC,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;oBAC7B,OAAO;iBACV;gBAED,UAAU,CAAC,IAAI,CAAC;oBACZ,KAAK,EAAE,GAAG,CAAC,KAAK;oBAChB,IAAI;oBACJ,GAAG,EAAE,GAAG,CAAC,GAAG;iBACf,CAAC,CAAC;gBAEH,IAAI,IAAI,CAAC,IAAI,KAAK,IAAI,EAAE;oBACpB,UAAU,CAAC,QAAQ,EAAE,CAAC;oBACtB,UAAU,aAAV,UAAU,uBAAV,UAAU,CAAE,KAAK,EAAE,CAAC;iBACvB;aACJ;SACJ;IACL,CAAC;IAEO,MAAM,CAAC,2BAA2B,CAAI,MAAW;QACrD,IAAI,MAAM,CAAC,MAAM,CAAC,aAAa,CAAC,EAAE;YAAC,OAAO,MAAM,CAAC;SAAE;QAEnD,MAAM,MAAM,GAAG,MAAM,CAAC,SAAS,EAAE,CAAC;QAClC,OAAO;YACH,KAAK,CAAC,IAAI;gBACN,IAAI;oBACA,MAAM,MAAM,GAAG,MAAM,MAAM,CAAC,IAAI,EAAE,CAAC;oBACnC,IAAI,MAAM,aAAN,MAAM,uBAAN,MAAM,CAAE,IAAI,EAAE;wBAAC,MAAM,CAAC,WAAW,EAAE,CAAC;qBAAE;oBAC1C,OAAO,MAAM,CAAC;iBACjB;gBAAC,OAAO,CAAC,EAAE;oBACR,MAAM,CAAC,WAAW,EAAE,CAAC;oBACrB,MAAM,CAAC,CAAC;iBACX;YACL,CAAC;YACD,KAAK,CAAC,MAAM;gBACR,MAAM,aAAa,GAAG,MAAM,CAAC,MAAM,EAAE,CAAC;gBACtC,MAAM,CAAC,WAAW,EAAE,CAAC;gBACrB,MAAM,aAAa,CAAC;gBACpB,OAAO,EAAE,IAAI,EAAE,IAAI,EAAE,KAAK,EAAE,SAAS,EAAE,CAAC;YAC5C,CAAC;YACD,CAAC,MAAM,CAAC,aAAa,CAAC;gBAClB,OAAO,IAAI,CAAC;YAChB,CAAC;SACJ,CAAC;IACN,CAAC;CACJ;AA3GD,0BA2GC"}

package/lib/common/utils/usage-util.d.ts

@@ -0,0 +1,17 @@
+import { ChatResponse } from '../chat';
+import { Usage } from '../chat/metadata';
+/**
+ * An utility class to provide support methods handling {@link Usage}.
+ */
+export declare abstract class UsageUtil {
+    /**
+     * Accumulate usage tokens from the previous chat response to the current usage
+     * tokens.
+     * @param currentUsage the current usage.
+     * @param previousChatResponse the previous chat response.
+     * @return accumulated usage.
+     */
+    static getCumulativeUsage(currentUsage: Usage, previousChatResponse?: ChatResponse): Usage;
+    static isEmpty(usage: Usage | null): boolean;
+}
+//# sourceMappingURL=usage-util.d.ts.map

package/lib/common/utils/usage-util.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"usage-util.d.ts","sourceRoot":"","sources":["../../../src/common/utils/usage-util.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,SAAS,CAAC;AACvC,OAAO,EAAE,KAAK,EAAE,MAAM,kBAAkB,CAAC;AAEzC;;GAEG;AACH,8BAAsB,SAAS;IAE3B;;;;;;OAMG;WACW,kBAAkB,CAAC,YAAY,EAAE,KAAK,EAAE,oBAAoB,CAAC,EAAE,YAAY,GAAG,KAAK;IAqCjG,MAAM,CAAC,OAAO,CAAC,KAAK,EAAE,KAAK,GAAG,IAAI,GAAG,OAAO;CAO/C"}

package/lib/common/utils/usage-util.js

@@ -0,0 +1,62 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.UsageUtil = void 0;
+const metadata_1 = require("../chat/metadata");
+/**
+ * An utility class to provide support methods handling {@link Usage}.
+ */
+class UsageUtil {
+    /**
+     * Accumulate usage tokens from the previous chat response to the current usage
+     * tokens.
+     * @param currentUsage the current usage.
+     * @param previousChatResponse the previous chat response.
+     * @return accumulated usage.
+     */
+    static getCumulativeUsage(currentUsage, previousChatResponse) {
+        var _a, _b, _c, _d, _e, _f, _g;
+        let usageFromPreviousChatResponse = undefined;
+        if ((_a = previousChatResponse === null || previousChatResponse === void 0 ? void 0 : previousChatResponse.metadata) === null || _a === void 0 ? void 0 : _a.usage) {
+            usageFromPreviousChatResponse = previousChatResponse.metadata.usage;
+        }
+        else {
+            return currentUsage;
+        }
+        // For a valid usage from previous chat response, accumulate it to the current
+        // usage.
+        if (!this.isEmpty(currentUsage)) {
+            let promptTokens = (_b = currentUsage.promptTokens) !== null && _b !== void 0 ? _b : 0;
+            let generationTokens = (_c = currentUsage.generationTokens) !== null && _c !== void 0 ? _c : 0;
+            let totalTokens = (_d = currentUsage.totalTokens) !== null && _d !== void 0 ? _d : 0;
+            // Make sure to accumulate the usage from the previous chat response.
+            promptTokens += (_e = usageFromPreviousChatResponse.promptTokens) !== null && _e !== void 0 ? _e : 0;
+            generationTokens += (_f = usageFromPreviousChatResponse.generationTokens) !== null && _f !== void 0 ? _f : 0;
+            totalTokens += (_g = usageFromPreviousChatResponse.totalTokens) !== null && _g !== void 0 ? _g : 0;
+            return metadata_1.Usage.from(promptTokens, generationTokens, totalTokens);
+        }
+        // When current usage is empty, return the usage from the previous chat response.
+        return usageFromPreviousChatResponse;
+    }
+    // /**
+    //  * Check if the {@link Usage} is empty. Returns true when the {@link Usage} is null.
+    //  * Returns true when the {@link Usage} has zero tokens.
+    //  * @param usage the usage to check against.
+    //  * @return the boolean value to represent if it is empty.
+    //  */
+    // static isEmpty(usage: Usage | null): boolean {
+    //     if (!usage) {
+    //         return true;
+    //     } else if (usage != null && usage.totalTokens === 0) {
+    //         return true;
+    //     }
+    //     return false;
+    // }
+    static isEmpty(usage) {
+        if (!usage) {
+            return true;
+        }
+        return false;
+    }
+}
+exports.UsageUtil = UsageUtil;
+//# sourceMappingURL=usage-util.js.map

package/lib/common/utils/usage-util.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"usage-util.js","sourceRoot":"","sources":["../../../src/common/utils/usage-util.ts"],"names":[],"mappings":";;;AACA,+CAAyC;AAEzC;;GAEG;AACH,MAAsB,SAAS;IAE3B;;;;;;OAMG;IACI,MAAM,CAAC,kBAAkB,CAAC,YAAmB,EAAE,oBAAmC;;QACrF,IAAI,6BAA6B,GAAsB,SAAS,CAAC;QACjE,IAAI,MAAA,oBAAoB,aAApB,oBAAoB,uBAApB,oBAAoB,CAAE,QAAQ,0CAAE,KAAK,EAAE;YACvC,6BAA6B,GAAG,oBAAoB,CAAC,QAAQ,CAAC,KAAK,CAAC;SACvE;aAAM;YACH,OAAO,YAAY,CAAC;SACvB;QACD,8EAA8E;QAC9E,SAAS;QACT,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,YAAY,CAAC,EAAE;YAC7B,IAAI,YAAY,GAAG,MAAA,YAAY,CAAC,YAAY,mCAAI,CAAC,CAAC;YAClD,IAAI,gBAAgB,GAAG,MAAA,YAAY,CAAC,gBAAgB,mCAAI,CAAC,CAAC;YAC1D,IAAI,WAAW,GAAG,MAAA,YAAY,CAAC,WAAW,mCAAI,CAAC,CAAC;YAChD,qEAAqE;YACrE,YAAY,IAAI,MAAA,6BAA6B,CAAC,YAAY,mCAAI,CAAC,CAAC;YAChE,gBAAgB,IAAI,MAAA,6BAA6B,CAAC,gBAAgB,mCAAI,CAAC,CAAC;YACxE,WAAW,IAAI,MAAA,6BAA6B,CAAC,WAAW,mCAAI,CAAC,CAAC;YAC9D,OAAO,gBAAK,CAAC,IAAI,CAAC,YAAY,EAAE,gBAAgB,EAAE,WAAW,CAAC,CAAC;SAClE;QACD,iFAAiF;QACjF,OAAO,6BAA6B,CAAC;IACzC,CAAC;IAED,MAAM;IACN,uFAAuF;IACvF,0DAA0D;IAC1D,8CAA8C;IAC9C,4DAA4D;IAC5D,MAAM;IACN,iDAAiD;IACjD,oBAAoB;IACpB,uBAAuB;IACvB,6DAA6D;IAC7D,uBAAuB;IACvB,QAAQ;IACR,oBAAoB;IACpB,IAAI;IACJ,MAAM,CAAC,OAAO,CAAC,KAAmB;QAC9B,IAAI,CAAC,KAAK,EAAE;YACR,OAAO,IAAI,CAAC;SACf;QAED,OAAO,KAAK,CAAC;IACjB,CAAC;CACJ;AArDD,8BAqDC"}

package/package.json

@@ -1,12 +1,12 @@
 {
   "name": "@celljs/ai-core",
-  "version": "3.4.3",
+  "version": "3.4.4",
   "description": "Core domain for AI programming",
   "main": "lib/common/index.js",
   "typings": "lib/common/index.d.ts",
   "dependencies": {
-    "@celljs/core": "3.4.3",
-    "@celljs/http": "3.4.3",
+    "@celljs/core": "3.4.4",
+    "@celljs/http": "3.4.4",
     "rxjs": "^6.6.0",
     "tslib": "^2.8.0"
   },
@@ -38,7 +38,7 @@
     "test": "cell-component test:js"
   },
   "devDependencies": {
-    "@celljs/component": "3.4.3"
+    "@celljs/component": "3.4.4"
   },
-  "gitHead": "bcbbf929f18cd91fb9241f9b3b0f6c66dbea86cb"
+  "gitHead": "5d4a2384da3a67b3c16de24d4692bf754acfeda1"
 }

package/src/common/chat/index.ts

@@ -2,3 +2,4 @@ export * from './message';
 export * from './metadata';
 export * from './prompt';
 export * from './model';
+export * from './tool';

package/src/common/chat/message/message-protocol.ts

@@ -1,5 +1,5 @@
-import { MediaType } from '@celljs/http';
 import { Content } from '../../model/model-protocol';
+import { MimeType } from '@celljs/core';
 
 /**
  * The Media class represents the data and metadata of a media attachment in a message. It
@@ -10,12 +10,39 @@ import { Content } from '../../model/model-protocol';
  */
 export interface Media {
 
-    readonly mediaType: MediaType;
+    /**
+     * The unique identifier of the media attachment.
+     */
+    id?: string;
+
+    /**
+     * The MIME type of the media attachment.
+     */
+    mimeType: MimeType;
+
+    /**
+     * The raw data of the media attachment.
+     */
+    data: any;
 
     /**
-     * Get the media data object
+     * The name of the media object that can be referenced by the AI model.
+     * <p>
+     * Important security note: This field is vulnerable to prompt injections, as the
+     * model might inadvertently interpret it as instructions. It is recommended to
+     * specify neutral names.
+     *
+     * <p>
+     * The name must only contain:
+     * <ul>
+     * <li>Alphanumeric characters
+     * <li>Whitespace characters (no more than one in a row)
+     * <li>Hyphens
+     * <li>Parentheses
+     * <li>Square brackets
+     * </ul>
      */
-    readonly data: any;
+    name?: string;
 
 }
 

package/src/common/chat/metadata/chat-generation-metadata.ts

@@ -15,12 +15,12 @@ export interface ChatGenerationMetadata extends ResultMetadata {
      * The reason this choice completed for the generation.
      */
     readonly finishReason?: string;
+
+    readonly metadata: Record<string, any>;
 }
 
 export class ChatGenerationMetadata {
 
-    static EMPTY: ChatGenerationMetadata = ChatGenerationMetadata.from();
-
     /**
      * Factory method used to construct a new {@link ChatGenerationMetadata} from the
      * given finish reason and content filter metadata.
@@ -29,9 +29,9 @@ export class ChatGenerationMetadata {
      * @param contentFilterMetadata The content filter metadata.
      * @returns A new instance of {@link ChatGenerationMetadata}.
      */
-    static from(finishReason?: string, contentFilterMetadata?: any): ChatGenerationMetadata {
+    static from(finishReason?: string, metadata: Record<string, any> = {}, contentFilterMetadata?: any): ChatGenerationMetadata {
         return {
-            finishReason, contentFilterMetadata
+            finishReason, contentFilterMetadata, metadata
         };
     }
 }