@squidcloud/client 1.0.277 → 1.0.279

package/dist/internal-common/src/public-types/ai-chatbot.public-types.d.ts

@@ -10,28 +10,49 @@ export declare const OPENAI_EMBEDDINGS_MODEL_NAMES: readonly ["text-embedding-3-
 export declare const AI_EMBEDDINGS_MODEL_NAMES: readonly ["text-embedding-3-small", "text-embedding-3-large", "text-embedding-ada-002"];
 /** The supported AI image generation model names. */
 export declare const OPENAI_IMAGE_MODEL_NAMES: readonly ["dall-e-3"];
-export declare const OPENAI_AUDIO_MODEL_NAMES: readonly ["whisper-1"];
+export declare const OPENAI_AUDIO_TRANSCRIPTION_MODEL_NAMES: readonly ["whisper-1"];
+export declare const OPENAI_AUDIO_CREATE_SPEECH_MODEL_NAMES: readonly ["tts-1", "tts-1-hd"];
+export declare const OPENAI_AUDIO_MODEL_NAMES: readonly ["whisper-1", "tts-1", "tts-1-hd"];
 export declare const STABLE_DIFFUSION_MODEL_NAMES: readonly ["stable-diffusion-core"];
 export declare const AI_IMAGE_MODEL_NAMES: readonly ["dall-e-3", "stable-diffusion-core"];
-export declare const AI_AUDIO_MODEL_NAMES: readonly ["whisper-1"];
+export declare const AI_AUDIO_TRANSCRIPTION_MODEL_NAMES: readonly ["whisper-1"];
+export declare const AI_AUDIO_CREATE_SPEECH_MODEL_NAMES: readonly ["tts-1", "tts-1-hd"];
+export declare const OPEN_AI_CREATE_SPEECH_FORMATS: readonly ["mp3", "opus", "aac", "flac", "wav", "pcm"];
 export type AiChatModelName = (typeof AI_CHAT_MODEL_NAMES)[number];
 export type AiEmbeddingsModelName = (typeof AI_EMBEDDINGS_MODEL_NAMES)[number];
 export type OpenAiChatModelName = (typeof OPENAI_CHAT_MODEL_NAMES)[number];
 export type GeminiChatModelName = (typeof GEMINI_CHAT_MODEL_NAMES)[number];
 export type AnthropicChatModelName = (typeof ANTHROPIC_CHAT_MODEL_NAMES)[number];
 export type AiImageModelName = (typeof AI_IMAGE_MODEL_NAMES)[number];
-export type AiAudioModelName = (typeof AI_AUDIO_MODEL_NAMES)[number];
+export type AiAudioTranscriptionModelName = (typeof AI_AUDIO_TRANSCRIPTION_MODEL_NAMES)[number];
+export type AiAudioCreateSpeechModelName = (typeof OPENAI_AUDIO_CREATE_SPEECH_MODEL_NAMES)[number];
+export type AiAudioModelName = (typeof OPENAI_AUDIO_MODEL_NAMES)[number];
 export type OpenAiImageModelName = (typeof OPENAI_IMAGE_MODEL_NAMES)[number];
-export type OpenAiAudioModelName = (typeof OPENAI_AUDIO_MODEL_NAMES)[number];
+export type OpenAiAudioTranscriptionModelName = (typeof OPENAI_AUDIO_TRANSCRIPTION_MODEL_NAMES)[number];
+export type OpenAiAudioCreateSpeechModelName = (typeof OPENAI_AUDIO_CREATE_SPEECH_MODEL_NAMES)[number];
+export type OpenAiCreateSpeechFormat = (typeof OPEN_AI_CREATE_SPEECH_FORMATS)[number];
 export type StableDiffusionModelName = (typeof STABLE_DIFFUSION_MODEL_NAMES)[number];
 export type AiGenerateImageOptions = DallEOptions | StableDiffusionCoreOptions;
 export type AiAudioTranscribeOptions = WhisperOptions;
+export type AiAudioCreateSpeechOptions = OpenAiCreateSpeechOptions;
 export type VectorDbType = 'pinecone' | 'postgres';
+export interface AiAudioCreateSpeechResponse {
+    mimeType: string;
+    extension: string;
+    base64File: string;
+}
+export interface AiAudioCreateSpeechRequest {
+    input: string;
+    options: AiAudioCreateSpeechOptions;
+}
 export interface BaseAiGenerateImageOptions {
     modelName: AiImageModelName;
 }
 export interface BaseAiAudioTranscribeOptions {
-    modelName: AiAudioModelName;
+    modelName: AiAudioTranscriptionModelName;
+}
+export interface BaseAiAudioCreateSpeechOptions {
+    modelName: AiAudioCreateSpeechModelName;
 }
 export interface DallEOptions extends BaseAiGenerateImageOptions {
     modelName: 'dall-e-3';
@@ -45,6 +66,12 @@ export interface WhisperOptions extends BaseAiAudioTranscribeOptions {
     temperature?: number;
     prompt?: string;
 }
+export interface OpenAiCreateSpeechOptions extends BaseAiAudioCreateSpeechOptions {
+    modelName: OpenAiAudioCreateSpeechModelName;
+    voice?: 'alloy' | 'echo' | 'fable' | 'onyx' | 'nova' | 'shimmer';
+    responseFormat?: OpenAiCreateSpeechFormat;
+    speed?: number;
+}
 export interface StableDiffusionCoreOptions extends BaseAiGenerateImageOptions {
     modelName: 'stable-diffusion-core';
     aspectRatio?: '16:9' | '1:1' | '21:9' | '2:3' | '3:2' | '4:5' | '5:4' | '9:16' | '9:21';
@@ -89,6 +116,27 @@ export interface AiChatbotChatOptions {
     instructions?: Array<string>;
     /** A set of filters that will limit the context the AI can access */
     contextMetadataFilter?: AiContextMetadataFilter;
+    /** The options to use for the response in voice */
+    voiceOptions?: AiAudioCreateSpeechOptions;
+}
+export interface AiAskResponse {
+    responseString: string;
+}
+export interface AiTranscribeAndAskResponse {
+    responseString: string;
+    transcribedPrompt: string;
+}
+export interface AiAskWithVoiceResponse {
+    responseString: string;
+    voiceResponse: AiAudioCreateSpeechResponse;
+}
+export interface AiTranscribeAndAskWithVoiceResponse {
+    transcribedPrompt: string;
+    responseString: string;
+    voiceResponse: AiAudioCreateSpeechResponse;
+}
+export interface AiTranscribeAndChatResponse {
+    transcribedPrompt: string;
 }
 /** The options for the AI chatbot search method. */
 export interface AiSearchOptions {
@@ -136,7 +184,7 @@ export interface AiChatbotFileContext extends AiChatbotContextBase {
     minImageHeight?: number;
 }
 export declare class AiChatbotChatContext {
-    readonly prompt: string;
+    readonly prompt?: string;
     readonly profileId: string;
 }
 export type AiChatbotContext = AiChatbotTextContext | AiChatbotUrlContext | AiChatbotFileContext;

package/dist/internal-common/src/public-types/integration.public-types.d.ts

@@ -27,6 +27,7 @@ export declare enum IntegrationType {
     'built_in_s3' = "built_in_s3",
     'built_in_gcs' = "built_in_gcs",
     'google_drive' = "google_drive",
+    'ai_agents' = "ai_agents",
     'algolia' = "algolia",
     'elastic_observability' = "elastic_observability",
     'elastic_search' = "elastic_search",

package/dist/internal-common/src/public-types/metric.public-types.d.ts

@@ -1,10 +1,124 @@
 /**
- * A timestamp + value pair. If there is no data for the point 'null' value is used.
+ * Name of metrics publicly provided by the system.
+ * - Metrics suffixed by '_time' are 'gauge' metrics.
+ * - Metrics suffixed by '_count' are 'count' metrics.
+ * All Squid metrics starts with `squid_` prefix.
+ */
+export declare const SQUID_METRIC_NAMES: readonly ["squid_functionExecution_count", "squid_functionExecution_time"];
+export type SquidMetricName = (typeof SQUID_METRIC_NAMES)[number];
+export declare const METRIC_FUNCTIONS: readonly ["sum", "max", "min", "average", "median", "p95", "p99", "count"];
+export type MetricFunction = (typeof METRIC_FUNCTIONS)[number];
+/** Defines source of the metric: reported by user or automatically collected by the system (Squid). */
+export declare const METRIC_DOMAIN: readonly ["user", "squid"];
+export type MetricDomain = (typeof METRIC_DOMAIN)[number];
+export declare const METRIC_INTERVAL_ALIGNMENT: readonly ["align-by-start-time", "align-by-end-time"];
+/** Indicates how to align per-point periods in metric queries. */
+export type MetricIntervalAlignment = (typeof METRIC_INTERVAL_ALIGNMENT)[number];
+export interface QueryMetricsRequestCommon {
+    /** Kind of the metrics (domain) to query. */
+    domain: MetricDomain;
+    /** Start of the queried interval. Must be an integer value. */
+    periodStartSeconds: number;
+    /** End of the queried interval. Must be an integer value. */
+    periodEndSeconds: number;
+    /**
+     * Time interval per point. Must be less than  periodEndSeconds - periodStartSeconds.
+     * Set to 0 or keep undefined to have only 1 value in the result.
+     */
+    pointIntervalSeconds?: number;
+    /**
+     * Specifies the alignment of the per-point interval.
+     * Default: 'align-by-start-time'
+     */
+    pointIntervalAlignment?: MetricIntervalAlignment;
+    /** Aggregation functions that maps multiple points per point region to a single point value. */
+    fn: MetricFunction | Array<MetricFunction>;
+    /**
+     * If there is no data in the specified region this value will be used to fill the gap.
+     * Default: null.
+     */
+    fillValue?: number | null;
+    /**
+     * Tag filters.
+     * TODO: add operations to exclude tags: !=, !contains...
+     */
+    tagFilter?: Record<string, string>;
+    /**
+     * A mapping of known tag values that must be present in the response groups.
+     *
+     * This ensures that the result will include groups for all specified tag values,
+     * even if there is no data for some values in the database.
+     *
+     * Example: Consider a tag 'isError' with two possible values: '0' and '1'.
+     * When 'tagDomains' contains {'isError': ['0', '1']}, the result will include
+     * groups for both 'isError: 0' and 'isError: 1'. If the database lacks data for
+     * 'isError: 1', the points in this group will be set to 'fillValue' (default is 'null').
+     *
+     * The tags in the new groups will be copied from the existing resultGroups,
+     * along with one of the tag domain values.
+     *
+     * @property {Record<string, string[]>} tagDomains - A record where each key is a tag name and
+     * each value is an array of possible values for that tag. Should only contain tags listed in 'groupByTags' field.
+     */
+    tagDomains?: Record<string, string[]>;
+    /** List of ordered tag names for a 'GROUP BY'. */
+    groupByTags?: string[];
+    /** The results will be ordered by the specified tags (ORDER BY). */
+    orderByTags?: string[];
+    /**
+     * Specifies what result will be returned if there were no records found in the database.
+     * In this case the 'resultGroups' array will be empty (default), or can be filled with a default
+     * values if 'return-result-group-with-default-values' is specified.
+     * The generated result group will have 'tagValues' set to empty strings.
+     *
+     * May be useful to get a ready-to-render array with no additional post-processing required.
+     *
+     * Note: 'tagDomains' can provide similar functionality when set of tag values is defined: multiple result groups
+     * will be filled with default values. There is no need to use this option if 'tagDomains' is used.
+     *
+     * Default: 'return-no-result-groups'
+     */
+    noDataBehavior?: 'return-no-result-groups' | 'return-result-group-with-default-values';
+}
+export interface QueryUserMetricsRequest<NameType extends string = string> extends QueryMetricsRequestCommon {
+    domain: 'user';
+    /** Squid metric name. */
+    name: NameType;
+}
+export interface QuerySquidMetricsRequest<NameType extends SquidMetricName = SquidMetricName> extends QueryMetricsRequestCommon {
+    domain: 'squid';
+    /** User metric name. */
+    name: NameType;
+}
+export type QueryMetricsRequest<NameType extends string = string> = QuerySquidMetricsRequest<NameType extends SquidMetricName ? NameType : SquidMetricName> | QueryUserMetricsRequest<NameType>;
+/**
+ * Every result point is a list of [timestamp, values...],
+ * where list of values are defined by the list of functions in the request.
+ * If there is no data for the point 'null' is used as a 'value'.
  * The timestamp is always equal to the point period start date and is measured in Unix epoch seconds.
  */
-export type QueryMetricResultPoint = [number, number | null];
-export interface QueryMetricResultGroup {
+export type QueryMetricsResultPoint = [number, ...(number | null)[]];
+export interface QueryMetricsResultGroup {
     /** Values of the tags in the group. The tags are ordered the same way as in request.groupByTags collection. */
     tagValues: string[];
-    points: Array<QueryMetricResultPoint>;
+    points: Array<QueryMetricsResultPoint>;
+}
+export interface QueryMetricsResponseCommon {
+    /**
+     * Result of the metrics query.
+     * Contains only 1 element if `groupByTags` are empty, otherwise contains multiple results grouped by tags.
+     */
+    resultGroups: Array<QueryMetricsResultGroup>;
+}
+export interface QueryUserMetricsResponse<NameType extends string = string> extends QueryMetricsResponseCommon {
+    domain: 'user';
+    metricName: NameType;
+}
+/**
+ * A single metric response for 'SquidMetricsRequest'.
+ */
+export interface QuerySquidMetricsResponse<NameType extends SquidMetricName> extends QueryMetricsResponseCommon {
+    domain: 'squid';
+    metricName: NameType;
 }
+export type QueryMetricsResponse<NameType extends string = string> = Required<QuerySquidMetricsResponse<NameType extends SquidMetricName ? NameType : SquidMetricName> | QueryUserMetricsResponse<NameType>>;

package/dist/internal-common/src/utils/metric-utils.d.ts

@@ -1,4 +1,4 @@
-import { QueryMetricRequestCommon, QueryMetricResultGroup } from '../public-types/metric.public-types';
-export type QueryMetricRequestIntervals = Required<Pick<QueryMetricRequestCommon, 'fillValue' | 'groupByTags' | 'periodEndSeconds' | 'periodStartSeconds' | 'pointIntervalAlignment' | 'pointIntervalSeconds' | 'tagDomains' | 'noDataBehavior'>>;
+import { QueryMetricsRequestCommon, QueryMetricsResultGroup } from '../public-types/metric.public-types';
+export type QueryMetricsRequestIntervals = Required<Pick<QueryMetricsRequestCommon, 'fillValue' | 'fn' | 'groupByTags' | 'periodEndSeconds' | 'periodStartSeconds' | 'pointIntervalAlignment' | 'pointIntervalSeconds' | 'tagDomains' | 'noDataBehavior'>>;
 /** Adds missed known tag domain groups and fills all missed points with a request.fillValue. */
-export declare function fillMissedPoints(request: QueryMetricRequestIntervals, resultGroups: Array<QueryMetricResultGroup>): void;
+export declare function fillMissedPoints(request: QueryMetricsRequestIntervals, resultGroups: Array<QueryMetricsResultGroup>): void;

package/dist/typescript-client/src/{ai-chatbot-client.d.ts → ai-agent-client.d.ts}

@@ -1,6 +1,25 @@
-import { AiChatbotChatOptions, AiChatbotContext, AiChatModelName, AiSearchOptions, AiSearchResponse } from './public-types';
+import { AiChatbotChatOptions, AiChatbotContext, AiChatModelName, AiSearchOptions, AiSearchResponse, AiTranscribeAndAskResponse, AiTranscribeAndChatResponse } from './public-types';
 import { Observable } from 'rxjs';
-export declare class AiChatbotClient {
+export interface TranscribeAndChatResponse {
+    transcribedPrompt: string;
+    responseStream: Observable<string>;
+}
+export interface TranscribeAndAskWithVoiceResponse {
+    transcribedPrompt: string;
+    responseString: string;
+    voiceResponseFile: File;
+}
+export interface AskWithVoiceResponse {
+    responseString: string;
+    voiceResponseFile: File;
+}
+export interface ChatInternalResponse {
+    responseStream: Observable<string>;
+    serverResponse?: Promise<AiTranscribeAndChatResponse>;
+}
+export type ChatOptionsWithoutVoice = Omit<AiChatbotChatOptions, 'voiceOptions'>;
+export type AskOptionsWithoutVoice = Omit<AiChatbotChatOptions, 'voiceOptions' | 'smoothTyping'>;
+export declare class AiAgentClient {
     private readonly rpcManager;
     private readonly socketManager;
     private readonly integrationId;
@@ -13,7 +32,7 @@ export declare class AiChatbotClient {
      * @param id - The id of the profile.
      * @returns The profile reference.
      */
-    profile(id: string): AiChatbotProfileReference;
+    profile(id: string): AiAgentReference;
     /**
      * Sends a prompt to the specified profile id.
      *
@@ -23,8 +42,10 @@ export declare class AiChatbotClient {
      * @returns An observable that emits when a new response token is received. The emitted value is the entire response
      * that has been received so far.
      */
-    chat(profileId: string, prompt: string, options?: AiChatbotChatOptions): Observable<string>;
-    search(profileId: string, options: AiSearchOptions): Promise<AiSearchResponse>;
+    chat(profileId: string, prompt: string, options?: ChatOptionsWithoutVoice): Observable<string>;
+    transcribeAndChat(profileId: string, fileToTranscribe: File, options?: ChatOptionsWithoutVoice): Promise<TranscribeAndChatResponse>;
+    private chatInternal;
+    search(agentId: string, options: AiSearchOptions): Promise<AiSearchResponse>;
     /**
      * Sends a prompt to the specified profile id and returns the response as a Promise of string.
      *
@@ -33,7 +54,11 @@ export declare class AiChatbotClient {
      * @param options - The options to send to the chat model.
      * @returns A promise that resolves when the chat is complete. The resolved value is the entire response.
      */
-    ask(profileId: string, prompt: string, options?: Omit<AiChatbotChatOptions, 'smoothTyping'>): Promise<string>;
+    ask(profileId: string, prompt: string, options?: AskOptionsWithoutVoice): Promise<string>;
+    transcribeAndAsk(profileId: string, fileToTranscribe: File, options?: AskOptionsWithoutVoice): Promise<AiTranscribeAndAskResponse>;
+    transcribeAndAskWithVoiceResponse(profileId: string, fileToTranscribe: File, options?: Omit<AiChatbotChatOptions, 'smoothTyping'>): Promise<TranscribeAndAskWithVoiceResponse>;
+    askWithVoiceResponse(profileId: string, prompt: string, options?: Omit<AiChatbotChatOptions, 'smoothTyping'>): Promise<AskWithVoiceResponse>;
+    askInternal<T>(profileId: string, prompt: string | File, isVoiceResponse: boolean, options?: Omit<AiChatbotChatOptions, 'smoothTyping'>): Promise<T>;
     private handleChatResponse;
 }
 export interface AiChatBotContextData {
@@ -48,7 +73,7 @@ export interface ProfileData {
 export interface InstructionData {
     instruction: string;
 }
-export declare class AiChatbotProfileReference {
+export declare class AiAgentReference {
     private readonly client;
     private readonly integrationId;
     private readonly profileId;
@@ -61,12 +86,16 @@ export declare class AiChatbotProfileReference {
      * that has been received so far.
      */
     chat(prompt: string, options?: AiChatbotChatOptions): Observable<string>;
+    transcribeAndChat(fileToTranscribe: File, options?: AiChatbotChatOptions): Promise<TranscribeAndChatResponse>;
     /**
      * Sends a prompt to the current profile and returns the response as a Promise of string.
      * @param prompt - The prompt.
      * @param options - The chat options.
      */
     ask(prompt: string, options?: Omit<AiChatbotChatOptions, 'smoothTyping'>): Promise<string>;
+    transcribeAndAsk(fileToTranscribe: File, options?: AskOptionsWithoutVoice): Promise<AiTranscribeAndAskResponse>;
+    transcribeAndAskWithVoiceResponse(fileToTranscribe: File, options?: Omit<AiChatbotChatOptions, 'smoothTyping'>): Promise<TranscribeAndAskWithVoiceResponse>;
+    askWithVoiceResponse(prompt: string, options?: Omit<AiChatbotChatOptions, 'smoothTyping'>): Promise<AskWithVoiceResponse>;
     search(options: AiSearchOptions): Promise<AiSearchResponse>;
     /**
      * Retrieves a context reference for the current profile. A context reference can be used to add a new context entry
@@ -76,7 +105,7 @@ export declare class AiChatbotProfileReference {
      * generated and the reference will point to a new context entry.
      * @returns The context reference.
      */
-    context(id?: string): AiChatbotContextReference;
+    context(id?: string): AiAgentContextReference;
     /**
      * Retrieves an instruction reference for the current profile. An instruction reference can be used to add a new
      * instruction entry to the profile, or update/delete an existing instruction entry.
@@ -85,7 +114,7 @@ export declare class AiChatbotProfileReference {
      * generated and the reference will point to a new instruction entry.
      * @returns The instruction reference.
      */
-    instruction(id?: string): AiChatbotInstructionReference;
+    instruction(id?: string): AiAgentInstructionReference;
     /**
      * Adds a new profile to the chatbot. This will result in an error if a profile already exists with the same id.
      *
@@ -117,7 +146,7 @@ export declare class AiChatbotProfileReference {
      */
     delete(): Promise<void>;
 }
-export declare class AiChatbotContextReference {
+export declare class AiAgentContextReference {
     private readonly client;
     private readonly integrationId;
     private readonly profileId;
@@ -157,7 +186,7 @@ export declare class AiChatbotContextReference {
      */
     delete(): Promise<void>;
 }
-export declare class AiChatbotInstructionReference {
+export declare class AiAgentInstructionReference {
     private readonly client;
     private readonly integrationId;
     private readonly profileId;
@@ -188,3 +217,11 @@ export declare class AiChatbotInstructionReference {
      */
     delete(): Promise<void>;
 }
+export declare class AiChatbotProfileReference extends AiAgentReference {
+}
+export declare class AiChatbotClient extends AiAgentClient {
+}
+export declare class AiChatbotContextReference extends AiAgentContextReference {
+}
+export declare class AiChatbotInstructionReference extends AiAgentInstructionReference {
+}

package/dist/typescript-client/src/ai-audio-client.d.ts

@@ -1,6 +1,7 @@
-import { AiAudioTranscribeOptions } from './public-types';
+import { AiAudioCreateSpeechOptions, AiAudioTranscribeOptions } from './public-types';
 import { BlobAndFilename } from './types';
 export declare class AiAudioClient {
     private readonly rpcManager;
     transcribe(file: File | BlobAndFilename, options?: AiAudioTranscribeOptions): Promise<string>;
+    createSpeech(input: string, options: AiAudioCreateSpeechOptions): Promise<File>;
 }

package/dist/typescript-client/src/ai.types.d.ts

@@ -1,4 +1,4 @@
-import { AiChatbotClient } from './ai-chatbot-client';
+import { AiAgentReference, AiChatbotClient } from './ai-agent-client';
 import { AiAssistantClient } from './ai-assistant-client';
 import { IntegrationId } from './public-types';
 import { AiImageClient } from './ai-image-client';
@@ -43,6 +43,7 @@ export declare class AiClient {
      * @returns An instance of AiChatbotClient associated with the given AI integration ID.
      */
     chatbot(aiIntegrationId: IntegrationId): AiChatbotClient;
+    agent(agentId: string): AiAgentReference;
     /**
      * Retrieves the AI assistant client.
      * @returns An instance of AiAssistantClient.

package/dist/typescript-client/src/file-utils.d.ts

@@ -0,0 +1 @@
+export declare function base64ToFile(base64: string, filename: string, mimeType?: string): File;

package/dist/typescript-client/src/index.d.ts

@@ -1,6 +1,6 @@
 export * from './ai-assistant-client';
 export * from './ai-chatbot-client.factory';
-export * from './ai-chatbot-client';
+export * from './ai-agent-client';
 export * from './ai-image-client';
 export * from './ai-audio-client';
 export * from './ai.types';
@@ -43,3 +43,4 @@ export * from './types';
 export * from './storage-client';
 export * from './personal-storage-client';
 export * from './extraction-client';
+export * from './file-utils';

package/dist/typescript-client/src/version.d.ts

@@ -1 +1 @@
-export declare const SQUIDCLOUD_CLIENT_PACKAGE_VERSION = "1.0.277";
+export declare const SQUIDCLOUD_CLIENT_PACKAGE_VERSION = "1.0.279";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@squidcloud/client",
-  "version": "1.0.277",
+  "version": "1.0.279",
   "description": "A typescript implementation of the Squid client",
   "main": "dist/cjs/index.js",
   "types": "dist/typescript-client/src/index.d.ts",