@celljs/ai-core 3.8.0 → 4.0.0

package/esm/common/chat/index.d.ts

@@ -0,0 +1,5 @@
+export * from './message/index.js';
+export * from './metadata/index.js';
+export * from './prompt/index.js';
+export * from './model/index.js';
+export * from './tool/index.js';

package/esm/common/chat/index.js

@@ -0,0 +1,6 @@
+export * from './message/index.js';
+export * from './metadata/index.js';
+export * from './prompt/index.js';
+export * from './model/index.js';
+export * from './tool/index.js';
+//# sourceMappingURL=index.js.map

package/esm/common/chat/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/common/chat/index.ts"],"names":[],"mappings":"AAAA,cAAc,WAAW,CAAC;AAC1B,cAAc,YAAY,CAAC;AAC3B,cAAc,UAAU,CAAC;AACzB,cAAc,SAAS,CAAC;AACxB,cAAc,QAAQ,CAAC"}

package/esm/common/chat/message/abstract-message.d.ts

@@ -0,0 +1,9 @@
+import { Media, Message, MessageType } from './message-protocol.js';
+export declare abstract class AbstractMessage implements Message {
+    readonly messageType: MessageType;
+    readonly content: string;
+    readonly media: Media[];
+    readonly metadata: Record<string, any>;
+    static MESSAGE_TYPE: string;
+    constructor(messageType: MessageType, content: string, media?: Media[], metadata?: Record<string, any>);
+}

package/esm/common/chat/message/abstract-message.js

@@ -0,0 +1,11 @@
+export class AbstractMessage {
+    constructor(messageType, content, media = [], metadata = {}) {
+        this.messageType = messageType;
+        this.content = content;
+        this.media = media;
+        this.metadata = metadata;
+        this.metadata[AbstractMessage.MESSAGE_TYPE] = messageType;
+    }
+}
+AbstractMessage.MESSAGE_TYPE = 'messageType';
+//# sourceMappingURL=abstract-message.js.map

package/esm/common/chat/message/abstract-message.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"abstract-message.js","sourceRoot":"","sources":["../../../../src/common/chat/message/abstract-message.ts"],"names":[],"mappings":"AAEA,MAAM,OAAgB,eAAe;IAGjC,YACa,WAAwB,EACxB,OAAe,EACf,KAAK,GAAY,EAAE,EACnB,QAAQ,GAAwB,EAAE;2BAHlC,WAAW;uBACX,OAAO;qBACP,KAAK;wBACL,QAAQ;QACjB,IAAI,CAAC,QAAQ,CAAC,eAAe,CAAC,YAAY,CAAC,GAAG,WAAW,CAAC;IAC9D,CAAC;CACJ;AATU,4BAAY,GAAG,aAAa,CAAC"}

package/esm/common/chat/message/assistant-message.d.ts

@@ -0,0 +1,9 @@
+import { AbstractMessage } from './abstract-message.js';
+import { Media, ToolCall } from './message-protocol.js';
+export declare class AssistantMessage extends AbstractMessage {
+    readonly content: string;
+    readonly media: Media[];
+    readonly metadata: Record<string, any>;
+    readonly toolCalls: ToolCall[];
+    constructor(content?: string, media?: Media[], metadata?: Record<string, any>, toolCalls?: ToolCall[]);
+}

package/esm/common/chat/message/assistant-message.js

@@ -0,0 +1,12 @@
+import { AbstractMessage } from './abstract-message.js';
+import { MessageType } from './message-protocol.js';
+export class AssistantMessage extends AbstractMessage {
+    constructor(content = '', media = [], metadata = {}, toolCalls = []) {
+        super(MessageType.ASSISTANT, content, media, metadata);
+        this.content = content;
+        this.media = media;
+        this.metadata = metadata;
+        this.toolCalls = toolCalls;
+    }
+}
+//# sourceMappingURL=assistant-message.js.map

package/esm/common/chat/message/assistant-message.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"assistant-message.js","sourceRoot":"","sources":["../../../../src/common/chat/message/assistant-message.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAE,MAAM,oBAAoB,CAAC;AACrD,OAAO,EAAS,WAAW,EAAY,MAAM,oBAAoB,CAAC;AAElE,MAAM,OAAO,gBAAiB,SAAQ,eAAe;IAEjD,YACsB,OAAO,GAAW,EAAE,EACpB,KAAK,GAAY,EAAE,EACnB,QAAQ,GAAwB,EAAE,EAC3C,SAAS,GAAe,EAAE;QAEnC,KAAK,CAAC,WAAW,CAAC,SAAS,EAAE,OAAO,EAAE,KAAK,EAAE,QAAQ,CAAC,CAAC;uBALrC,OAAO;qBACP,KAAK;wBACL,QAAQ;yBACjB,SAAS;IAGtB,CAAC;CACJ"}

package/esm/common/chat/message/function-message.d.ts

@@ -0,0 +1,8 @@
+import { AbstractMessage } from './abstract-message.js';
+import { Media } from './message-protocol.js';
+export declare class FunctionMessage extends AbstractMessage {
+    readonly content: string;
+    readonly media: Media[];
+    readonly metadata: Record<string, any>;
+    constructor(content: string, media?: Media[], metadata?: Record<string, any>);
+}

package/esm/common/chat/message/function-message.js

@@ -0,0 +1,11 @@
+import { AbstractMessage } from './abstract-message.js';
+import { MessageType } from './message-protocol.js';
+export class FunctionMessage extends AbstractMessage {
+    constructor(content, media = [], metadata = {}) {
+        super(MessageType.FUNCTION, content, media, metadata);
+        this.content = content;
+        this.media = media;
+        this.metadata = metadata;
+    }
+}
+//# sourceMappingURL=function-message.js.map

package/esm/common/chat/message/function-message.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"function-message.js","sourceRoot":"","sources":["../../../../src/common/chat/message/function-message.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAE,MAAM,oBAAoB,CAAC;AACrD,OAAO,EAAS,WAAW,EAAE,MAAM,oBAAoB,CAAC;AAExD,MAAM,OAAO,eAAgB,SAAQ,eAAe;IAEhD,YACsB,OAAe,EACf,KAAK,GAAY,EAAE,EACnB,QAAQ,GAAwB,EAAE;QACpD,KAAK,CAAC,WAAW,CAAC,QAAQ,EAAE,OAAO,EAAE,KAAK,EAAE,QAAQ,CAAC,CAAC;uBAHpC,OAAO;qBACP,KAAK;wBACL,QAAQ;IAE9B,CAAC;CACJ"}

package/esm/common/chat/message/index.d.ts

@@ -0,0 +1,7 @@
+export * from './message-protocol.js';
+export * from './abstract-message.js';
+export * from './user-message.js';
+export * from './system-message.js';
+export * from './assistant-message.js';
+export * from './function-message.js';
+export * from './tool-response-message.js';

package/esm/common/chat/message/index.js

@@ -0,0 +1,8 @@
+export * from './message-protocol.js';
+export * from './abstract-message.js';
+export * from './user-message.js';
+export * from './system-message.js';
+export * from './assistant-message.js';
+export * from './function-message.js';
+export * from './tool-response-message.js';
+//# sourceMappingURL=index.js.map

package/esm/common/chat/message/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/common/chat/message/index.ts"],"names":[],"mappings":"AAAA,cAAc,oBAAoB,CAAC;AACnC,cAAc,oBAAoB,CAAC;AACnC,cAAc,gBAAgB,CAAC;AAC/B,cAAc,kBAAkB,CAAC;AACjC,cAAc,qBAAqB,CAAC;AACpC,cAAc,oBAAoB,CAAC;AACnC,cAAc,yBAAyB,CAAC"}

package/esm/common/chat/message/message-protocol.d.ts

@@ -0,0 +1,87 @@
+import { Content } from '../../model/model-protocol.js';
+import { MimeType } from '@celljs/core';
+/**
+ * The Media class represents the data and metadata of a media attachment in a message. It
+ * consists of a MIME type and the raw data.
+ *
+ * This class is used as a parameter in the constructor of the UserMessage class.
+ *
+ */
+export interface Media {
+    /**
+     * 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;
+    /**
+     * 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>
+     */
+    name?: string;
+}
+/**
+ * The MessageType enum represents the type of a message in a chat application. It can be
+ * one of the following: USER, ASSISTANT, SYSTEM, FUNCTION.
+ */
+export declare enum MessageType {
+    USER = "user",
+    ASSISTANT = "assistant",
+    SYSTEM = "system",
+    FUNCTION = "function",
+    TOOL = "tool"
+}
+/**
+ * The Message interface represents a message that can be sent or received in a chat
+ * application. Messages can have content, media attachments, properties, and message
+ * types.
+ *
+ * @see Media
+ * @see MessageType
+ */
+export interface Message extends Content {
+    messageType: MessageType;
+}
+export declare namespace Message {
+    function isMessage(obj: any): obj is Message;
+}
+/**
+ * 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/esm/common/chat/message/message-protocol.js

@@ -0,0 +1,20 @@
+/**
+ * The MessageType enum represents the type of a message in a chat application. It can be
+ * one of the following: USER, ASSISTANT, SYSTEM, FUNCTION.
+ */
+export var MessageType;
+(function (MessageType) {
+    MessageType["USER"] = "user";
+    MessageType["ASSISTANT"] = "assistant";
+    MessageType["SYSTEM"] = "system";
+    MessageType["FUNCTION"] = "function";
+    MessageType["TOOL"] = "tool";
+})(MessageType || (MessageType = {}));
+export var Message;
+(function (Message) {
+    function isMessage(obj) {
+        return obj && obj.messageType !== undefined;
+    }
+    Message.isMessage = isMessage;
+})(Message || (Message = {}));
+//# sourceMappingURL=message-protocol.js.map

package/esm/common/chat/message/message-protocol.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"message-protocol.js","sourceRoot":"","sources":["../../../../src/common/chat/message/message-protocol.ts"],"names":[],"mappings":"AAgDA;;;GAGG;AACH,MAAM,CAAN,IAAY,WAMX;AAND,WAAY,WAAW;IACnB,4BAAa,CAAA;IACb,sCAAuB,CAAA;IACvB,gCAAiB,CAAA;IACjB,oCAAqB,CAAA;IACrB,4BAAa,CAAA;AACjB,CAAC,EANW,WAAW,KAAX,WAAW,QAMtB;AAcD,MAAM,KAAW,OAAO,CAIvB;AAJD,WAAiB,OAAO;IACpB,SAAgB,SAAS,CAAC,GAAQ;QAC9B,OAAO,GAAG,IAAI,GAAG,CAAC,WAAW,KAAK,SAAS,CAAC;IAChD,CAAC;IAFe,QAAA,SAAS,YAExB,CAAA;AACL,CAAC,EAJgB,OAAO,KAAP,OAAO,QAIvB"}

package/esm/common/chat/message/system-message.d.ts

@@ -0,0 +1,8 @@
+import { AbstractMessage } from './abstract-message.js';
+import { Media } from './message-protocol.js';
+export declare class SystemMessage extends AbstractMessage {
+    readonly content: string;
+    readonly media: Media[];
+    readonly metadata: Record<string, any>;
+    constructor(content: string, media?: Media[], metadata?: Record<string, any>);
+}

package/esm/common/chat/message/system-message.js

@@ -0,0 +1,11 @@
+import { AbstractMessage } from './abstract-message.js';
+import { MessageType } from './message-protocol.js';
+export class SystemMessage extends AbstractMessage {
+    constructor(content, media = [], metadata = {}) {
+        super(MessageType.SYSTEM, content, media, metadata);
+        this.content = content;
+        this.media = media;
+        this.metadata = metadata;
+    }
+}
+//# sourceMappingURL=system-message.js.map

package/esm/common/chat/message/system-message.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"system-message.js","sourceRoot":"","sources":["../../../../src/common/chat/message/system-message.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAE,MAAM,oBAAoB,CAAC;AACrD,OAAO,EAAS,WAAW,EAAE,MAAM,oBAAoB,CAAC;AAExD,MAAM,OAAO,aAAc,SAAQ,eAAe;IAE9C,YACsB,OAAe,EACf,KAAK,GAAY,EAAE,EACnB,QAAQ,GAAwB,EAAE;QACpD,KAAK,CAAC,WAAW,CAAC,MAAM,EAAE,OAAO,EAAE,KAAK,EAAE,QAAQ,CAAC,CAAC;uBAHlC,OAAO;qBACP,KAAK;wBACL,QAAQ;IAE9B,CAAC;CACJ"}

package/esm/common/chat/message/tool-response-message.d.ts

@@ -0,0 +1,31 @@
+import { AbstractMessage } from './abstract-message.js';
+/**
+ * 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 declare class ToolResponseMessage extends AbstractMessage {
+    readonly responses: ToolResponse[];
+    /**
+     * Creates an instance of ToolResponseMessage.
+     * @param responses The list of tool responses.
+     * @param metadata Additional metadata.
+     */
+    constructor(responses: ToolResponse[], metadata?: Record<string, any>);
+}

package/esm/common/chat/message/tool-response-message.js

@@ -0,0 +1,19 @@
+import { AbstractMessage } from './abstract-message.js';
+import { MessageType } from './message-protocol.js';
+/**
+ * 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(responses, metadata = {}) {
+        super(MessageType.TOOL, '', [], metadata);
+        this.responses = responses;
+        this.responses = responses;
+    }
+}
+//# sourceMappingURL=tool-response-message.js.map

package/esm/common/chat/message/tool-response-message.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"tool-response-message.js","sourceRoot":"","sources":["../../../../src/common/chat/message/tool-response-message.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAE,MAAM,oBAAoB,CAAC;AACrD,OAAO,EAAE,WAAW,EAAE,MAAM,oBAAoB,CAAC;AAsBjD;;;GAGG;AACH,MAAM,OAAO,mBAAoB,SAAQ,eAAe;IAEpD;;;;OAIG;IACH,YACa,SAAyB,EAAE,QAAQ,GAAwB,EAAE;QACtE,KAAK,CAAC,WAAW,CAAC,IAAI,EAAE,EAAE,EAAE,EAAE,EAAE,QAAQ,CAAC,CAAC;yBADjC,SAAS;QAElB,IAAI,CAAC,SAAS,GAAG,SAAS,CAAC;IAC/B,CAAC;CACJ"}

package/esm/common/chat/message/user-message.d.ts

@@ -0,0 +1,8 @@
+import { AbstractMessage } from './abstract-message.js';
+import { Media } from './message-protocol.js';
+export declare class UserMessage extends AbstractMessage {
+    readonly content: string;
+    readonly media: Media[];
+    readonly metadata: Record<string, any>;
+    constructor(content: string, media?: Media[], metadata?: Record<string, any>);
+}

package/esm/common/chat/message/user-message.js

@@ -0,0 +1,11 @@
+import { AbstractMessage } from './abstract-message.js';
+import { MessageType } from './message-protocol.js';
+export class UserMessage extends AbstractMessage {
+    constructor(content, media = [], metadata = {}) {
+        super(MessageType.USER, content, media, metadata);
+        this.content = content;
+        this.media = media;
+        this.metadata = metadata;
+    }
+}
+//# sourceMappingURL=user-message.js.map

package/esm/common/chat/message/user-message.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"user-message.js","sourceRoot":"","sources":["../../../../src/common/chat/message/user-message.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAE,MAAM,oBAAoB,CAAC;AACrD,OAAO,EAAS,WAAW,EAAE,MAAM,oBAAoB,CAAC;AAExD,MAAM,OAAO,WAAY,SAAQ,eAAe;IAE5C,YACsB,OAAe,EACf,KAAK,GAAY,EAAE,EACnB,QAAQ,GAAwB,EAAE;QACpD,KAAK,CAAC,WAAW,CAAC,IAAI,EAAE,OAAO,EAAE,KAAK,EAAE,QAAQ,CAAC,CAAC;uBAHhC,OAAO;qBACP,KAAK;wBACL,QAAQ;IAE9B,CAAC;CACJ"}

package/esm/common/chat/metadata/chat-generation-metadata.d.ts

@@ -0,0 +1,27 @@
+import { ResultMetadata } from '../../model/model-protocol.js';
+/**
+ * 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;
+    readonly metadata: Record<string, any>;
+}
+export declare class ChatGenerationMetadata {
+    /**
+     * 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, metadata?: Record<string, any>, contentFilterMetadata?: any): ChatGenerationMetadata;
+}

package/esm/common/chat/metadata/chat-generation-metadata.js

@@ -0,0 +1,16 @@
+export class ChatGenerationMetadata {
+    /**
+     * 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, metadata = {}, contentFilterMetadata) {
+        return {
+            finishReason, contentFilterMetadata, metadata
+        };
+    }
+}
+//# sourceMappingURL=chat-generation-metadata.js.map

package/esm/common/chat/metadata/chat-generation-metadata.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"chat-generation-metadata.js","sourceRoot":"","sources":["../../../../src/common/chat/metadata/chat-generation-metadata.ts"],"names":[],"mappings":"AAqBA,MAAM,OAAO,sBAAsB;IAE/B;;;;;;;OAOG;IACH,MAAM,CAAC,IAAI,CAAC,YAAqB,EAAE,QAAQ,GAAwB,EAAE,EAAE,qBAA2B;QAC9F,OAAO;YACH,YAAY,EAAE,qBAAqB,EAAE,QAAQ;SAChD,CAAC;IACN,CAAC;CACJ"}

package/esm/common/chat/metadata/index.d.ts

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

package/esm/common/chat/metadata/index.js

@@ -0,0 +1,3 @@
+export * from './metadata-protocol.js';
+export * from './chat-generation-metadata.js';
+//# sourceMappingURL=index.js.map

package/esm/common/chat/metadata/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/common/chat/metadata/index.ts"],"names":[],"mappings":"AAAA,cAAc,qBAAqB,CAAC;AACpC,cAAc,4BAA4B,CAAC"}

package/esm/common/chat/metadata/metadata-protocol.d.ts

@@ -0,0 +1,127 @@
+import { ResponseMetadata } from '../../model/model-protocol.js';
+/**
+ * Abstract Data Type (ADT) encapsulating metadata on the usage of an AI provider's API
+ * per AI request.
+ */
+export interface Usage {
+    /**
+     * The number of tokens used in the prompt of the AI request.
+     */
+    readonly promptTokens?: number;
+    /**
+     * The number of tokens returned in the generation (aka completion)
+     * of the AI's response.
+     */
+    readonly generationTokens?: number;
+    /**
+     * The total number of tokens from both the prompt of an AI request
+     * and generation of the AI's response.
+     */
+    readonly totalTokens?: number;
+}
+export declare namespace Usage {
+    function createEmpty(): Usage;
+    function from(promptTokens?: number, generationTokens?: number, totalTokens?: number): Usage;
+}
+/**
+ * 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.
+ */
+export interface RateLimit {
+    /**
+     * The maximum number of requests that are permitted before exhausting the
+     * rate limit.
+     */
+    readonly requestsLimit?: number;
+    /**
+     * The remaining number of requests that are permitted before exhausting the
+     * requestsLimit rate limit.
+     */
+    readonly requestsRemaining?: number;
+    /**
+     * The duration time until the rate limit (based on requests) resets
+     * to its requestsLimit initial state.
+     */
+    readonly requestsReset?: number;
+    /**
+     * The maximum number of tokens that are permitted before exhausting the rate
+     * limit.
+     */
+    readonly tokensLimit?: number;
+    /**
+     * The remaining number of tokens that are permitted before exhausting the
+     * tokensLimit rate limit.
+     */
+    readonly tokensRemaining?: number;
+    /**
+     * The duration time until the rate limit (based on tokens) resets to
+     * its tokensLimit initial state.
+     */
+    readonly tokensReset?: number;
+}
+/**
+ * Abstract Data Type (ADT) modeling filter metadata for all prompts sent during an AI
+ * request.
+ */
+export interface PromptFilterMetadata<T = any> {
+    /**
+     * Index of the prompt filter metadata contained in the AI response.
+     */
+    readonly promptIndex: number;
+    /**
+     * Returns the underlying AI provider metadata for filtering applied to prompt
+     * content.
+     * @param <T> {@link Class Type} used to cast the filtered content metadata into
+     * the AI provider-specific type.
+     * @return the underlying AI provider metadata for filtering applied to prompt
+     * content.
+     */
+    readonly contentFilterMetadata: T;
+}
+/**
+ * Abstract Data Type (ADT) modeling metadata gathered by the AI during request
+ * processing.
+ */
+export type PromptMetadata = PromptFilterMetadata[];
+export declare namespace PromptMetadata {
+    /**
+     * Returns an Optional {@link PromptFilterMetadata} at the given index.
+     * @param promptIndex index of the {@link PromptFilterMetadata} contained in this
+     * {@link PromptMetadata}.
+     * @return Optional {@link PromptFilterMetadata} at the given index.
+     * @throws IllegalArgumentError if the prompt index is less than 0.
+     */
+    function findByPromptIndex(promptMetadata: PromptMetadata, promptIndex: number): PromptFilterMetadata | undefined;
+}
+export declare namespace RateLimit {
+    function createEmpty(): RateLimit;
+}
+export interface ChatResponseMetadata extends ResponseMetadata {
+    id?: string;
+    model?: string;
+    /**
+     * AI provider specific metadata on rate limits.
+     * @see RateLimit
+     */
+    rateLimit: RateLimit;
+    /**
+     * AI provider specific metadata on API usage.
+     * @see Usage
+     */
+    usage: Usage;
+    promptMetadata: PromptMetadata;
+}
+export declare class ChatResponseMetadataBuilder {
+    private readonly chatResponseMetadata;
+    id(id: string): ChatResponseMetadataBuilder;
+    model(model: string): ChatResponseMetadataBuilder;
+    rateLimit(rateLimit: RateLimit): ChatResponseMetadataBuilder;
+    usage(usage: Usage): ChatResponseMetadataBuilder;
+    promptMetadata(promptMetadata: PromptMetadata): ChatResponseMetadataBuilder;
+    keyValue(key: string, value: any): ChatResponseMetadataBuilder;
+    build(): ChatResponseMetadata;
+}
+export declare namespace ChatResponseMetadata {
+    function createEmpty(): ChatResponseMetadata;
+    function builder(): ChatResponseMetadataBuilder;
+}

package/esm/common/chat/metadata/metadata-protocol.js

@@ -0,0 +1,92 @@
+import { IllegalArgumentError } from '@celljs/core';
+export var Usage;
+(function (Usage) {
+    function createEmpty() {
+        return { promptTokens: 0, generationTokens: 0, totalTokens: 0 };
+    }
+    Usage.createEmpty = createEmpty;
+    function from(promptTokens = 0, generationTokens = 0, totalTokens = 0) {
+        return { promptTokens, generationTokens, totalTokens: totalTokens ? totalTokens : promptTokens + generationTokens };
+    }
+    Usage.from = from;
+})(Usage || (Usage = {}));
+export var PromptMetadata;
+(function (PromptMetadata) {
+    /**
+     * Returns an Optional {@link PromptFilterMetadata} at the given index.
+     * @param promptIndex index of the {@link PromptFilterMetadata} contained in this
+     * {@link PromptMetadata}.
+     * @return Optional {@link PromptFilterMetadata} at the given index.
+     * @throws IllegalArgumentError if the prompt index is less than 0.
+     */
+    function findByPromptIndex(promptMetadata, promptIndex) {
+        if (promptIndex < 0) {
+            throw new IllegalArgumentError(`Prompt index [${promptIndex}] must be greater than equal to 0`);
+        }
+        return promptMetadata.find(promptFilterMetadata => promptFilterMetadata.promptIndex === promptIndex);
+    }
+    PromptMetadata.findByPromptIndex = findByPromptIndex;
+})(PromptMetadata || (PromptMetadata = {}));
+export var RateLimit;
+(function (RateLimit) {
+    function createEmpty() {
+        return { requestsLimit: 0, requestsRemaining: 0, requestsReset: 0, tokensLimit: 0, tokensRemaining: 0, tokensReset: 0 };
+    }
+    RateLimit.createEmpty = createEmpty;
+})(RateLimit || (RateLimit = {}));
+export class ChatResponseMetadataBuilder {
+    constructor() {
+        this.chatResponseMetadata = ChatResponseMetadata.createEmpty();
+    }
+    id(id) {
+        this.chatResponseMetadata.id = id;
+        return this;
+    }
+    model(model) {
+        this.chatResponseMetadata.model = model;
+        return this;
+    }
+    rateLimit(rateLimit) {
+        this.chatResponseMetadata.rateLimit = rateLimit;
+        return this;
+    }
+    usage(usage) {
+        this.chatResponseMetadata.usage = usage;
+        return this;
+    }
+    promptMetadata(promptMetadata) {
+        this.chatResponseMetadata.promptMetadata = promptMetadata;
+        return this;
+    }
+    keyValue(key, value) {
+        if (!key) {
+            throw new IllegalArgumentError('Key must not be empty');
+        }
+        if (value) {
+            this.chatResponseMetadata.extra[key] = value;
+        }
+        return this;
+    }
+    build() {
+        return this.chatResponseMetadata;
+    }
+}
+export var ChatResponseMetadata;
+(function (ChatResponseMetadata) {
+    function createEmpty() {
+        return {
+            id: '',
+            model: '',
+            rateLimit: RateLimit.createEmpty(),
+            usage: Usage.createEmpty(),
+            promptMetadata: [],
+            extra: {}
+        };
+    }
+    ChatResponseMetadata.createEmpty = createEmpty;
+    function builder() {
+        return new ChatResponseMetadataBuilder();
+    }
+    ChatResponseMetadata.builder = builder;
+})(ChatResponseMetadata || (ChatResponseMetadata = {}));
+//# sourceMappingURL=metadata-protocol.js.map

package/esm/common/chat/metadata/metadata-protocol.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"metadata-protocol.js","sourceRoot":"","sources":["../../../../src/common/chat/metadata/metadata-protocol.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,oBAAoB,EAAE,MAAM,cAAc,CAAC;AA4BpD,MAAM,KAAW,KAAK,CAQrB;AARD,WAAiB,KAAK;IAClB,SAAgB,WAAW;QACvB,OAAO,EAAE,YAAY,EAAE,CAAC,EAAE,gBAAgB,EAAE,CAAC,EAAE,WAAW,EAAE,CAAC,EAAE,CAAC;IACpE,CAAC;IAFe,MAAA,WAAW,cAE1B,CAAA;IAED,SAAgB,IAAI,CAAC,YAAY,GAAG,CAAC,EAAE,gBAAgB,GAAG,CAAC,EAAE,WAAW,GAAG,CAAC;QACxE,OAAO,EAAE,YAAY,EAAE,gBAAgB,EAAE,WAAW,EAAE,WAAW,CAAC,CAAC,CAAC,WAAW,CAAC,CAAC,CAAC,YAAY,GAAG,gBAAgB,EAAE,CAAC;IACxH,CAAC;IAFe,MAAA,IAAI,OAEnB,CAAA;AACL,CAAC,EARgB,KAAK,KAAL,KAAK,QAQrB;AA2ED,MAAM,KAAW,cAAc,CAgB9B;AAhBD,WAAiB,cAAc;IAC3B;;;;;;OAMG;IACH,SAAgB,iBAAiB,CAAC,cAA8B,EAAE,WAAmB;QAEjF,IAAI,WAAW,GAAG,CAAC,EAAE,CAAC;YAClB,MAAM,IAAI,oBAAoB,CAAC,iBAAiB,WAAW,mCAAmC,CAAC,CAAC;QACpG,CAAC;QAED,OAAO,cAAc,CAAC,IAAI,CAAC,oBAAoB,CAAC,EAAE,CAAC,oBAAoB,CAAC,WAAW,KAAK,WAAW,CAAC,CAAC;IACzG,CAAC;IAPe,eAAA,iBAAiB,oBAOhC,CAAA;AACL,CAAC,EAhBgB,cAAc,KAAd,cAAc,QAgB9B;AAED,MAAM,KAAW,SAAS,CAIzB;AAJD,WAAiB,SAAS;IACtB,SAAgB,WAAW;QACvB,OAAO,EAAE,aAAa,EAAE,CAAC,EAAE,iBAAiB,EAAE,CAAC,EAAE,aAAa,EAAE,CAAC,EAAE,WAAW,EAAE,CAAC,EAAE,eAAe,EAAE,CAAC,EAAE,WAAW,EAAE,CAAC,EAAE,CAAC;IAC5H,CAAC;IAFe,UAAA,WAAW,cAE1B,CAAA;AACL,CAAC,EAJgB,SAAS,KAAT,SAAS,QAIzB;AAqBD,MAAM,OAAO,2BAA2B;IAAxC;QAEqB,yBAAoB,GAAyB,oBAAoB,CAAC,WAAW,EAAE,CAAC;IA0CrG,CAAC;IAxCG,EAAE,CAAC,EAAU;QACT,IAAI,CAAC,oBAAoB,CAAC,EAAE,GAAG,EAAE,CAAC;QAClC,OAAO,IAAI,CAAC;IAChB,CAAC;IAED,KAAK,CAAC,KAAa;QACf,IAAI,CAAC,oBAAoB,CAAC,KAAK,GAAG,KAAK,CAAC;QACxC,OAAO,IAAI,CAAC;IAChB,CAAC;IAED,SAAS,CAAC,SAAoB;QAC1B,IAAI,CAAC,oBAAoB,CAAC,SAAS,GAAG,SAAS,CAAC;QAChD,OAAO,IAAI,CAAC;IAChB,CAAC;IAED,KAAK,CAAC,KAAY;QACd,IAAI,CAAC,oBAAoB,CAAC,KAAK,GAAG,KAAK,CAAC;QACxC,OAAO,IAAI,CAAC;IAChB,CAAC;IAED,cAAc,CAAC,cAA8B;QACzC,IAAI,CAAC,oBAAoB,CAAC,cAAc,GAAG,cAAc,CAAC;QAC1D,OAAO,IAAI,CAAC;IAChB,CAAC;IAED,QAAQ,CAAC,GAAW,EAAE,KAAU;QAC5B,IAAI,CAAC,GAAG,EAAE,CAAC;YACP,MAAM,IAAI,oBAAoB,CAAC,uBAAuB,CAAC,CAAC;QAC5D,CAAC;QACD,IAAI,KAAK,EAAE,CAAC;YACR,IAAI,CAAC,oBAAoB,CAAC,KAAK,CAAC,GAAG,CAAC,GAAG,KAAK,CAAC;QACjD,CAAC;QAED,OAAO,IAAI,CAAC;IAChB,CAAC;IAED,KAAK;QACD,OAAO,IAAI,CAAC,oBAAoB,CAAC;IACrC,CAAC;CAEJ;AAED,MAAM,KAAW,oBAAoB,CAgBpC;AAhBD,WAAiB,oBAAoB;IAEjC,SAAgB,WAAW;QACvB,OAAO;YACH,EAAE,EAAE,EAAE;YACN,KAAK,EAAE,EAAE;YACT,SAAS,EAAE,SAAS,CAAC,WAAW,EAAE;YAClC,KAAK,EAAE,KAAK,CAAC,WAAW,EAAE;YAC1B,cAAc,EAAE,EAAoB;YACpC,KAAK,EAAE,EAAE;SACZ,CAAC;IACN,CAAC;IATe,qBAAA,WAAW,cAS1B,CAAA;IAED,SAAgB,OAAO;QACnB,OAAO,IAAI,2BAA2B,EAAE,CAAC;IAC7C,CAAC;IAFe,qBAAA,OAAO,UAEtB,CAAA;AACL,CAAC,EAhBgB,oBAAoB,KAApB,oBAAoB,QAgBpC"}