@celljs/ai-core 3.0.0

package/lib/common/chat/prompt/index.js

@@ -0,0 +1,19 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./prompt-protocol"), exports);
+__exportStar(require("./prompt"), exports);
+//# sourceMappingURL=index.js.map

package/lib/common/chat/prompt/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/common/chat/prompt/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,oDAAkC;AAClC,2CAAyB"}

package/lib/common/chat/prompt/prompt-protocol.d.ts

@@ -0,0 +1,29 @@
+import { ModelOptions, ModelRequest } from '../../model/model-protocol';
+import { Media, Message } from '../message';
+/**
+ * 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;
+}
+export interface Prompt extends ModelRequest<Message[]> {
+    readonly contents: string;
+    copy(): Prompt;
+}
+export interface PromptTemplateStringActions {
+    render(model?: Map<String, Object>): string;
+}
+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;
+}
+//# sourceMappingURL=prompt-protocol.d.ts.map

package/lib/common/chat/prompt/prompt-protocol.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"prompt-protocol.d.ts","sourceRoot":"","sources":["../../../../src/common/chat/prompt/prompt-protocol.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,YAAY,EAAE,MAAM,4BAA4B,CAAC;AACxE,OAAO,EAAE,KAAK,EAAE,OAAO,EAAE,MAAM,YAAY,CAAC;AAE5C;;GAEG;AACH,MAAM,WAAW,WAAY,SAAQ,YAAY;IAE7C,QAAQ,CAAC,WAAW,CAAC,EAAE,MAAM,CAAC;IAC9B,QAAQ,CAAC,IAAI,CAAC,EAAE,MAAM,CAAC;IACvB,QAAQ,CAAC,IAAI,CAAC,EAAE,MAAM,CAAC;CAE1B;AAED,MAAM,WAAW,MAAO,SAAQ,YAAY,CAAC,OAAO,EAAE,CAAC;IACnD,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAC;IAC1B,IAAI,IAAI,MAAM,CAAC;CAClB;AAED,MAAM,WAAW,2BAA2B;IAExC,MAAM,CAAC,KAAK,CAAC,EAAE,GAAG,CAAC,MAAM,EAAE,MAAM,CAAC,GAAG,MAAM,CAAC;CAE/C;AAED,MAAM,WAAW,qBAAsB,SAAQ,2BAA2B;IAEtE,MAAM,CAAC,KAAK,EAAE,GAAG,CAAC,MAAM,EAAE,MAAM,CAAC,GAAG,MAAM,CAAC;CAE9C;AAED,MAAM,WAAW,yBAAyB;IAEtC,cAAc,IAAI,OAAO,EAAE,CAAC;IAC5B,cAAc,CAAC,KAAK,EAAE,GAAG,CAAC,MAAM,EAAE,MAAM,CAAC,GAAG,OAAO,EAAE,CAAC;CAEzD;AAED,MAAM,WAAW,4BAA4B;IAEzC,aAAa,CAAC,SAAS,EAAE,KAAK,EAAE,GAAG,OAAO,CAAC;IAC3C,aAAa,CAAC,KAAK,EAAE,GAAG,CAAC,MAAM,EAAE,MAAM,CAAC,GAAG,OAAO,CAAC;CAEtD"}

package/lib/common/chat/prompt/prompt-protocol.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=prompt-protocol.js.map

package/lib/common/chat/prompt/prompt-protocol.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"prompt-protocol.js","sourceRoot":"","sources":["../../../../src/common/chat/prompt/prompt-protocol.ts"],"names":[],"mappings":""}

package/lib/common/chat/prompt/prompt.d.ts

@@ -0,0 +1,14 @@
+import { ModelOptions } from '../../model/model-protocol';
+import { Message } from '../message';
+import { ChatOptions, Prompt } from './prompt-protocol';
+export declare class PromptImpl implements Prompt {
+    protected messages: Message[];
+    protected modelOptions: ChatOptions;
+    constructor(messages: Message[] | Message | string, modelOptions?: ChatOptions);
+    private instructionsCopy;
+    copy(): Prompt;
+    get contents(): string;
+    get instructions(): Message[];
+    get options(): ModelOptions;
+}
+//# sourceMappingURL=prompt.d.ts.map

package/lib/common/chat/prompt/prompt.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"prompt.d.ts","sourceRoot":"","sources":["../../../../src/common/chat/prompt/prompt.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,YAAY,EAAE,MAAM,4BAA4B,CAAC;AAC1D,OAAO,EAAE,OAAO,EAA4B,MAAM,YAAY,CAAC;AAC/D,OAAO,EAAE,WAAW,EAAE,MAAM,EAAE,MAAM,mBAAmB,CAAC;AAExD,qBAAa,UAAW,YAAW,MAAM;IAErC,SAAS,CAAC,QAAQ,EAAE,OAAO,EAAE,CAAC;IAE9B,SAAS,CAAC,YAAY,EAAE,WAAW,CAAC;gBACxB,QAAQ,EAAE,OAAO,EAAE,GAAG,OAAO,GAAG,MAAM,EAAE,YAAY,GAAE,WAAgB;IAWlF,OAAO,CAAC,gBAAgB;IAexB,IAAI,IAAI,MAAM;IAId,IAAI,QAAQ,IAAI,MAAM,CAMrB;IAED,IAAI,YAAY,IAAI,OAAO,EAAE,CAE5B;IAED,IAAI,OAAO,IAAI,YAAY,CAE1B;CACJ"}

package/lib/common/chat/prompt/prompt.js

@@ -0,0 +1,56 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PromptImpl = void 0;
+const core_1 = require("@celljs/core");
+const message_1 = require("../message");
+class PromptImpl {
+    constructor(messages, modelOptions = {}) {
+        this.modelOptions = modelOptions;
+        if (Array.isArray(messages)) {
+            this.messages = messages;
+        }
+        else if (typeof messages === 'string') {
+            this.messages = [new message_1.UserMessage(messages)];
+        }
+        else {
+            this.messages = [messages];
+        }
+    }
+    instructionsCopy() {
+        return this.messages.map(message => {
+            if (message.messageType === message_1.MessageType.USER) {
+                return new message_1.UserMessage(message.content);
+            }
+            else if (message.messageType === message_1.MessageType.ASSISTANT) {
+                return new message_1.UserMessage(message.content);
+            }
+            else if (message.messageType === message_1.MessageType.SYSTEM) {
+                return new message_1.UserMessage(message.content);
+            }
+            else if (message.messageType === message_1.MessageType.FUNCTION) {
+                return new message_1.UserMessage(message.content);
+            }
+            else {
+                throw new core_1.IllegalArgumentError(`Unsupported message type: ${message.messageType}`);
+            }
+        });
+    }
+    copy() {
+        return new PromptImpl(this.instructionsCopy(), this.modelOptions);
+    }
+    get contents() {
+        let contents = '';
+        for (const message of this.messages) {
+            contents += message.content;
+        }
+        return contents;
+    }
+    get instructions() {
+        return this.messages;
+    }
+    get options() {
+        return this.modelOptions;
+    }
+}
+exports.PromptImpl = PromptImpl;
+//# sourceMappingURL=prompt.js.map

package/lib/common/chat/prompt/prompt.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"prompt.js","sourceRoot":"","sources":["../../../../src/common/chat/prompt/prompt.ts"],"names":[],"mappings":";;;AAAA,uCAAoD;AAEpD,wCAA+D;AAG/D,MAAa,UAAU;IAKnB,YAAY,QAAsC,EAAE,eAA4B,EAAE;QAC9E,IAAI,CAAC,YAAY,GAAG,YAAY,CAAC;QACjC,IAAI,KAAK,CAAC,OAAO,CAAC,QAAQ,CAAC,EAAE;YACzB,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAC;SAC5B;aAAM,IAAI,OAAO,QAAQ,KAAK,QAAQ,EAAE;YACrC,IAAI,CAAC,QAAQ,GAAG,CAAC,IAAI,qBAAW,CAAC,QAAQ,CAAC,CAAC,CAAC;SAC/C;aAAM;YACH,IAAI,CAAC,QAAQ,GAAG,CAAC,QAAQ,CAAC,CAAC;SAC9B;IACL,CAAC;IAEO,gBAAgB;QACpB,OAAO,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,OAAO,CAAC,EAAE;YAC/B,IAAI,OAAO,CAAC,WAAW,KAAK,qBAAW,CAAC,IAAI,EAAE;gBAC1C,OAAO,IAAI,qBAAW,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;aAC3C;iBAAM,IAAI,OAAO,CAAC,WAAW,KAAK,qBAAW,CAAC,SAAS,EAAE;gBACtD,OAAO,IAAI,qBAAW,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;aAC3C;iBAAM,IAAI,OAAO,CAAC,WAAW,KAAK,qBAAW,CAAC,MAAM,EAAE;gBACnD,OAAO,IAAI,qBAAW,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;aAC3C;iBAAM,IAAI,OAAO,CAAC,WAAW,KAAK,qBAAW,CAAC,QAAQ,EAAE;gBACrD,OAAO,IAAI,qBAAW,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;aAC3C;iBAAM;gBACH,MAAM,IAAI,2BAAoB,CAAC,6BAA6B,OAAO,CAAC,WAAW,EAAE,CAAC,CAAC;aACtF;QACL,CAAC,CAAC,CAAC;IACP,CAAC;IACD,IAAI;QACA,OAAO,IAAI,UAAU,CAAC,IAAI,CAAC,gBAAgB,EAAE,EAAE,IAAI,CAAC,YAAY,CAAC,CAAC;IACtE,CAAC;IAED,IAAI,QAAQ;QACR,IAAI,QAAQ,GAAG,EAAE,CAAC;QAClB,KAAK,MAAM,OAAO,IAAI,IAAI,CAAC,QAAQ,EAAE;YACjC,QAAQ,IAAI,OAAO,CAAC,OAAO,CAAC;SAC/B;QACD,OAAO,QAAQ,CAAC;IACpB,CAAC;IAED,IAAI,YAAY;QACZ,OAAO,IAAI,CAAC,QAAQ,CAAC;IACzB,CAAC;IAED,IAAI,OAAO;QACP,OAAO,IAAI,CAAC,YAAY,CAAC;IAC7B,CAAC;CACJ;AAlDD,gCAkDC"}

package/lib/common/index.d.ts

@@ -0,0 +1,4 @@
+export * from './chat';
+export * from './model';
+export * from './utils';
+//# sourceMappingURL=index.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/common/index.ts"],"names":[],"mappings":"AAAA,cAAc,QAAQ,CAAC;AACvB,cAAc,SAAS,CAAC;AACxB,cAAc,SAAS,CAAC"}

package/lib/common/index.js

@@ -0,0 +1,20 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./chat"), exports);
+__exportStar(require("./model"), exports);
+__exportStar(require("./utils"), exports);
+//# sourceMappingURL=index.js.map

package/lib/common/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/common/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,yCAAuB;AACvB,0CAAwB;AACxB,0CAAwB"}

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

@@ -0,0 +1,47 @@
+import { ChatOptions } from '../../chat/prompt';
+/**
+ * Represents a model function call handler. Implementations are registered with the
+ * Models and called on prompts that trigger the function call.
+ */
+export interface FunctionCallback {
+    /**
+     * The Function name. Unique within the model.
+     */
+    readonly name: string;
+    /**
+     * The function description. This description is used by the model do
+     * decide if the function should be called or not.
+     */
+    readonly description: string;
+    /**
+     * The JSON schema of the function input type.
+     */
+    readonly inputTypeSchema: string;
+    /**
+     * 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
+     * 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>;
+}
+export interface FunctionCallingOptions {
+    /**
+     * Function Callbacks to be registered with the ChatClient. For Prompt Options the
+     * functionCallbacks are automatically enabled for the duration of the prompt
+     * execution. For Default Options the FunctionCallbacks are registered but disabled by
+     * default. You have to use "functions" property to list the function names from the
+     * ChatClient registry to be used in the chat completion requests.
+     */
+    functionCallbacks: FunctionCallback[];
+    /**
+     * List of function names from the ChatClient registry to be used in the next
+     * chat completion requests.
+     */
+    functions: Set<String>;
+}
+export interface PortableFunctionCallingOptions extends FunctionCallingOptions, ChatOptions {
+}
+//# sourceMappingURL=function-protocol.d.ts.map

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

@@ -0,0 +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,aAAa,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC;CAEhD;AAED,MAAM,WAAW,sBAAsB;IAEnC;;;;;;OAMG;IACH,iBAAiB,EAAE,gBAAgB,EAAE,CAAC;IAEtC;;;OAGG;IACH,SAAS,EAAE,GAAG,CAAC,MAAM,CAAC,CAAC;CAC1B;AAED,MAAM,WAAW,8BAA+B,SAAQ,sBAAsB,EAAE,WAAW;CAE1F"}

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

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=function-protocol.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"function-protocol.js","sourceRoot":"","sources":["../../../../src/common/model/function/function-protocol.ts"],"names":[],"mappings":""}

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

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

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

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

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

@@ -0,0 +1,18 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./function-protocol"), exports);
+//# sourceMappingURL=index.js.map

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

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

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

@@ -0,0 +1,2 @@
+export * from './model-protocol';
+//# sourceMappingURL=index.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/common/model/index.ts"],"names":[],"mappings":"AACA,cAAc,kBAAkB,CAAC"}

package/lib/common/model/index.js

@@ -0,0 +1,18 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./model-protocol"), exports);
+//# sourceMappingURL=index.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/common/model/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AACA,mDAAiC"}

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

@@ -0,0 +1,160 @@
+/**
+ * Provides a set of interfaces and classes for a generic API designed to interact with
+ * various AI models. This package includes interfaces for handling AI model calls,
+ * requests, responses, results, and associated metadata. It is designed to offer a
+ * flexible and adaptable framework for interacting with different types of AI models,
+ * abstracting the complexities involved in model invocation and result processing. The
+ * use of generics enhances the API's capability to work with a wide range of models,
+ * ensuring a broad applicability across diverse AI scenarios.
+ */
+import { Media } from '../chat';
+import { Observable } from 'rxjs';
+/**
+ * Interface representing the customizable options for AI model interactions. This marker
+ * interface allows for the specification of various settings and parameters that can
+ * influence the behavior and output of AI models. It is designed to provide flexibility
+ * and adaptability in different AI scenarios, ensuring that the AI models can be
+ * fine-tuned according to specific requirements.
+ */
+export interface ModelOptions {
+}
+/**
+ * Interface representing metadata associated with the results of an AI model. This
+ * interface focuses on providing additional context and insights into the results
+ * generated by AI models. It could include information like computation time, model
+ * version, or other relevant details that enhance understanding and management of AI
+ * model outputs in various applications.
+ */
+export interface ResultMetadata {
+}
+/**
+ * Interface representing metadata associated with an AI model's response. This interface
+ * is designed to provide additional information about the generative response from an AI
+ * model, including processing details and model-specific data. It serves as a value
+ * object within the core domain, enhancing the understanding and management of AI model
+ * responses in various applications.
+ */
+export interface ResponseMetadata {
+}
+/**
+ * This interface provides methods to access the main output of the AI model and the
+ * metadata associated with this result. It is designed to offer a standardized and
+ * comprehensive way to handle and interpret the outputs generated by AI models, catering
+ * to diverse AI applications and use cases.
+ *
+ * @param <T> the type of the output generated by the AI model
+ */
+export interface ModelResult<T> {
+    /**
+     * Retrieves the output generated by the AI model.
+     * The output generated by the AI model
+     */
+    readonly output: T;
+    /**
+     * Retrieves the metadata associated with the result of an AI model.
+     * The metadata associated with the result
+     */
+    readonly metadata: ResultMetadata;
+}
+/**
+ * Interface representing a request to an AI model. This interface encapsulates the
+ * necessary information required to interact with an AI model, including instructions or
+ * inputs (of generic type T) and additional model options. It provides a standardized way
+ * to send requests to AI models, ensuring that all necessary details are included and can
+ * be easily managed.
+ *
+ * @param <T> the type of instructions or input required by the AI model
+ */
+export interface ModelRequest<T> {
+    /**
+     * Retrieves the instructions or input required by the AI model.
+     * The instructions or input required by the AI model
+     */
+    readonly instructions: T;
+    /**
+     * Retrieves the customizable options for AI model interactions.
+     * The customizable options for AI model interactions
+     */
+    readonly options: ModelOptions;
+}
+/**
+ * Interface representing the response received from an AI model. This interface provides
+ * methods to access the main result or a list of results generated by the AI model, along
+ * with the response metadata. It serves as a standardized way to encapsulate and manage
+ * the output from AI models, ensuring easy retrieval and processing of the generated
+ * information.
+ *
+ * @param <T> the type of the result(s) provided by the AI model
+ */
+export interface ModelResponse<T extends ModelResult<any>> {
+    /**
+     * Retrieves the result of the AI model.
+     * The result generated by the AI model
+     */
+    readonly result: T;
+    /**
+     * Retrieves the list of generated outputs by the AI model.
+     * The list of generated outputs
+     */
+    readonly results: T[];
+    /**
+     * Retrieves the response metadata associated with the AI model's response.
+     * The response metadata
+     */
+    readonly metadata: ResponseMetadata;
+}
+/**
+ * The Model interface provides a generic API for invoking AI models. It is designed
+ * to handle the interaction with various types of AI models by abstracting the process of
+ * sending requests and receiving responses. The interface uses Java generics to
+ * accommodate different types of requests and responses, enhancing flexibility and
+ * adaptability across different AI model implementations.
+ *
+ * @param <TReq> the generic type of the request to the AI model
+ * @param <TRes> the generic type of the response from the AI model
+ */
+export interface Model<TReq extends ModelRequest<any>, TRes extends ModelResponse<any>> {
+    /**
+     * Executes a method call to the AI model.
+     * @param request the request object to be sent to the AI model
+     * @return the response from the AI model
+     */
+    call(request: TReq): Promise<TRes>;
+}
+/**
+ * Data structure that contains content and metadata.
+ */
+export interface Content {
+    /**
+     * Get the content of the message.
+     */
+    readonly content: string;
+    /**
+     * Get the media associated with the content.
+     */
+    readonly media: Media[];
+    /**
+     * return Get the metadata associated with the content.
+     */
+    readonly metadata: Record<string, any>;
+}
+/**
+ * The StreamingModel interface provides a generic API for invoking an AI models
+ * with streaming response. It abstracts the process of sending requests and receiving a
+ * streaming responses. The interface uses Java generics to accommodate different types of
+ * requests and responses, enhancing flexibility and adaptability across different AI
+ * model implementations.
+ *
+ * @param <TReq> the generic type of the request to the AI model
+ * @param <TResChunk> the generic type of a single item in the streaming response from the
+ * AI model
+ */
+export interface StreamingModel<TReq extends ModelRequest<any>, TResChunk extends ModelResponse<any>> {
+    /**
+     * Executes a method call to the AI model.
+     * @param request the request object to be sent to the AI model
+     * @return the streaming response from the AI model
+     */
+    stream(request: TReq): Observable<TResChunk>;
+}
+//# sourceMappingURL=model-protocol.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"model-protocol.d.ts","sourceRoot":"","sources":["../../../src/common/model/model-protocol.ts"],"names":[],"mappings":"AAAA;;;;;;;;GAQG;AAEH,OAAO,EAAE,KAAK,EAAE,MAAM,SAAS,CAAC;AAChC,OAAO,EAAE,UAAU,EAAE,MAAM,MAAM,CAAC;AAElC;;;;;;GAMG;AACH,MAAM,WAAW,YAAY;CAAG;AAEhC;;;;;;GAMG;AACH,MAAM,WAAW,cAAc;CAAG;AAElC;;;;;;GAMG;AACH,MAAM,WAAW,gBAAgB;CAAG;AAEpC;;;;;;;GAOG;AACH,MAAM,WAAW,WAAW,CAAC,CAAC;IAE1B;;;OAGG;IACH,QAAQ,CAAC,MAAM,EAAE,CAAC,CAAC;IAEnB;;;OAGG;IACH,QAAQ,CAAC,QAAQ,EAAE,cAAc,CAAC;CAErC;AAED;;;;;;;;GAQG;AACH,MAAM,WAAW,YAAY,CAAC,CAAC;IAE3B;;;OAGG;IACH,QAAQ,CAAC,YAAY,EAAE,CAAC,CAAC;IAEzB;;;OAGG;IACH,QAAQ,CAAC,OAAO,EAAE,YAAY,CAAC;CAElC;AAED;;;;;;;;GAQG;AACH,MAAM,WAAW,aAAa,CAAC,CAAC,SAAS,WAAW,CAAC,GAAG,CAAC;IAErD;;;OAGG;IACH,QAAQ,CAAC,MAAM,EAAE,CAAC,CAAC;IAEnB;;;OAGG;IACH,QAAQ,CAAC,OAAO,EAAE,CAAC,EAAE,CAAC;IAEtB;;;OAGG;IACH,QAAQ,CAAC,QAAQ,EAAE,gBAAgB,CAAC;CAEvC;AAED;;;;;;;;;GASG;AACH,MAAM,WAAW,KAAK,CAAC,IAAI,SAAS,YAAY,CAAC,GAAG,CAAC,EAAE,IAAI,SAAS,aAAa,CAAC,GAAG,CAAC;IAElF;;;;OAIG;IACH,IAAI,CAAC,OAAO,EAAE,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;CAEtC;AAED;;GAEG;AACH,MAAM,WAAW,OAAO;IAEpB;;OAEG;IACH,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;IAEzB;;OAEG;IACH,QAAQ,CAAC,KAAK,EAAE,KAAK,EAAE,CAAC;IAExB;;OAEG;IACH,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;CAE1C;AAED;;;;;;;;;;GAUG;AACH,MAAM,WAAW,cAAc,CAAC,IAAI,SAAS,YAAY,CAAC,GAAG,CAAC,EAAE,SAAS,SAAS,aAAa,CAAC,GAAG,CAAC;IAEhG;;;;OAIG;IACH,MAAM,CAAC,OAAO,EAAE,IAAI,GAAG,UAAU,CAAC,SAAS,CAAC,CAAC;CAEhD"}

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

@@ -0,0 +1,12 @@
+"use strict";
+/**
+ * Provides a set of interfaces and classes for a generic API designed to interact with
+ * various AI models. This package includes interfaces for handling AI model calls,
+ * requests, responses, results, and associated metadata. It is designed to offer a
+ * flexible and adaptable framework for interacting with different types of AI models,
+ * abstracting the complexities involved in model invocation and result processing. The
+ * use of generics enhances the API's capability to work with a wide range of models,
+ * ensuring a broad applicability across diverse AI scenarios.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=model-protocol.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"model-protocol.js","sourceRoot":"","sources":["../../../src/common/model/model-protocol.ts"],"names":[],"mappings":";AAAA;;;;;;;;GAQG"}

package/lib/common/module.d.ts

@@ -0,0 +1,4 @@
+import './index';
+declare const _default: import("inversify/lib/interfaces/interfaces").interfaces.ContainerModule;
+export default _default;
+//# sourceMappingURL=module.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"module.d.ts","sourceRoot":"","sources":["../../src/common/module.ts"],"names":[],"mappings":"AACA,OAAO,SAAS,CAAC;;AAEjB,wBAA0B"}

package/lib/common/module.js

@@ -0,0 +1,6 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const core_1 = require("@celljs/core");
+require("./index");
+exports.default = (0, core_1.autoBind)();
+//# sourceMappingURL=module.js.map

package/lib/common/module.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"module.js","sourceRoot":"","sources":["../../src/common/module.ts"],"names":[],"mappings":";;AAAA,uCAAwC;AACxC,mBAAiB;AAEjB,kBAAe,IAAA,eAAQ,GAAE,CAAC"}

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

@@ -0,0 +1,2 @@
+export * from './prompt-util';
+//# sourceMappingURL=index.d.ts.map

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

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

package/lib/common/utils/index.js

@@ -0,0 +1,18 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./prompt-util"), exports);
+//# sourceMappingURL=index.js.map

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

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

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

@@ -0,0 +1,5 @@
+import { ChatOptions, Message, Prompt } from '../chat';
+export declare abstract class PromptUtil {
+    static create(messages: Message[] | Message | string, options?: ChatOptions): Prompt;
+}
+//# sourceMappingURL=prompt-util.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"prompt-util.d.ts","sourceRoot":"","sources":["../../../src/common/utils/prompt-util.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,OAAO,EAAE,MAAM,EAAc,MAAM,SAAS,CAAC;AAEnE,8BAAsB,UAAU;WACd,MAAM,CAAC,QAAQ,EAAE,OAAO,EAAE,GAAG,OAAO,GAAG,MAAM,EAAE,OAAO,GAAE,WAAgB,GAAG,MAAM;CAGlG"}

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

@@ -0,0 +1,11 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PromptUtil = void 0;
+const chat_1 = require("../chat");
+class PromptUtil {
+    static create(messages, options = {}) {
+        return new chat_1.PromptImpl(messages, options);
+    }
+}
+exports.PromptUtil = PromptUtil;
+//# sourceMappingURL=prompt-util.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"prompt-util.js","sourceRoot":"","sources":["../../../src/common/utils/prompt-util.ts"],"names":[],"mappings":";;;AAAA,kCAAmE;AAEnE,MAAsB,UAAU;IACrB,MAAM,CAAC,MAAM,CAAC,QAAsC,EAAE,UAAuB,EAAE;QAClF,OAAO,IAAI,iBAAU,CAAC,QAAQ,EAAE,OAAO,CAAC,CAAC;IAC7C,CAAC;CACJ;AAJD,gCAIC"}

package/lib/package.spec.d.ts

@@ -0,0 +1 @@
+//# sourceMappingURL=package.spec.d.ts.map

package/lib/package.spec.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"package.spec.d.ts","sourceRoot":"","sources":["../src/package.spec.ts"],"names":[],"mappings":""}

package/lib/package.spec.js

@@ -0,0 +1,4 @@
+describe('ai-core package', () => {
+    it('support ai-core coverage statistics', () => { });
+});
+//# sourceMappingURL=package.spec.js.map

package/lib/package.spec.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"package.spec.js","sourceRoot":"","sources":["../src/package.spec.ts"],"names":[],"mappings":"AAAA,QAAQ,CAAC,iBAAiB,EAAE,GAAG,EAAE;IAE7B,EAAE,CAAC,qCAAqC,EAAE,GAAG,EAAE,GAAE,CAAC,CAAC,CAAC;AACxD,CAAC,CAAC,CAAC"}

package/package.json

@@ -0,0 +1,43 @@
+{
+  "name": "@celljs/ai-core",
+  "version": "3.0.0",
+  "description": "Core domain for AI programming",
+  "main": "lib/common/index.js",
+  "typings": "lib/common/index.d.ts",
+  "dependencies": {
+    "@celljs/core": "3.0.0",
+    "@celljs/http": "3.0.0",
+    "rxjs": "^6.6.0"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "keywords": [
+    "cell-component"
+  ],
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/cellbang/cell.git"
+  },
+  "bugs": {
+    "url": "https://github.com/cellbang/cell/issues"
+  },
+  "homepage": "https://github.com/cellbang/cell",
+  "files": [
+    "lib",
+    "src",
+    "cell.yml"
+  ],
+  "scripts": {
+    "lint": "cell-component lint",
+    "build": "cell-component build",
+    "watch": "cell-component watch",
+    "clean": "cell-component clean",
+    "test": "cell-component test:js"
+  },
+  "devDependencies": {
+    "@celljs/component": "3.0.0"
+  },
+  "gitHead": "c0ef8d269e33a795406bcbb240cac4b845c6c24c"
+}

package/src/common/chat/index.ts

@@ -0,0 +1,4 @@
+export * from './message';
+export * from './metadata';
+export * from './prompt';
+export * from './model';