@squidcloud/client 1.0.348 → 1.0.350

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

@@ -1,6 +1,6 @@
 import { AiAgentId, AiContextId, IntegrationId } from './communication.public-types';
 import { IntegrationType } from './integration.public-types';
-import { FunctionName, FunctionNameWithContext } from './backend.public-types';
+import { AiFunctionId, AiFunctionIdWithContext } from './backend.public-types';
 /**
  * The supported OpenAI models.
  * @category AI
@@ -30,11 +30,15 @@ export declare const AI_CHAT_MODEL_NAMES: readonly ["gpt-4o", "gpt-4o-mini", "o1
 /**
  * @category AI
  */
-export declare const OPENAI_EMBEDDINGS_MODEL_NAMES: readonly ["text-embedding-3-small", "text-embedding-3-large", "text-embedding-ada-002"];
+export declare const OPENAI_EMBEDDINGS_MODEL_NAMES: readonly ["text-embedding-3-small"];
 /**
  * @category AI
  */
-export declare const AI_EMBEDDINGS_MODEL_NAMES: readonly ["text-embedding-3-small", "text-embedding-3-large", "text-embedding-ada-002"];
+export declare const VOYAGE_EMBEDDING_MODEL_NAMES: readonly ["voyage-3-large"];
+/**
+ * @category AI
+ */
+export declare const AI_EMBEDDINGS_MODEL_NAMES: readonly ["text-embedding-3-small", "voyage-3-large"];
 /**
  * The supported AI image generation model names.
  * @category AI
@@ -43,15 +47,15 @@ export declare const OPENAI_IMAGE_MODEL_NAMES: readonly ["dall-e-3"];
 /**
  * @category AI
  */
-export declare const OPENAI_AUDIO_TRANSCRIPTION_MODEL_NAMES: readonly ["whisper-1"];
+export declare const OPENAI_AUDIO_TRANSCRIPTION_MODEL_NAMES: readonly ["whisper-1", "gpt-4o-transcribe", "gpt-4o-mini-transcribe"];
 /**
  * @category AI
  */
-export declare const OPENAI_AUDIO_CREATE_SPEECH_MODEL_NAMES: readonly ["tts-1", "tts-1-hd"];
+export declare const OPENAI_AUDIO_CREATE_SPEECH_MODEL_NAMES: readonly ["tts-1", "tts-1-hd", "gpt-4o-mini-tts"];
 /**
  * @category AI
  */
-export declare const OPENAI_AUDIO_MODEL_NAMES: readonly ["whisper-1", "tts-1", "tts-1-hd"];
+export declare const OPENAI_AUDIO_MODEL_NAMES: readonly ["whisper-1", "gpt-4o-transcribe", "gpt-4o-mini-transcribe", "tts-1", "tts-1-hd", "gpt-4o-mini-tts"];
 /**
  * @category AI
  */
@@ -67,11 +71,11 @@ export declare const AI_IMAGE_MODEL_NAMES: readonly ["dall-e-3", "stable-diffusi
 /**
  * @category AI
  */
-export declare const AI_AUDIO_TRANSCRIPTION_MODEL_NAMES: readonly ["whisper-1"];
+export declare const AI_AUDIO_TRANSCRIPTION_MODEL_NAMES: readonly ["whisper-1", "gpt-4o-transcribe", "gpt-4o-mini-transcribe"];
 /**
  * @category AI
  */
-export declare const AI_AUDIO_CREATE_SPEECH_MODEL_NAMES: readonly ["tts-1", "tts-1-hd"];
+export declare const AI_AUDIO_CREATE_SPEECH_MODEL_NAMES: readonly ["tts-1", "tts-1-hd", "gpt-4o-mini-tts"];
 /**
  * @category AI
  */
@@ -84,6 +88,10 @@ export type AiChatModelName = (typeof AI_CHAT_MODEL_NAMES)[number];
  * @category AI
  */
 export type AiEmbeddingsModelName = (typeof AI_EMBEDDINGS_MODEL_NAMES)[number];
+/**
+ * @category AI
+ */
+export type AiVoyageEmbeddingsModelName = (typeof VOYAGE_EMBEDDING_MODEL_NAMES)[number];
 /**
  * @category AI
  */
@@ -147,7 +155,11 @@ export type AiGenerateImageOptions = DallEOptions | StableDiffusionCoreOptions |
 /**
  * @category AI
  */
-export type AiAudioTranscribeOptions = WhisperOptions;
+export type OpenAiAudioTranscribeOptions = WhisperTranscribeOptions | Gpt4oTranscribeOptions;
+/**
+ * @category AI
+ */
+export type AiAudioTranscribeOptions = OpenAiAudioTranscribeOptions;
 /**
  * @category AI
  */
@@ -190,19 +202,33 @@ export interface DallEOptions extends BaseAiGenerateImageOptions {
     /** The number of images to generate; defaults to 1 and limited to 1. */
     numberOfImagesToGenerate?: 1;
 }
+interface BaseOpenAiAudioTranscribeOptions extends BaseAiAudioTranscribeOptions {
+    /** Specifies the  model for audio transcription. */
+    modelName: OpenAiAudioTranscriptionModelName;
+    /** The temperature for sampling during transcription; defaults to model-specific value. */
+    temperature?: number;
+    /** An optional prompt to guide the transcription process. */
+    prompt?: string;
+}
 /**
  * Options for transcribing audio using the Whisper model.
  * @category AI
  */
-export interface WhisperOptions extends BaseAiAudioTranscribeOptions {
+export interface WhisperTranscribeOptions extends BaseOpenAiAudioTranscribeOptions {
     /** Specifies the Whisper-1 model for audio transcription. */
     modelName: 'whisper-1';
     /** The format of the transcription response; defaults to 'json'. */
     responseFormat?: 'json' | 'text' | 'srt' | 'verbose_json' | 'vtt';
-    /** The temperature for sampling during transcription; defaults to model-specific value. */
-    temperature?: number;
-    /** An optional prompt to guide the transcription process. */
-    prompt?: string;
+}
+/**
+ * Options for transcribing audio using the GPT-4o model.
+ * @category AI
+ */
+export interface Gpt4oTranscribeOptions extends BaseOpenAiAudioTranscribeOptions {
+    /** Specifies the Whisper-1 model for audio transcription. */
+    modelName: 'gpt-4o-transcribe' | 'gpt-4o-mini-transcribe';
+    /** The format of the transcription response; defaults to 'json'. */
+    responseFormat?: 'json';
 }
 /**
  * Options for creating speech using OpenAI's text-to-speech models.
@@ -212,9 +238,11 @@ export interface OpenAiCreateSpeechOptions extends BaseAiAudioCreateSpeechOption
     /** The OpenAI model to use for speech creation (e.g., 'tts-1' or 'tts-1-hd'). */
     modelName: OpenAiAudioCreateSpeechModelName;
     /** The voice to use for speech synthesis; defaults to model-specific value. */
-    voice?: 'alloy' | 'echo' | 'fable' | 'onyx' | 'nova' | 'shimmer';
+    voice?: 'alloy' | 'ash' | 'ballad' | 'coral' | 'echo' | 'fable' | 'onyx' | 'nova' | 'sage' | 'shimmer' | 'verse';
     /** The format of the audio output; defaults to 'mp3'. */
     responseFormat?: OpenAiCreateSpeechFormat;
+    /** An optional prompt to guide the speech synthesis process. */
+    instructions?: string;
     /** The speed of the speech; defaults to 1.0. */
     speed?: number;
 }
@@ -346,7 +374,7 @@ export interface BaseAiAgentChatOptions {
      * The parameter values must be valid serializable JSON values.
      * Overrides the stored value.
      */
-    functions?: Array<FunctionName | FunctionNameWithContext>;
+    functions?: Array<AiFunctionId | AiFunctionIdWithContext>;
     /** Instructions to include with the prompt. */
     instructions?: string;
     /** A set of filters that will limit the context the AI can access. */
@@ -455,12 +483,15 @@ export interface AiAgent<T extends AiChatModelName | undefined = undefined> {
     auditLog?: boolean;
     /** The default chat options for the agent, overridable by the user during use. */
     options: AiAgentChatOptions<T>;
+    /** The embedding model name used by the agent. */
+    embeddingModelName: AiEmbeddingsModelName;
 }
 /**
  * @category AI
  */
-export type UpsertAgentRequest = Omit<AiAgent, 'createdAt' | 'updatedAt' | 'options'> & {
+export type UpsertAgentRequest = Omit<AiAgent, 'createdAt' | 'updatedAt' | 'options' | 'embeddingModelName'> & {
     options?: AiAgentChatOptions;
+    embeddingModelName?: AiEmbeddingsModelName;
 };
 /**
  * Options for observing the status of an AI agent operation.

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

@@ -1,4 +1,6 @@
 /** Backend related public types that should be available on the client SDK */
+/** A type alias for a string that represents an AI function ID. */
+export type AiFunctionId = string;
 /**
  * A type alias for a service identifier.
  * @category Queue
@@ -11,9 +13,9 @@ export type FunctionName = string;
 /**
  * Function name with contextual data, where the data must be serializable as JSON.
  */
-export interface FunctionNameWithContext {
-    /** The name of the function within a service. */
-    name: FunctionName;
+export interface AiFunctionIdWithContext {
+    /** The ID of the AI function as described in @aiFunction decorator. */
+    name: AiFunctionId;
     /** A record of contextual data associated with the function call. */
     context: Record<string, unknown>;
 }

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

@@ -1,3 +1,4 @@
+import { AppId } from './communication.public-types';
 /**
  * Request to search the web.
  */
@@ -37,3 +38,34 @@ export interface WebGetUrlContentResponse {
     /** The content fetched from the URL in Markdown format. */
     markdownText: string;
 }
+/**
+ * Request to create a shortened URL.
+ */
+export interface WebShortUrlRequest {
+    /** The URL to shorten. It must be a valid URL and should include the protocol (start with http:// or https://). */
+    url: string;
+    /** The application ID that will own this shortened URL. */
+    appId: AppId;
+    /** Seconds to live for the shortened URL. If set to 0, the URL will never expire. */
+    secondsToLive?: number;
+}
+/**
+ * Response with the newly created shortened URL.
+ */
+export interface WebShortUrlResponse {
+    /** The ID of the shortened URL. */
+    id: string;
+    /** The full valid shortened URL. */
+    shortUrl: string;
+    /** The time when the shortened URL will expire. */
+    expiry: Date | null;
+}
+/**
+ * Request to delete a shortened URL.
+ */
+export interface WebShortUrlDeleteRequest {
+    /** The ID of the shortened URL to delete. */
+    id: string;
+    /** The application ID that owns the shortened URL. */
+    appId: AppId;
+}

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

@@ -2,4 +2,4 @@
  * The current version of the SquidCloud client package.
  * @category Platform
  */
-export declare const SQUIDCLOUD_CLIENT_PACKAGE_VERSION = "1.0.348";
+export declare const SQUIDCLOUD_CLIENT_PACKAGE_VERSION = "1.0.350";

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

@@ -1,10 +1,13 @@
-import { WebAiSearchResponse } from '../../internal-common/src/public-types/web.public-types';
+import { WebAiSearchResponse, WebShortUrlResponse } from '../../internal-common/src/public-types/web.public-types';
 /**
  * WebClient provides methods to interact with web-related functionalities.
  * @category Platform
  */
 export declare class WebClient {
     private readonly rpcManager;
+    private readonly region;
+    private readonly appId;
+    private readonly apiKey;
     /**
      * Search the web using AI. Returns a response containing Markdown text and cited URLs.
      * @param query The keywords or query string to search for.
@@ -15,4 +18,24 @@ export declare class WebClient {
      * @param url The URL to fetch content from.
      */
     getUrlContent(url: string): Promise<string>;
+    /**
+     * Creates a shortened URL for the given URL.
+     *
+     * Defaults to a 30 day expiration if no expiry is provided via the `secondsToLive` field.
+     * If `secondsToLive` is set to 0, the URL will never expire.
+     *
+     * @param url The URL to shorten. It must be a valid URL and should include the protocol (start with http:// or
+     *   https://).
+     * @param secondsToLive Seconds to live for the shortened URL. If set to 0, the URL will never expire. Defaults to 30
+     *   days.
+     */
+    createShortUrl(url: string, secondsToLive?: number): Promise<WebShortUrlResponse>;
+    /**
+     * Deletes a shortened URL by its ID.
+     *
+     * The ID is the unique identifier at the end of the shortened URL.
+     *
+     * @param id The ID of the shortened URL to delete.
+     */
+    deleteShortUrl(id: string): Promise<void>;
 }

package/package.json

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