@memberjunction/ai 3.4.0 → 4.0.0

package/dist/generic/chat.types.d.ts

@@ -1,102 +1,391 @@
-/// <reference types="node" />
-import { BaseParams, BaseResult, ModelUsage } from "./baseModel";
+import { BaseParams, BaseResult, ModelUsage } from "./baseModel.js";
+/**
+ * The possible roles for a chat message.
+ */
 export declare const ChatMessageRole: {
     readonly system: "system";
     readonly user: "user";
     readonly assistant: "assistant";
 };
 export type ChatMessageRole = typeof ChatMessageRole[keyof typeof ChatMessageRole];
+/**
+ * Defines the shape of a content block in a chat message.
+ * This can be used to represent different types of content in a message.
+ */
 export type ChatMessageContentBlock = {
+    /**
+     * The type of content block.
+     * Can be 'text', 'image_url', 'video_url', 'audio_url', or 'file_url'.
+     */
     type: 'text' | 'image_url' | 'video_url' | 'audio_url' | 'file_url';
+    /**
+     * The content of the block.
+     * This can be a string. In the case of 'image_url', 'video_url', 'audio_url', or 'file_url', it should be a URL to the resource, OR it can be a base64 encoded string.
+     * representing the content of the item. For base64 images, use the data URL format: data:image/png;base64,<data>
+     */
     content: string;
+    /**
+     * Optional MIME type for media content (e.g., 'image/png', 'image/jpeg', 'audio/mp3').
+     * When content is a data URL, this can be extracted from the URL. When content is raw base64, this field is required.
+     */
     mimeType?: string;
+    /**
+     * Optional original filename if the content was uploaded from a file.
+     */
     fileName?: string;
+    /**
+     * Optional file size in bytes.
+     */
     fileSize?: number;
+    /**
+     * Optional width in pixels (for images and videos).
+     */
     width?: number;
+    /**
+     * Optional height in pixels (for images and videos).
+     */
     height?: number;
 };
+/**
+ * Union type for the content of a chat message.
+ */
 export type ChatMessageContent = string | ChatMessageContentBlock[];
+/**
+ * Defines the shape of an individual chat message.
+ *
+ * @template M - Optional metadata type. Use this to attach typed metadata to messages
+ * without coupling the core ChatMessage type to specific implementations.
+ */
 export type ChatMessage<M = any> = {
+    /**
+     * Role of the message in the conversation.
+     */
     role: ChatMessageRole;
+    /**
+     * Content of the message, can be any string or an array of content blocks.
+     */
     content: ChatMessageContent;
+    /**
+     * Optional metadata for the message. The type can be specified via the generic parameter.
+     * This allows different consumers to attach their own typed metadata without modifying
+     * the core ChatMessage type.
+     */
     metadata?: M;
 };
+/**
+ * Defines the shape of an individual message from the model in response to a chat completion request.
+ */
 export type ChatCompletionMessage = {
+    /**
+     * Role of the message in the conversation. For completions, this is always 'assistant'.
+     */
     role: 'assistant';
+    /**
+     * Content of the message, can be any string
+     */
     content: string;
+    /**
+     * When using a reasoning model, this field can contain the reasoning behind the response.
+     * Not all providers/models support this field.
+     */
     thinking?: string | null;
 };
+/**
+ * Interface for streaming chat completion callbacks
+ */
 export interface StreamingChatCallbacks {
+    /**
+     * Called when a new chunk of content is received
+     * @param chunk The new content chunk
+     * @param isComplete Whether this is the final chunk
+     */
     OnContent?: (chunk: string, isComplete: boolean) => void;
+    /**
+     * Called when the stream is complete
+     * @param finalResponse The complete ChatResult
+     */
     OnComplete?: (finalResponse: ChatResult) => void;
+    /**
+     * Called when an error occurs during streaming
+     * @param error The error that occurred
+     */
     OnError?: (error: any) => void;
 }
+/**
+ * Interface for callbacks used in parallel chat completions
+ */
 export interface ParallelChatCompletionsCallbacks {
+    /**
+     * Called when a single completion from the batch is completed
+     * @param response The completed ChatResult
+     * @param index The index of the completion in the original request array
+     */
     OnCompletion?: (response: ChatResult, index: number) => void;
+    /**
+     * Called when any completion in the batch encounters an error
+     * @param error The error that occurred
+     * @param index The index of the completion that failed
+     */
     OnError?: (error: any, index: number) => void;
+    /**
+     * Called when all completions in the batch are completed (successfully or with errors)
+     * @param responses Array of all ChatResults in the same order as the request params
+     */
     OnAllCompleted?: (responses: ChatResult[]) => void;
 }
 export declare class ChatParams extends BaseParams {
+    /**
+     * Array of messages, allows full control over the order and content of the conversation.
+     */
     messages: ChatMessage[];
+    /**
+     * Whether to use streaming for this request.
+     * If true and the provider supports streaming, responses will be streamed.
+     * If true but the provider doesn't support streaming, the request will fall back to non-streaming.
+     */
     streaming?: boolean;
+    /**
+     * Callbacks for streaming responses.
+     * Only used when streaming is true.
+     */
     streamingCallbacks?: StreamingChatCallbacks;
+    /**
+     * If the model supports effort levels, this parameter can be used to specify the effort level.
+     */
     effortLevel?: string;
+    /**
+     * Whether to enable caching for this request.
+     * Implementation depends on the specific provider (the below are examples, many other providers exist):
+     * - For Anthropic: Uses Anthropic's ephemeral cache control to cache system prompt and last user message.
+     * - For OpenAI: Uses automatic caching (provider handles it).
+     * - For other providers: May be a no-op if caching isn't supported.
+     *
+     * @default true - Caching is enabled by default for providers that support it.
+     */
     enableCaching?: boolean;
+    /**
+     * Not all AI providers support this feature. When supported, this parameter indicates if logprobs are requested.
+     * Logprobs provide information about the likelihood of each token in the response.
+     * This can be useful for debugging or understanding the model's behavior.
+     * When models support this and this property is set to true, the model will return logprobs for the tokens in the @see ChatResultData object within the array of @see ChatResultChoice objects.
+     */
     includeLogProbs?: boolean;
+    /**
+     * Optional cancellation token to abort the chat completion request.
+     * When this signal is aborted, the provider should cancel the request
+     * and return a cancelled result as gracefully as possible.
+     */
     cancellationToken?: AbortSignal;
+    /**
+     * Top-p (nucleus) sampling parameter (0-1).
+     * An alternative to temperature sampling that considers the smallest set of tokens
+     * whose cumulative probability exceeds the probability p.
+     * For example, 0.1 means only the tokens comprising the top 10% probability mass are considered.
+     * Generally, use either temperature OR top-p, not both.
+     */
     topP?: number;
+    /**
+     * Number between -2.0 and 2.0. Positive values penalize new tokens based on their
+     * existing frequency in the text so far, decreasing the model's likelihood to
+     * repeat the same line verbatim.
+     */
     frequencyPenalty?: number;
+    /**
+     * Number between -2.0 and 2.0. Positive values penalize new tokens based on whether
+     * they appear in the text so far, increasing the model's likelihood to talk about new topics.
+     */
     presencePenalty?: number;
+    /**
+     * Top-k sampling parameter.
+     * Limits the model to only sample from the top K most likely tokens at each step.
+     * For example, k=50 means the model will only consider the 50 most likely next tokens.
+     * Not supported by all providers (e.g., OpenAI doesn't support this).
+     */
     topK?: number;
+    /**
+     * Minimum probability threshold for token sampling (0-1).
+     * Tokens with probability below this threshold are filtered out before sampling.
+     * This is a newer parameter not yet widely supported.
+     */
     minP?: number;
+    /**
+     * Number of top log probabilities to return per token.
+     * Only used when includeLogProbs is true.
+     * Typically ranges from 2-20, depending on the provider.
+     */
     topLogProbs?: number;
 }
+/**
+ * Returns the first user message from the chat params
+ * @param p
+ * @returns
+ */
 export declare function GetUserMessageFromChatParams(p: ChatParams): ChatMessageContent | undefined;
+/**
+ * Returns the first system message from the chat params
+ * @param p
+ * @returns
+ */
 export declare function GetSystemPromptFromChatParams(p: ChatParams): ChatMessageContent | undefined;
+/**
+ * Single message content token with log probability information.
+ */
 export type ChatResultSingleLogProb = {
+    /**
+     * A list of integers representing the UTF-8 bytes representation of the token.
+     * Useful in instances where characters are represented by multiple tokens and their byte representations
+     * must be combined to generate the correct text representation. Can be null if there is no bytes representation for the token.
+     */
     bytes: Array<number> | null;
+    /**
+     * The log probability of this token, if it is within the top 20 most likely tokens. Otherwise, the value -9999.0 is used to signify that the token is very unlikely.
+     */
     logprob: number;
+    /**
+     * The token itself, represented as a string. This is the actual text representation of the token.
+     */
     token: string;
+    /**
+     * List of the most likely tokens and their log probability, at this token position. In rare cases, there may be fewer than the number of requested top_logprobs returned.
+     */
     top_logprobs: Array<{
+        /**
+         * The token
+         */
         token: string;
+        /**
+         * The log probability of this token, if it is within the top 20 most likely tokens. Otherwise, the value -9999.0 is used to signify that the token is very unlikely.
+         */
         logprob: number;
+        /**
+         * A list of integers representing the UTF-8 bytes representation of the token.
+         * Useful in instances where characters are represented by multiple tokens and their byte representations must be
+         * combined to generate the correct text representation. Can be null if there is no bytes representation for the token.
+         */
         bytes: Array<number> | null;
     }> | null;
 };
+/**
+ * Log probability information for a given ChatResultChoice.
+ */
 export type ChatResultLogProbs = {
+    /**
+     * A list of message content tokens with log probability information.
+     */
     content: Array<ChatResultSingleLogProb> | null;
+    /**
+     * A list of message refusal tokens with log probability information.
+     */
     refusal: Array<ChatResultSingleLogProb> | null;
 };
+/**
+ * A single choice in the chat completion result.
+ */
 export type ChatResultChoice = {
     message: ChatCompletionMessage;
     finish_reason: string;
     index: number;
     logprobs?: ChatResultLogProbs | null;
 };
+/**
+ * A response returned from a chat model for a given chat completion request.
+ */
 export type ChatResultData = {
+    /**
+     * A list of chat completion choices. Can be more than one if n is greater than 1.
+     */
     choices: ChatResultChoice[];
+    /**
+     * The API name of the model used to generate the response. Some AI providers may return this as undefined.
+     */
     model?: string;
+    /**
+     * The number of tokens used in the request and response. Some AI providers may return this as undefined.
+     */
     usage?: ModelUsage;
 };
+/**
+ * Cache metadata returned from the provider
+ */
 export interface CacheMetadata {
+    /**
+     * Whether the request had a cache hit
+     */
     cacheHit?: boolean;
+    /**
+     * The number of tokens retrieved from cache
+     */
     cachedTokenCount?: number;
 }
 export declare class ChatResult extends BaseResult {
     data: ChatResultData;
     success: boolean;
     statusText: string;
+    /**
+     * Cache-related metadata if available from the provider
+     */
     cacheInfo?: CacheMetadata;
+    /**
+     * Optional provider-specific response metadata and details not captured in standard fields.
+     * This is a flexible field that can contain any additional information the AI provider returns.
+     * Structure varies by AI provider.
+     */
     modelSpecificResponseDetails?: Record<string, any>;
 }
+/**
+ * Prefix marker used to identify serialized content blocks in storage.
+ * When a message starts with this prefix, it indicates the content is a JSON array of ChatMessageContentBlock.
+ */
 export declare const CONTENT_BLOCKS_PREFIX = "$$CONTENT_BLOCKS$$";
+/**
+ * Serializes ChatMessageContent for storage in a database text field.
+ * - Plain strings are stored as-is for backward compatibility
+ * - Content block arrays are serialized as JSON with a prefix marker
+ *
+ * @param content The content to serialize
+ * @returns A string suitable for database storage
+ */
 export declare function serializeMessageContent(content: ChatMessageContent): string;
+/**
+ * Deserializes a stored message back to ChatMessageContent.
+ * - Messages with the content blocks prefix are parsed as JSON arrays
+ * - Other messages are returned as plain strings
+ *
+ * @param message The stored message string
+ * @returns The deserialized ChatMessageContent
+ */
 export declare function deserializeMessageContent(message: string): ChatMessageContent;
+/**
+ * Checks if the content contains any image blocks.
+ *
+ * @param content The message content to check
+ * @returns True if the content contains at least one image_url block
+ */
 export declare function hasImageContent(content: ChatMessageContent): boolean;
+/**
+ * Extracts just the text content from a ChatMessageContent, ignoring media blocks.
+ * Useful for display or logging purposes.
+ *
+ * @param content The message content
+ * @returns A plain text string with all text blocks joined
+ */
 export declare function getTextFromContent(content: ChatMessageContent): string;
+/**
+ * Parses a base64 data URL into its components.
+ *
+ * @param dataUrl A data URL (e.g., "data:image/png;base64,iVBORw...")
+ * @returns An object with mediaType and data, or null if not a valid data URL
+ */
 export declare function parseBase64DataUrl(dataUrl: string): {
     mediaType: string;
     data: string;
 } | null;
+/**
+ * Creates a data URL from raw base64 data and a MIME type.
+ *
+ * @param base64Data The raw base64 encoded data (without the data: prefix)
+ * @param mimeType The MIME type (e.g., 'image/png')
+ * @returns A complete data URL
+ */
 export declare function createBase64DataUrl(base64Data: string, mimeType: string): string;
 //# sourceMappingURL=chat.types.d.ts.map

package/dist/generic/chat.types.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"chat.types.d.ts","sourceRoot":"","sources":["../../src/generic/chat.types.ts"],"names":[],"mappings":";AAAA,OAAO,EAAE,UAAU,EAAE,UAAU,EAAE,UAAU,EAAE,MAAM,aAAa,CAAA;AAOhE,eAAO,MAAM,eAAe;;;;CAIlB,CAAC;AAEX,MAAM,MAAM,eAAe,GAAG,OAAO,eAAe,CAAC,MAAM,OAAO,eAAe,CAAC,CAAC;AAOnF,MAAM,MAAM,uBAAuB,GAAG;IAKlC,IAAI,EAAE,MAAM,GAAG,WAAW,GAAG,WAAW,GAAG,WAAW,GAAG,UAAU,CAAC;IAMpE,OAAO,EAAE,MAAM,CAAC;IAKhB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAIlB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAIlB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAIlB,KAAK,CAAC,EAAE,MAAM,CAAC;IAIf,MAAM,CAAC,EAAE,MAAM,CAAC;CACnB,CAAA;AAKD,MAAM,MAAM,kBAAkB,GAAG,MAAM,GAAG,uBAAuB,EAAE,CAAC;AAQpE,MAAM,MAAM,WAAW,CAAC,CAAC,GAAG,GAAG,IAAI;IAI/B,IAAI,EAAE,eAAe,CAAC;IAItB,OAAO,EAAE,kBAAkB,CAAC;IAM5B,QAAQ,CAAC,EAAE,CAAC,CAAC;CAChB,CAAA;AAKD,MAAM,MAAM,qBAAqB,GAAG;IAIhC,IAAI,EAAE,WAAW,CAAC;IAKlB,OAAO,EAAE,MAAM,CAAC;IAMhB,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC5B,CAAA;AAKD,MAAM,WAAW,sBAAsB;IAMnC,SAAS,CAAC,EAAE,CAAC,KAAK,EAAE,MAAM,EAAE,UAAU,EAAE,OAAO,KAAK,IAAI,CAAC;IAMzD,UAAU,CAAC,EAAE,CAAC,aAAa,EAAE,UAAU,KAAK,IAAI,CAAC;IAMjD,OAAO,CAAC,EAAE,CAAC,KAAK,EAAE,GAAG,KAAK,IAAI,CAAC;CAClC;AAKD,MAAM,WAAW,gCAAgC;IAM7C,YAAY,CAAC,EAAE,CAAC,QAAQ,EAAE,UAAU,EAAE,KAAK,EAAE,MAAM,KAAK,IAAI,CAAC;IAO7D,OAAO,CAAC,EAAE,CAAC,KAAK,EAAE,GAAG,EAAE,KAAK,EAAE,MAAM,KAAK,IAAI,CAAC;IAM9C,cAAc,CAAC,EAAE,CAAC,SAAS,EAAE,UAAU,EAAE,KAAK,IAAI,CAAC;CACtD;AAED,qBAAa,UAAW,SAAQ,UAAU;IAItC,QAAQ,EAAE,WAAW,EAAE,CAAM;IAO7B,SAAS,CAAC,EAAE,OAAO,CAAS;IAM5B,kBAAkB,CAAC,EAAE,sBAAsB,CAAC;IAK5C,WAAW,CAAC,EAAE,MAAM,CAAC;IAWrB,aAAa,CAAC,EAAE,OAAO,CAAQ;IAQ/B,eAAe,CAAC,EAAE,OAAO,CAAS;IAOlC,iBAAiB,CAAC,EAAE,WAAW,CAAC;IAWhC,IAAI,CAAC,EAAE,MAAM,CAAC;IAOd,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAM1B,eAAe,CAAC,EAAE,MAAM,CAAC;IAUzB,IAAI,CAAC,EAAE,MAAM,CAAC;IAOd,IAAI,CAAC,EAAE,MAAM,CAAC;IAOd,WAAW,CAAC,EAAE,MAAM,CAAC;CACxB;AAMD,wBAAgB,4BAA4B,CAAC,CAAC,EAAE,UAAU,GAAG,kBAAkB,GAAG,SAAS,CAE1F;AAMD,wBAAgB,6BAA6B,CAAC,CAAC,EAAE,UAAU,GAAG,kBAAkB,GAAG,SAAS,CAE3F;AAKD,MAAM,MAAM,uBAAuB,GAAG;IAMlC,KAAK,EAAE,KAAK,CAAC,MAAM,CAAC,GAAG,IAAI,CAAC;IAK5B,OAAO,EAAE,MAAM,CAAA;IAKf,KAAK,EAAE,MAAM,CAAA;IAKb,YAAY,EAAE,KAAK,CAAC;QAIhB,KAAK,EAAE,MAAM,CAAA;QAIb,OAAO,EAAE,MAAM,CAAA;QAMf,KAAK,EAAE,KAAK,CAAC,MAAM,CAAC,GAAG,IAAI,CAAC;KAC/B,CAAC,GAAG,IAAI,CAAC;CACb,CAAA;AAKD,MAAM,MAAM,kBAAkB,GAAG;IAI7B,OAAO,EAAE,KAAK,CAAC,uBAAuB,CAAC,GAAG,IAAI,CAAC;IAI/C,OAAO,EAAE,KAAK,CAAC,uBAAuB,CAAC,GAAG,IAAI,CAAC;CAClD,CAAA;AAKD,MAAM,MAAM,gBAAgB,GAAG;IAC3B,OAAO,EAAE,qBAAqB,CAAA;IAC9B,aAAa,EAAE,MAAM,CAAA;IACrB,KAAK,EAAE,MAAM,CAAA;IACb,QAAQ,CAAC,EAAE,kBAAkB,GAAG,IAAI,CAAA;CACvC,CAAA;AAKD,MAAM,MAAM,cAAc,GAAG;IAIzB,OAAO,EAAE,gBAAgB,EAAE,CAAA;IAI3B,KAAK,CAAC,EAAE,MAAM,CAAA;IAId,KAAK,CAAC,EAAE,UAAU,CAAA;CACrB,CAAA;AAKD,MAAM,WAAW,aAAa;IAI1B,QAAQ,CAAC,EAAE,OAAO,CAAC;IAKnB,gBAAgB,CAAC,EAAE,MAAM,CAAC;CAC7B;AAED,qBAAa,UAAW,SAAQ,UAAU;IACtC,IAAI,EAAE,cAAc,CAAC;IACrB,OAAO,EAAE,OAAO,CAAC;IACjB,UAAU,EAAE,MAAM,CAAC;IAKnB,SAAS,CAAC,EAAE,aAAa,CAAC;IAO1B,4BAA4B,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;CACtD;AAUD,eAAO,MAAM,qBAAqB,uBAAuB,CAAC;AAU1D,wBAAgB,uBAAuB,CAAC,OAAO,EAAE,kBAAkB,GAAG,MAAM,CAK3E;AAUD,wBAAgB,yBAAyB,CAAC,OAAO,EAAE,MAAM,GAAG,kBAAkB,CAa7E;AAQD,wBAAgB,eAAe,CAAC,OAAO,EAAE,kBAAkB,GAAG,OAAO,CAKpE;AASD,wBAAgB,kBAAkB,CAAC,OAAO,EAAE,kBAAkB,GAAG,MAAM,CAQtE;AAQD,wBAAgB,kBAAkB,CAAC,OAAO,EAAE,MAAM,GAAG;IAAE,SAAS,EAAE,MAAM,CAAC;IAAC,IAAI,EAAE,MAAM,CAAA;CAAE,GAAG,IAAI,CAS9F;AASD,wBAAgB,mBAAmB,CAAC,UAAU,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,GAAG,MAAM,CAEhF"}
+{"version":3,"file":"chat.types.d.ts","sourceRoot":"","sources":["../../src/generic/chat.types.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,UAAU,EAAE,UAAU,EAAE,MAAM,aAAa,CAAA;AAIhE;;GAEG;AACH,eAAO,MAAM,eAAe;;;;CAIlB,CAAC;AAEX,MAAM,MAAM,eAAe,GAAG,OAAO,eAAe,CAAC,MAAM,OAAO,eAAe,CAAC,CAAC;AAGnF;;;GAGG;AACH,MAAM,MAAM,uBAAuB,GAAG;IAClC;;;OAGG;IACH,IAAI,EAAE,MAAM,GAAG,WAAW,GAAG,WAAW,GAAG,WAAW,GAAG,UAAU,CAAC;IACpE;;;;OAIG;IACH,OAAO,EAAE,MAAM,CAAC;IAChB;;;OAGG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IACf;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;CACnB,CAAA;AAED;;GAEG;AACH,MAAM,MAAM,kBAAkB,GAAG,MAAM,GAAG,uBAAuB,EAAE,CAAC;AAEpE;;;;;GAKG;AACH,MAAM,MAAM,WAAW,CAAC,CAAC,GAAG,GAAG,IAAI;IAC/B;;OAEG;IACH,IAAI,EAAE,eAAe,CAAC;IACtB;;OAEG;IACH,OAAO,EAAE,kBAAkB,CAAC;IAC5B;;;;OAIG;IACH,QAAQ,CAAC,EAAE,CAAC,CAAC;CAChB,CAAA;AAED;;GAEG;AACH,MAAM,MAAM,qBAAqB,GAAG;IAChC;;OAEG;IACH,IAAI,EAAE,WAAW,CAAC;IAElB;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;;OAGG;IACH,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC5B,CAAA;AAED;;GAEG;AACH,MAAM,WAAW,sBAAsB;IACnC;;;;OAIG;IACH,SAAS,CAAC,EAAE,CAAC,KAAK,EAAE,MAAM,EAAE,UAAU,EAAE,OAAO,KAAK,IAAI,CAAC;IAEzD;;;OAGG;IACH,UAAU,CAAC,EAAE,CAAC,aAAa,EAAE,UAAU,KAAK,IAAI,CAAC;IAEjD;;;OAGG;IACH,OAAO,CAAC,EAAE,CAAC,KAAK,EAAE,GAAG,KAAK,IAAI,CAAC;CAClC;AAED;;GAEG;AACH,MAAM,WAAW,gCAAgC;IAC7C;;;;OAIG;IACH,YAAY,CAAC,EAAE,CAAC,QAAQ,EAAE,UAAU,EAAE,KAAK,EAAE,MAAM,KAAK,IAAI,CAAC;IAE7D;;;;OAIG;IACH,OAAO,CAAC,EAAE,CAAC,KAAK,EAAE,GAAG,EAAE,KAAK,EAAE,MAAM,KAAK,IAAI,CAAC;IAE9C;;;OAGG;IACH,cAAc,CAAC,EAAE,CAAC,SAAS,EAAE,UAAU,EAAE,KAAK,IAAI,CAAC;CACtD;AAED,qBAAa,UAAW,SAAQ,UAAU;IACtC;;OAEG;IACH,QAAQ,EAAE,WAAW,EAAE,CAAM;IAE7B;;;;OAIG;IACH,SAAS,CAAC,EAAE,OAAO,CAAS;IAE5B;;;OAGG;IACH,kBAAkB,CAAC,EAAE,sBAAsB,CAAC;IAE5C;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;;;;;;;OAQG;IACH,aAAa,CAAC,EAAE,OAAO,CAAQ;IAE/B;;;;;OAKG;IACH,eAAe,CAAC,EAAE,OAAO,CAAS;IAElC;;;;OAIG;IACH,iBAAiB,CAAC,EAAE,WAAW,CAAC;IAIhC;;;;;;OAMG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;;;OAIG;IACH,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAE1B;;;OAGG;IACH,eAAe,CAAC,EAAE,MAAM,CAAC;IAIzB;;;;;OAKG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;;;OAIG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;;;OAIG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;CACxB;AACD;;;;GAIG;AACH,wBAAgB,4BAA4B,CAAC,CAAC,EAAE,UAAU,GAAG,kBAAkB,GAAG,SAAS,CAE1F;AACD;;;;GAIG;AACH,wBAAgB,6BAA6B,CAAC,CAAC,EAAE,UAAU,GAAG,kBAAkB,GAAG,SAAS,CAE3F;AAED;;GAEG;AACH,MAAM,MAAM,uBAAuB,GAAG;IAClC;;;;OAIG;IACH,KAAK,EAAE,KAAK,CAAC,MAAM,CAAC,GAAG,IAAI,CAAC;IAE5B;;OAEG;IACH,OAAO,EAAE,MAAM,CAAA;IAEf;;OAEG;IACH,KAAK,EAAE,MAAM,CAAA;IAEb;;OAEG;IACH,YAAY,EAAE,KAAK,CAAC;QAChB;;WAEG;QACH,KAAK,EAAE,MAAM,CAAA;QACb;;WAEG;QACH,OAAO,EAAE,MAAM,CAAA;QACf;;;;WAIG;QACH,KAAK,EAAE,KAAK,CAAC,MAAM,CAAC,GAAG,IAAI,CAAC;KAC/B,CAAC,GAAG,IAAI,CAAC;CACb,CAAA;AAED;;GAEG;AACH,MAAM,MAAM,kBAAkB,GAAG;IAC7B;;OAEG;IACH,OAAO,EAAE,KAAK,CAAC,uBAAuB,CAAC,GAAG,IAAI,CAAC;IAC/C;;OAEG;IACH,OAAO,EAAE,KAAK,CAAC,uBAAuB,CAAC,GAAG,IAAI,CAAC;CAClD,CAAA;AAED;;GAEG;AACH,MAAM,MAAM,gBAAgB,GAAG;IAC3B,OAAO,EAAE,qBAAqB,CAAA;IAC9B,aAAa,EAAE,MAAM,CAAA;IACrB,KAAK,EAAE,MAAM,CAAA;IACb,QAAQ,CAAC,EAAE,kBAAkB,GAAG,IAAI,CAAA;CACvC,CAAA;AAED;;GAEG;AACH,MAAM,MAAM,cAAc,GAAG;IACzB;;OAEG;IACH,OAAO,EAAE,gBAAgB,EAAE,CAAA;IAC3B;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAA;IACd;;OAEG;IACH,KAAK,CAAC,EAAE,UAAU,CAAA;CACrB,CAAA;AAED;;GAEG;AACH,MAAM,WAAW,aAAa;IAC1B;;OAEG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAC;IAEnB;;OAEG;IACH,gBAAgB,CAAC,EAAE,MAAM,CAAC;CAC7B;AAED,qBAAa,UAAW,SAAQ,UAAU;IACtC,IAAI,EAAE,cAAc,CAAC;IACrB,OAAO,EAAE,OAAO,CAAC;IACjB,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,SAAS,CAAC,EAAE,aAAa,CAAC;IAE1B;;;;OAIG;IACH,4BAA4B,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;CACtD;AAMD;;;GAGG;AACH,eAAO,MAAM,qBAAqB,uBAAuB,CAAC;AAE1D;;;;;;;GAOG;AACH,wBAAgB,uBAAuB,CAAC,OAAO,EAAE,kBAAkB,GAAG,MAAM,CAK3E;AAED;;;;;;;GAOG;AACH,wBAAgB,yBAAyB,CAAC,OAAO,EAAE,MAAM,GAAG,kBAAkB,CAa7E;AAED;;;;;GAKG;AACH,wBAAgB,eAAe,CAAC,OAAO,EAAE,kBAAkB,GAAG,OAAO,CAKpE;AAED;;;;;;GAMG;AACH,wBAAgB,kBAAkB,CAAC,OAAO,EAAE,kBAAkB,GAAG,MAAM,CAQtE;AAED;;;;;GAKG;AACH,wBAAgB,kBAAkB,CAAC,OAAO,EAAE,MAAM,GAAG;IAAE,SAAS,EAAE,MAAM,CAAC;IAAC,IAAI,EAAE,MAAM,CAAA;CAAE,GAAG,IAAI,CAS9F;AAED;;;;;;GAMG;AACH,wBAAgB,mBAAmB,CAAC,UAAU,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,GAAG,MAAM,CAEhF"}

package/dist/generic/chat.types.js

@@ -1,64 +1,127 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.createBase64DataUrl = exports.parseBase64DataUrl = exports.getTextFromContent = exports.hasImageContent = exports.deserializeMessageContent = exports.serializeMessageContent = exports.CONTENT_BLOCKS_PREFIX = exports.ChatResult = exports.GetSystemPromptFromChatParams = exports.GetUserMessageFromChatParams = exports.ChatParams = exports.ChatMessageRole = void 0;
-const baseModel_1 = require("./baseModel");
-exports.ChatMessageRole = {
+import { BaseParams, BaseResult } from "./baseModel.js";
+/**
+ * The possible roles for a chat message.
+ */
+export const ChatMessageRole = {
     system: 'system',
     user: 'user',
     assistant: 'assistant'
 };
-class ChatParams extends baseModel_1.BaseParams {
+export class ChatParams extends BaseParams {
     constructor() {
         super(...arguments);
+        /**
+         * Array of messages, allows full control over the order and content of the conversation.
+         */
         this.messages = [];
+        /**
+         * Whether to use streaming for this request.
+         * If true and the provider supports streaming, responses will be streamed.
+         * If true but the provider doesn't support streaming, the request will fall back to non-streaming.
+         */
         this.streaming = false;
+        /**
+         * Whether to enable caching for this request.
+         * Implementation depends on the specific provider (the below are examples, many other providers exist):
+         * - For Anthropic: Uses Anthropic's ephemeral cache control to cache system prompt and last user message.
+         * - For OpenAI: Uses automatic caching (provider handles it).
+         * - For other providers: May be a no-op if caching isn't supported.
+         *
+         * @default true - Caching is enabled by default for providers that support it.
+         */
         this.enableCaching = true;
+        /**
+         * Not all AI providers support this feature. When supported, this parameter indicates if logprobs are requested.
+         * Logprobs provide information about the likelihood of each token in the response.
+         * This can be useful for debugging or understanding the model's behavior.
+         * When models support this and this property is set to true, the model will return logprobs for the tokens in the @see ChatResultData object within the array of @see ChatResultChoice objects.
+         */
         this.includeLogProbs = false;
     }
 }
-exports.ChatParams = ChatParams;
-function GetUserMessageFromChatParams(p) {
-    return p.messages.find(m => m.role === exports.ChatMessageRole.user)?.content;
+/**
+ * Returns the first user message from the chat params
+ * @param p
+ * @returns
+ */
+export function GetUserMessageFromChatParams(p) {
+    return p.messages.find(m => m.role === ChatMessageRole.user)?.content;
 }
-exports.GetUserMessageFromChatParams = GetUserMessageFromChatParams;
-function GetSystemPromptFromChatParams(p) {
-    return p.messages.find(m => m.role === exports.ChatMessageRole.system)?.content;
+/**
+ * Returns the first system message from the chat params
+ * @param p
+ * @returns
+ */
+export function GetSystemPromptFromChatParams(p) {
+    return p.messages.find(m => m.role === ChatMessageRole.system)?.content;
 }
-exports.GetSystemPromptFromChatParams = GetSystemPromptFromChatParams;
-class ChatResult extends baseModel_1.BaseResult {
+export class ChatResult extends BaseResult {
 }
-exports.ChatResult = ChatResult;
-exports.CONTENT_BLOCKS_PREFIX = '$$CONTENT_BLOCKS$$';
-function serializeMessageContent(content) {
+// =============================================================================
+// Content Serialization Utilities
+// =============================================================================
+/**
+ * Prefix marker used to identify serialized content blocks in storage.
+ * When a message starts with this prefix, it indicates the content is a JSON array of ChatMessageContentBlock.
+ */
+export const CONTENT_BLOCKS_PREFIX = '$$CONTENT_BLOCKS$$';
+/**
+ * Serializes ChatMessageContent for storage in a database text field.
+ * - Plain strings are stored as-is for backward compatibility
+ * - Content block arrays are serialized as JSON with a prefix marker
+ *
+ * @param content The content to serialize
+ * @returns A string suitable for database storage
+ */
+export function serializeMessageContent(content) {
     if (typeof content === 'string') {
         return content;
     }
-    return exports.CONTENT_BLOCKS_PREFIX + JSON.stringify(content);
+    return CONTENT_BLOCKS_PREFIX + JSON.stringify(content);
 }
-exports.serializeMessageContent = serializeMessageContent;
-function deserializeMessageContent(message) {
+/**
+ * Deserializes a stored message back to ChatMessageContent.
+ * - Messages with the content blocks prefix are parsed as JSON arrays
+ * - Other messages are returned as plain strings
+ *
+ * @param message The stored message string
+ * @returns The deserialized ChatMessageContent
+ */
+export function deserializeMessageContent(message) {
     if (!message) {
         return '';
     }
-    if (message.startsWith(exports.CONTENT_BLOCKS_PREFIX)) {
+    if (message.startsWith(CONTENT_BLOCKS_PREFIX)) {
         try {
-            return JSON.parse(message.substring(exports.CONTENT_BLOCKS_PREFIX.length));
+            return JSON.parse(message.substring(CONTENT_BLOCKS_PREFIX.length));
         }
         catch {
-            return message.substring(exports.CONTENT_BLOCKS_PREFIX.length);
+            // If parsing fails, return the original message minus the prefix
+            return message.substring(CONTENT_BLOCKS_PREFIX.length);
         }
     }
     return message;
 }
-exports.deserializeMessageContent = deserializeMessageContent;
-function hasImageContent(content) {
+/**
+ * Checks if the content contains any image blocks.
+ *
+ * @param content The message content to check
+ * @returns True if the content contains at least one image_url block
+ */
+export function hasImageContent(content) {
     if (typeof content === 'string') {
         return false;
     }
     return content.some(block => block.type === 'image_url');
 }
-exports.hasImageContent = hasImageContent;
-function getTextFromContent(content) {
+/**
+ * Extracts just the text content from a ChatMessageContent, ignoring media blocks.
+ * Useful for display or logging purposes.
+ *
+ * @param content The message content
+ * @returns A plain text string with all text blocks joined
+ */
+export function getTextFromContent(content) {
     if (typeof content === 'string') {
         return content;
     }
@@ -67,8 +130,13 @@ function getTextFromContent(content) {
         .map(block => block.content)
         .join('\n');
 }
-exports.getTextFromContent = getTextFromContent;
-function parseBase64DataUrl(dataUrl) {
+/**
+ * Parses a base64 data URL into its components.
+ *
+ * @param dataUrl A data URL (e.g., "data:image/png;base64,iVBORw...")
+ * @returns An object with mediaType and data, or null if not a valid data URL
+ */
+export function parseBase64DataUrl(dataUrl) {
     if (!dataUrl.startsWith('data:')) {
         return null;
     }
@@ -78,9 +146,14 @@ function parseBase64DataUrl(dataUrl) {
     }
     return null;
 }
-exports.parseBase64DataUrl = parseBase64DataUrl;
-function createBase64DataUrl(base64Data, mimeType) {
+/**
+ * Creates a data URL from raw base64 data and a MIME type.
+ *
+ * @param base64Data The raw base64 encoded data (without the data: prefix)
+ * @param mimeType The MIME type (e.g., 'image/png')
+ * @returns A complete data URL
+ */
+export function createBase64DataUrl(base64Data, mimeType) {
     return `data:${mimeType};base64,${base64Data}`;
 }
-exports.createBase64DataUrl = createBase64DataUrl;
 //# sourceMappingURL=chat.types.js.map

package/dist/generic/chat.types.js.map

@@ -1 +1 @@
-{"version":3,"file":"chat.types.js","sourceRoot":"","sources":["../../src/generic/chat.types.ts"],"names":[],"mappings":";;;AAAA,2CAAgE;AAOnD,QAAA,eAAe,GAAG;IAC3B,MAAM,EAAE,QAAQ;IAChB,IAAI,EAAE,MAAM;IACZ,SAAS,EAAE,WAAW;CAChB,CAAC;AA8IX,MAAa,UAAW,SAAQ,sBAAU;IAA1C;;QAII,aAAQ,GAAkB,EAAE,CAAC;QAO7B,cAAS,GAAa,KAAK,CAAC;QAsB5B,kBAAa,GAAa,IAAI,CAAC;QAQ/B,oBAAe,GAAa,KAAK,CAAC;IAwDtC,CAAC;CAAA;AAjGD,gCAiGC;AAMD,SAAgB,4BAA4B,CAAC,CAAa;IACtD,OAAO,CAAC,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,KAAK,uBAAe,CAAC,IAAI,CAAC,EAAE,OAAO,CAAC;AAC1E,CAAC;AAFD,oEAEC;AAMD,SAAgB,6BAA6B,CAAC,CAAa;IACvD,OAAO,CAAC,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,KAAK,uBAAe,CAAC,MAAM,CAAC,EAAE,OAAO,CAAC;AAC5E,CAAC;AAFD,sEAEC;AAqGD,MAAa,UAAW,SAAQ,sBAAU;CAgBzC;AAhBD,gCAgBC;AAUY,QAAA,qBAAqB,GAAG,oBAAoB,CAAC;AAU1D,SAAgB,uBAAuB,CAAC,OAA2B;IAC/D,IAAI,OAAO,OAAO,KAAK,QAAQ,EAAE,CAAC;QAC9B,OAAO,OAAO,CAAC;IACnB,CAAC;IACD,OAAO,6BAAqB,GAAG,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC;AAC3D,CAAC;AALD,0DAKC;AAUD,SAAgB,yBAAyB,CAAC,OAAe;IACrD,IAAI,CAAC,OAAO,EAAE,CAAC;QACX,OAAO,EAAE,CAAC;IACd,CAAC;IACD,IAAI,OAAO,CAAC,UAAU,CAAC,6BAAqB,CAAC,EAAE,CAAC;QAC5C,IAAI,CAAC;YACD,OAAO,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,SAAS,CAAC,6BAAqB,CAAC,MAAM,CAAC,CAA8B,CAAC;QACpG,CAAC;QAAC,MAAM,CAAC;YAEL,OAAO,OAAO,CAAC,SAAS,CAAC,6BAAqB,CAAC,MAAM,CAAC,CAAC;QAC3D,CAAC;IACL,CAAC;IACD,OAAO,OAAO,CAAC;AACnB,CAAC;AAbD,8DAaC;AAQD,SAAgB,eAAe,CAAC,OAA2B;IACvD,IAAI,OAAO,OAAO,KAAK,QAAQ,EAAE,CAAC;QAC9B,OAAO,KAAK,CAAC;IACjB,CAAC;IACD,OAAO,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC,KAAK,CAAC,IAAI,KAAK,WAAW,CAAC,CAAC;AAC7D,CAAC;AALD,0CAKC;AASD,SAAgB,kBAAkB,CAAC,OAA2B;IAC1D,IAAI,OAAO,OAAO,KAAK,QAAQ,EAAE,CAAC;QAC9B,OAAO,OAAO,CAAC;IACnB,CAAC;IACD,OAAO,OAAO;SACT,MAAM,CAAC,KAAK,CAAC,EAAE,CAAC,KAAK,CAAC,IAAI,KAAK,MAAM,CAAC;SACtC,GAAG,CAAC,KAAK,CAAC,EAAE,CAAC,KAAK,CAAC,OAAO,CAAC;SAC3B,IAAI,CAAC,IAAI,CAAC,CAAC;AACpB,CAAC;AARD,gDAQC;AAQD,SAAgB,kBAAkB,CAAC,OAAe;IAC9C,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,OAAO,CAAC,EAAE,CAAC;QAC/B,OAAO,IAAI,CAAC;IAChB,CAAC;IACD,MAAM,KAAK,GAAG,OAAO,CAAC,KAAK,CAAC,4BAA4B,CAAC,CAAC;IAC1D,IAAI,KAAK,EAAE,CAAC;QACR,OAAO,EAAE,SAAS,EAAE,KAAK,CAAC,CAAC,CAAC,EAAE,IAAI,EAAE,KAAK,CAAC,CAAC,CAAC,EAAE,CAAC;IACnD,CAAC;IACD,OAAO,IAAI,CAAC;AAChB,CAAC;AATD,gDASC;AASD,SAAgB,mBAAmB,CAAC,UAAkB,EAAE,QAAgB;IACpE,OAAO,QAAQ,QAAQ,WAAW,UAAU,EAAE,CAAC;AACnD,CAAC;AAFD,kDAEC"}
+{"version":3,"file":"chat.types.js","sourceRoot":"","sources":["../../src/generic/chat.types.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,UAAU,EAAc,MAAM,aAAa,CAAA;AAIhE;;GAEG;AACH,MAAM,CAAC,MAAM,eAAe,GAAG;IAC3B,MAAM,EAAE,QAAQ;IAChB,IAAI,EAAE,MAAM;IACZ,SAAS,EAAE,WAAW;CAChB,CAAC;AA8IX,MAAM,OAAO,UAAW,SAAQ,UAAU;IAA1C;;QACI;;WAEG;QACH,aAAQ,GAAkB,EAAE,CAAC;QAE7B;;;;WAIG;QACH,cAAS,GAAa,KAAK,CAAC;QAa5B;;;;;;;;WAQG;QACH,kBAAa,GAAa,IAAI,CAAC;QAE/B;;;;;WAKG;QACH,oBAAe,GAAa,KAAK,CAAC;IAwDtC,CAAC;CAAA;AACD;;;;GAIG;AACH,MAAM,UAAU,4BAA4B,CAAC,CAAa;IACtD,OAAO,CAAC,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,KAAK,eAAe,CAAC,IAAI,CAAC,EAAE,OAAO,CAAC;AAC1E,CAAC;AACD;;;;GAIG;AACH,MAAM,UAAU,6BAA6B,CAAC,CAAa;IACvD,OAAO,CAAC,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,KAAK,eAAe,CAAC,MAAM,CAAC,EAAE,OAAO,CAAC;AAC5E,CAAC;AAqGD,MAAM,OAAO,UAAW,SAAQ,UAAU;CAgBzC;AAED,gFAAgF;AAChF,kCAAkC;AAClC,gFAAgF;AAEhF;;;GAGG;AACH,MAAM,CAAC,MAAM,qBAAqB,GAAG,oBAAoB,CAAC;AAE1D;;;;;;;GAOG;AACH,MAAM,UAAU,uBAAuB,CAAC,OAA2B;IAC/D,IAAI,OAAO,OAAO,KAAK,QAAQ,EAAE,CAAC;QAC9B,OAAO,OAAO,CAAC;IACnB,CAAC;IACD,OAAO,qBAAqB,GAAG,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC;AAC3D,CAAC;AAED;;;;;;;GAOG;AACH,MAAM,UAAU,yBAAyB,CAAC,OAAe;IACrD,IAAI,CAAC,OAAO,EAAE,CAAC;QACX,OAAO,EAAE,CAAC;IACd,CAAC;IACD,IAAI,OAAO,CAAC,UAAU,CAAC,qBAAqB,CAAC,EAAE,CAAC;QAC5C,IAAI,CAAC;YACD,OAAO,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,SAAS,CAAC,qBAAqB,CAAC,MAAM,CAAC,CAA8B,CAAC;QACpG,CAAC;QAAC,MAAM,CAAC;YACL,iEAAiE;YACjE,OAAO,OAAO,CAAC,SAAS,CAAC,qBAAqB,CAAC,MAAM,CAAC,CAAC;QAC3D,CAAC;IACL,CAAC;IACD,OAAO,OAAO,CAAC;AACnB,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,eAAe,CAAC,OAA2B;IACvD,IAAI,OAAO,OAAO,KAAK,QAAQ,EAAE,CAAC;QAC9B,OAAO,KAAK,CAAC;IACjB,CAAC;IACD,OAAO,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC,KAAK,CAAC,IAAI,KAAK,WAAW,CAAC,CAAC;AAC7D,CAAC;AAED;;;;;;GAMG;AACH,MAAM,UAAU,kBAAkB,CAAC,OAA2B;IAC1D,IAAI,OAAO,OAAO,KAAK,QAAQ,EAAE,CAAC;QAC9B,OAAO,OAAO,CAAC;IACnB,CAAC;IACD,OAAO,OAAO;SACT,MAAM,CAAC,KAAK,CAAC,EAAE,CAAC,KAAK,CAAC,IAAI,KAAK,MAAM,CAAC;SACtC,GAAG,CAAC,KAAK,CAAC,EAAE,CAAC,KAAK,CAAC,OAAO,CAAC;SAC3B,IAAI,CAAC,IAAI,CAAC,CAAC;AACpB,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,kBAAkB,CAAC,OAAe;IAC9C,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,OAAO,CAAC,EAAE,CAAC;QAC/B,OAAO,IAAI,CAAC;IAChB,CAAC;IACD,MAAM,KAAK,GAAG,OAAO,CAAC,KAAK,CAAC,4BAA4B,CAAC,CAAC;IAC1D,IAAI,KAAK,EAAE,CAAC;QACR,OAAO,EAAE,SAAS,EAAE,KAAK,CAAC,CAAC,CAAC,EAAE,IAAI,EAAE,KAAK,CAAC,CAAC,CAAC,EAAE,CAAC;IACnD,CAAC;IACD,OAAO,IAAI,CAAC;AAChB,CAAC;AAED;;;;;;GAMG;AACH,MAAM,UAAU,mBAAmB,CAAC,UAAkB,EAAE,QAAgB;IACpE,OAAO,QAAQ,QAAQ,WAAW,UAAU,EAAE,CAAC;AACnD,CAAC"}

package/dist/generic/classify.types.d.ts

@@ -1,5 +1,8 @@
-import { BaseResult } from "./baseModel";
-import { ChatParams } from "./chat.types";
+import { BaseResult } from "./baseModel.js";
+import { ChatParams } from "./chat.types.js";
+/**
+ * Defined in order to have this type available for future use with additional properties beyond the BaseParams type.
+ */
 export declare class ClassifyParams extends ChatParams {
 }
 export declare class ClassifyTag {

package/dist/generic/classify.types.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"classify.types.d.ts","sourceRoot":"","sources":["../../src/generic/classify.types.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAc,MAAM,aAAa,CAAA;AACpD,OAAO,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAK1C,qBAAa,cAAe,SAAQ,UAAU;CAC7C;AAED,qBAAa,WAAW;gBACR,GAAG,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM;IAI3C,GAAG,EAAE,MAAM,CAAA;IACX,UAAU,EAAE,MAAM,CAAA;CACrB;AAED,qBAAa,cAAe,SAAQ,UAAU;IAC1C,SAAS,EAAE,MAAM,CAAA;IACjB,IAAI,EAAE,WAAW,EAAE,CAAA;IACnB,aAAa,EAAE,MAAM,CAAA;CACxB"}
+{"version":3,"file":"classify.types.d.ts","sourceRoot":"","sources":["../../src/generic/classify.types.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAc,MAAM,aAAa,CAAA;AACpD,OAAO,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAE1C;;GAEG;AACH,qBAAa,cAAe,SAAQ,UAAU;CAC7C;AAED,qBAAa,WAAW;gBACR,GAAG,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM;IAI3C,GAAG,EAAE,MAAM,CAAA;IACX,UAAU,EAAE,MAAM,CAAA;CACrB;AAED,qBAAa,cAAe,SAAQ,UAAU;IAC1C,SAAS,EAAE,MAAM,CAAA;IACjB,IAAI,EAAE,WAAW,EAAE,CAAA;IACnB,aAAa,EAAE,MAAM,CAAA;CACxB"}

package/dist/generic/classify.types.js

@@ -1,19 +1,16 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.ClassifyResult = exports.ClassifyTag = exports.ClassifyParams = void 0;
-const baseModel_1 = require("./baseModel");
-const chat_types_1 = require("./chat.types");
-class ClassifyParams extends chat_types_1.ChatParams {
+import { BaseResult } from "./baseModel.js";
+import { ChatParams } from "./chat.types.js";
+/**
+ * Defined in order to have this type available for future use with additional properties beyond the BaseParams type.
+ */
+export class ClassifyParams extends ChatParams {
 }
-exports.ClassifyParams = ClassifyParams;
-class ClassifyTag {
+export class ClassifyTag {
     constructor(tag, confidence) {
         this.tag = tag;
         this.confidence = confidence;
     }
 }
-exports.ClassifyTag = ClassifyTag;
-class ClassifyResult extends baseModel_1.BaseResult {
+export class ClassifyResult extends BaseResult {
 }
-exports.ClassifyResult = ClassifyResult;
 //# sourceMappingURL=classify.types.js.map