@squidcloud/client 1.0.277 → 1.0.278

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/typescript-client/src/{ai-chatbot-client.d.ts → ai-agent-client.d.ts}

@@ -1,6 +1,21 @@
-import { AiChatbotChatOptions, AiChatbotContext, AiChatModelName, AiSearchOptions, AiSearchResponse } from './public-types';
+import { AiChatbotChatOptions, AiChatbotContext, AiChatModelName, AiSearchOptions, AiSearchResponse, AiTranscribeAndAskResponse } from './public-types';
 import { Observable } from 'rxjs';
-export declare class AiChatbotClient {
+interface TranscribeAndChatResponse {
+    transcribedPrompt: string;
+    responseStream: Observable<string>;
+}
+interface TranscribeAndAskWithVoiceResponse {
+    transcribedPrompt: string;
+    responseString: string;
+    voiceResponseFile: File;
+}
+interface AskWithVoiceResponse {
+    responseString: string;
+    voiceResponseFile: File;
+}
+type ChatOptionsWithoutVoice = Omit<AiChatbotChatOptions, 'voiceOptions'>;
+type AskOptionsWithoutVoice = Omit<AiChatbotChatOptions, 'voiceOptions' | 'smoothTyping'>;
+export declare class AiAgentClient {
     private readonly rpcManager;
     private readonly socketManager;
     private readonly integrationId;
@@ -13,7 +28,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 +38,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 +50,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 +69,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 +82,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 +101,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 +110,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 +142,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 +182,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 +213,12 @@ 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 {
+}
+export {};

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.278";

package/package.json

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