@celljs/ai-core 3.2.0 → 3.4.0

package/lib/common/utils/index.js

@@ -2,4 +2,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);
 //# 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"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/common/utils/index.ts"],"names":[],"mappings":";;;AAAA,wDAA8B;AAC9B,qDAA2B"}

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

@@ -0,0 +1,11 @@
+import { Observable } from 'rxjs';
+import { StreamEvent } from '../sse';
+/**
+ * SSE utility class.
+ */
+export declare class SSEUtil {
+    static toObservable<Data>(readableStream: ReadableStream, controller?: AbortController): Observable<StreamEvent<Data>>;
+    private static handleSSE;
+    private static readableStreamAsyncIterable;
+}
+//# sourceMappingURL=sse-util.d.ts.map

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

@@ -0,0 +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"}

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

@@ -0,0 +1,113 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SSEUtil = void 0;
+const rxjs_1 = require("rxjs");
+const sse_1 = require("../sse");
+/**
+ * SSE utility class.
+ */
+class SSEUtil {
+    static toObservable(readableStream, controller) {
+        return new rxjs_1.Observable(subscriber => {
+            (async () => {
+                const decoder = new sse_1.SSEDecoder();
+                const lineDecoder = new sse_1.LineDecoderImpl();
+                try {
+                    const iterable = this.readableStreamAsyncIterable(readableStream);
+                    for await (const chunk of iterable) {
+                        const lines = lineDecoder.decode(chunk);
+                        for (const line of lines) {
+                            const sse = decoder.decode(line);
+                            this.handleSSE(sse, subscriber, controller);
+                        }
+                    }
+                    const remainingLines = lineDecoder.flush();
+                    for (const line of remainingLines) {
+                        const sse = decoder.decode(line);
+                        if (sse) {
+                            this.handleSSE(sse, subscriber, controller);
+                        }
+                    }
+                    subscriber.complete();
+                }
+                catch (e) {
+                    if (e instanceof Error && e.name === 'AbortError') {
+                        subscriber.complete();
+                    }
+                    else {
+                        subscriber.error(e);
+                    }
+                }
+                finally {
+                    controller === null || controller === void 0 ? void 0 : controller.abort();
+                }
+            })();
+        });
+    }
+    static handleSSE(sse, subscriber, controller) {
+        if (sse) {
+            if (sse.data.startsWith('[DONE]')) {
+                subscriber.complete();
+                controller === null || controller === void 0 ? void 0 : controller.abort();
+                return;
+            }
+            if (!sse.event || sse.event === 'error') {
+                let data;
+                try {
+                    data = JSON.parse(sse.data);
+                }
+                catch (e) {
+                    console.error('Could not parse message into JSON:', sse.data);
+                    console.error('From chunk:', sse.raw);
+                    subscriber.error(e);
+                    return;
+                }
+                if (data && data.error) {
+                    subscriber.error(data.error);
+                    return;
+                }
+                subscriber.next({
+                    event: sse.event,
+                    data,
+                    raw: sse.raw
+                });
+                if (data.done === true) {
+                    subscriber.complete();
+                    controller === null || controller === void 0 ? void 0 : controller.abort();
+                }
+            }
+        }
+    }
+    static readableStreamAsyncIterable(stream) {
+        if (stream[Symbol.asyncIterator]) {
+            return stream;
+        }
+        const reader = stream.getReader();
+        return {
+            async next() {
+                try {
+                    const result = await reader.read();
+                    if (result === null || result === void 0 ? void 0 : result.done) {
+                        reader.releaseLock();
+                    }
+                    return result;
+                }
+                catch (e) {
+                    reader.releaseLock();
+                    throw e;
+                }
+            },
+            async return() {
+                const cancelPromise = reader.cancel();
+                reader.releaseLock();
+                await cancelPromise;
+                return { done: true, value: undefined };
+            },
+            [Symbol.asyncIterator]() {
+                return this;
+            },
+        };
+    }
+}
+exports.SSEUtil = SSEUtil;
+//# sourceMappingURL=sse-util.js.map

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

@@ -0,0 +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"}

package/package.json

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

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

@@ -1,12 +1,14 @@
 import { AbstractMessage } from './abstract-message';
-import { Media, MessageType } from './message-protocol';
+import { Media, MessageType, ToolCall } from './message-protocol';
 
 export class AssistantMessage extends AbstractMessage {
 
     constructor(
-        override readonly content: string,
+        override readonly content: string = '',
         override readonly media: Media[] = [],
-        override readonly metadata: Record<string, any> = {}) {
+        override readonly metadata: Record<string, any> = {},
+        readonly toolCalls: ToolCall[] = []
+    ) {
         super(MessageType.ASSISTANT, content, media, metadata);
     }
 }

package/src/common/chat/message/index.ts

@@ -4,3 +4,4 @@ export * from './user-message';
 export * from './system-message';
 export * from './assistant-message';
 export * from './function-message';
+export * from './tool-response-message';

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

@@ -27,7 +27,8 @@ export enum MessageType {
     USER = 'user',
     ASSISTANT = 'assistant',
     SYSTEM = 'system',
-    FUNCTION = 'function'
+    FUNCTION = 'function',
+    TOOL = 'tool'
 }
 
 /**
@@ -47,3 +48,28 @@ export namespace Message {
         return obj && obj.messageType !== undefined;
     }
 }
+
+/**
+ * Represents a tool call.
+ */
+export interface ToolCall {
+    /**
+     * The unique identifier for the tool call.
+     */
+    id: string;
+
+    /**
+     * The type of the tool.
+     */
+    type: string;
+
+    /**
+     * The name of the tool.
+     */
+    name: string;
+
+    /**
+     * The arguments passed to the tool.
+     */
+    arguments: string;
+}

package/src/common/chat/message/tool-response-message.ts

@@ -0,0 +1,40 @@
+import { AbstractMessage } from './abstract-message';
+import { MessageType } from './message-protocol';
+
+/**
+ * Represents a tool response.
+ */
+export interface ToolResponse {
+    /**
+     * The unique identifier for the tool.
+     */
+    id: string;
+
+    /**
+     * The name of the tool.
+     */
+    name: string;
+
+    /**
+     * The response data from the tool.
+     */
+    responseData: string;
+}
+
+/**
+ * The ToolResponseMessage class represents a message with a function content in a chat
+ * application.
+ */
+export class ToolResponseMessage extends AbstractMessage {
+
+    /**
+     * Creates an instance of ToolResponseMessage.
+     * @param responses The list of tool responses.
+     * @param metadata Additional metadata.
+     */
+    constructor(
+        readonly responses: ToolResponse[], metadata: Record<string, any> = {}) {
+        super(MessageType.TOOL, '', [], metadata);
+        this.responses = responses;
+    }
+}

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

@@ -0,0 +1,38 @@
+import { ResultMetadata } from '../../model/model-protocol';
+
+/**
+ * Abstract Data Type (ADT) encapsulating information on the completion choices in the AI
+ * response.
+ */
+export interface ChatGenerationMetadata extends ResultMetadata {
+
+    /**
+     * The reason this choice completed for the generation.
+     */
+    readonly contentFilterMetadata?: any;
+
+    /**
+     * The reason this choice completed for the generation.
+     */
+    readonly finishReason?: string;
+}
+
+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.
+     *
+     * @param finishReason The reason for completion.
+     * @param contentFilterMetadata The content filter metadata.
+     * @returns A new instance of {@link ChatGenerationMetadata}.
+     */
+    static from(finishReason?: string, contentFilterMetadata?: any): ChatGenerationMetadata {
+        return {
+            finishReason, contentFilterMetadata
+        };
+    }
+}
+

package/src/common/chat/metadata/index.ts

@@ -1 +1,2 @@
 export * from './metadata-protocol';
+export * from './chat-generation-metadata';

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

@@ -26,6 +26,12 @@ export interface Usage {
 
 }
 
+export namespace Usage {
+    export function from(promptTokens: number, generationTokens: number): Usage {
+        return { promptTokens, generationTokens, totalTokens: promptTokens + generationTokens };
+    }
+}
+
 /**
  * Abstract Data Type (ADT) encapsulating metadata from an AI provider's API rate limits
  * granted to the API key in use and the API key's current balance.
@@ -118,24 +124,92 @@ export namespace PromptMetadata {
 }
 
 export interface ChatResponseMetadata extends ResponseMetadata {
+    id?: string;
+    model?: string;
     /**
      * AI provider specific metadata on rate limits.
      * @see RateLimit
      */
-    readonly rateLimit: RateLimit;
+    rateLimit: RateLimit;
 
     /**
      * AI provider specific metadata on API usage.
      * @see Usage
      */
-    readonly usage: Usage;
+    usage: Usage;
 
-    readonly promptMetadata: PromptMetadata;
+    promptMetadata: PromptMetadata;
+
+}
+
+export class ChatResponseMetadataBuilder {
+
+    private readonly chatResponseMetadata: ChatResponseMetadata = {
+        id: '',
+        model: '',
+        rateLimit: {
+            requestsLimit: 0,
+            requestsRemaining: 0,
+            requestsReset: 0,
+            tokensLimit: 0,
+            tokensRemaining: 0,
+            tokensReset: 0
+        },
+        usage: {
+            promptTokens: 0,
+            generationTokens: 0,
+            totalTokens: 0
+        },
+        promptMetadata: [] as PromptMetadata,
+        extra: {}
+    };
+
+    id(id: string): ChatResponseMetadataBuilder {
+        this.chatResponseMetadata.id = id;
+        return this;
+    }
+
+    model(model: string): ChatResponseMetadataBuilder {
+        this.chatResponseMetadata.model = model;
+        return this;
+    }
+
+    rateLimit(rateLimit: RateLimit): ChatResponseMetadataBuilder {
+        this.chatResponseMetadata.rateLimit = rateLimit;
+        return this;
+    }
+
+    usage(usage: Usage): ChatResponseMetadataBuilder {
+        this.chatResponseMetadata.usage = usage;
+        return this;
+    }
+
+    promptMetadata(promptMetadata: PromptMetadata): ChatResponseMetadataBuilder {
+        this.chatResponseMetadata.promptMetadata = promptMetadata;
+        return this;
+    }
+
+    keyValue(key: string, value: any): ChatResponseMetadataBuilder {
+        if (!key) {
+            throw new IllegalArgumentError('Key must not be empty');
+        }
+        if (value) {
+            this.chatResponseMetadata.extra[key] = value;
+        }
+
+        return this;
+    }
+
+    build(): ChatResponseMetadata {
+        return this.chatResponseMetadata;
+    }
 
 }
 
 export namespace ChatResponseMetadata {
-    export const EMPTY = {
+    export const EMPTY: ChatResponseMetadata = {
+        id: '',
+        model: '',
         rateLimit: {
             requestsLimit: 0,
             requestsRemaining: 0,
@@ -149,6 +223,11 @@ export namespace ChatResponseMetadata {
             generationTokens: 0,
             totalTokens: 0
         },
-        promptMetadata: [] as PromptMetadata
-    } as ChatResponseMetadata;
+        promptMetadata: [] as PromptMetadata,
+        extra: {}
+    };
+
+    export function builder(): ChatResponseMetadataBuilder {
+        return new ChatResponseMetadataBuilder();
+    }
 }

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

@@ -1,5 +1,6 @@
 import { Model, ModelResponse, ModelResult, StreamingModel } from '../../model/model-protocol';
 import { AssistantMessage } from '../message';
+import { ChatGenerationMetadata, ChatResponseMetadata } from '../metadata';
 import { Prompt } from '../prompt/prompt-protocol';
 
 export const StreamingChatModel = Symbol('StreamingChatModel');
@@ -16,6 +17,18 @@ export interface ChatResponse extends ModelResponse<Generation> {
 
 }
 
+export namespace Generation {
+    export function from(output: AssistantMessage, metadata = ChatGenerationMetadata.EMPTY): Generation {
+        return { output, metadata };
+    }
+}
+
+export namespace ChatResponse {
+    export function from(results: Generation[], metadata = ChatResponseMetadata.EMPTY): ChatResponse {
+        return { result: results[0], results, metadata };
+    }
+}
+
 export interface StreamingChatModel extends StreamingModel<Prompt, ChatResponse> {
 
 }

package/src/common/chat/prompt/index.ts

@@ -1,2 +1,3 @@
 export * from './prompt-protocol';
 export * from './prompt';
+export * from './prompt-template';

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

@@ -1,15 +1,20 @@
 import { ModelOptions, ModelRequest } from '../../model/model-protocol';
-import { Media, Message } from '../message';
+import { Message, MessageType } from '../message/message-protocol';
+
+export const PromptTemplate = Symbol('PromptTemplate');
 
 /**
  * The ChatOptions represent the common options, portable across different chat models.
  */
 export interface ChatOptions extends ModelOptions {
-
-    readonly temperature?: number;
-    readonly topP?: number;
-    readonly topK?: number;
-
+    model?: string;
+    frequencyPenalty?: number;
+    maxTokens?: number;
+    presencePenalty?: number;
+    stopSequences?: string[];
+    temperature?: number;
+    topK?: number;
+    topP?: number;
 }
 
 export interface Prompt extends ModelRequest<Message[]> {
@@ -17,28 +22,13 @@ export interface Prompt extends ModelRequest<Message[]> {
     copy(): Prompt;
 }
 
-export interface PromptTemplateStringActions {
-
-    render(model?: Map<String, Object>): string;
-
+export interface PromptTemplateContext {
+    variables?: Record<string, any>;
+    chatOptions?: ChatOptions;
+    messageType?: MessageType;
 }
 
-export interface PromptTemplateActions extends PromptTemplateStringActions {
-
-    create(model: Map<String, Object>): Prompt;
-
-}
-
-export interface PromptTemplateChatActions {
-
-    createMessages(): Message[];
-    createMessages(model: Map<String, Object>): Message[];
-
-}
-
-export interface PromptTemplateMessageActions {
-
-    createMessage(mediaList: Media[]): Message;
-    createMessage(model: Map<String, Object>): Message;
-
+export interface PromptTemplate {
+    render(template: string, ctx?: PromptTemplateContext): Promise<string>;
+    create(template: string, ctx?: PromptTemplateContext): Promise<Prompt>;
 }

package/src/common/chat/prompt/prompt-template.ts

@@ -0,0 +1,26 @@
+import { Autowired, Component, ExpressionHandler, IllegalArgumentError } from '@celljs/core';
+import { Prompt, PromptTemplate, PromptTemplateContext } from './prompt-protocol';
+import { PromptImpl } from './prompt';
+import { MessageType, SystemMessage } from '../message';
+
+@Component(PromptTemplate)
+export class PromptTemplateImpl implements PromptTemplate {
+
+    @Autowired(ExpressionHandler)
+    protected readonly expressionHandler: ExpressionHandler;
+
+    async render(template: string, ctx?: PromptTemplateContext): Promise<string> {
+        if (ctx?.variables) {
+            return this.expressionHandler.handle(template, ctx, { ignoreSpecialChar: true, bracketBegin: '{', bracketEnd: '}' });
+        }
+        return template;
+    }
+    async create(template: string, ctx?: PromptTemplateContext): Promise<Prompt> {
+        if (!ctx?.messageType || ctx?.messageType === MessageType.USER) {
+            return new PromptImpl(await this.render(template, ctx), ctx?.chatOptions);
+        } else if (ctx?.messageType === MessageType.SYSTEM) {
+            return new PromptImpl(new SystemMessage(await this.render(template, ctx)), ctx?.chatOptions);
+        }
+        throw new IllegalArgumentError(`Invalid message type: ${ctx?.messageType}`);
+    }
+}

package/src/common/embedding/embedding-protocol.ts

@@ -4,6 +4,16 @@ import { Model, ModelOptions, ModelRequest, ModelResponse, ModelResult, Response
 
 export const EmbeddingModel = Symbol('EmbeddingModel');
 
+/**
+ * Enum representing the modality type of the source data.
+ */
+export enum ModalityType {
+    TEXT = 'TEXT',
+    IMAGE = 'IMAGE',
+    AUDIO = 'AUDIO',
+    VIDEO = 'VIDEO'
+}
+
 /**
  * Represents the metadata for an embedding result.
  */
@@ -29,14 +39,13 @@ export interface EmbeddingResultMetadata extends ResultMetadata {
     documentData: any;
 }
 
-/**
- * Enum representing the modality type of the source data.
- */
-export enum ModalityType {
-    TEXT = 'TEXT',
-    IMAGE = 'IMAGE',
-    AUDIO = 'AUDIO',
-    VIDEO = 'VIDEO'
+export namespace EmbeddingResultMetadata {
+    export const EMPTY: EmbeddingResultMetadata = {
+        modalityType: ModalityType.TEXT,
+        documentId: '',
+        mimeType: MimeTypeUtils.TEXT_PLAIN,
+        documentData: undefined
+    };
 }
 
 /**

package/src/common/error/error.ts

@@ -0,0 +1,7 @@
+import { CustomError } from '@celljs/core';
+
+export class AIError extends CustomError {
+    constructor(message: string) {
+        super(message);
+    }
+}

package/src/common/error/index.ts

@@ -0,0 +1 @@
+export * from './error';

package/src/common/index.ts

@@ -1,4 +1,6 @@
 export * from './chat';
 export * from './model';
 export * from './embedding';
+export * from './sse';
 export * from './utils';
+export * from './error';

package/src/common/model/function/function-protocol.ts

@@ -25,12 +25,12 @@ export interface FunctionCallback {
     /**
      * Called when a model detects and triggers a function call. The model is responsible
      * to pass the function arguments in the pre-configured JSON schema format.
-     * @param functionInput JSON string with the function arguments to be passed to the
+     * @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.
      * @return String containing the function call response.
      */
-    call(functionInput: string): Promise<string>;
+    call(functionArguments: string): Promise<string>;
 
 }
 
@@ -52,6 +52,12 @@ export interface FunctionCallingOptions {
     functions: Set<String>;
 }
 
+export namespace FunctionCallingOptions {
+    export function is(obj: any): obj is FunctionCallingOptions {
+        return obj && obj.functionCallbacks !== undefined && obj.functions !== undefined;
+    }
+}
+
 export interface PortableFunctionCallingOptions extends FunctionCallingOptions, ChatOptions {
 
 }