@squidcloud/client 1.0.363 → 1.0.364

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

@@ -128,6 +128,10 @@ export type OpenAiReasoningChatModelName = (typeof OPENAI_REASONING_CHAT_MODEL_N
  * @category AI
  */
 export type GeminiChatModelName = (typeof GEMINI_CHAT_MODEL_NAMES)[number];
+/**
+ * @category AI
+ */
+export type SquidAiModelName = (typeof SQUID_AI_MODEL_NAMES)[number];
 /**
  * @category AI
  */
@@ -392,7 +396,7 @@ export interface AiChatPromptQuotas {
  * The base AI agent chat options, should not be used directly.
  * @category AI
  */
-export interface BaseAiAgentChatOptions {
+export interface BaseAiChatOptions {
     /** The maximum number of tokens to use when making the request to the AI model. Defaults to the max tokens the model can accept. */
     maxTokens?: number;
     /** A unique chat ID, if the same chat ID is used again and history is not disabled, it will continue the conversation. */
@@ -447,7 +451,7 @@ export interface BaseAiAgentChatOptions {
  * Chat options specific to Gemini models, extending base options.
  * @category AI
  */
-export interface GeminiChatOptions extends BaseAiAgentChatOptions {
+export interface GeminiChatOptions extends BaseAiChatOptions {
     /** The Gemini model to use for the chat. */
     model?: GeminiChatModelName;
     /** Enables grounding with web search for more informed responses; defaults to false. */
@@ -457,7 +461,7 @@ export interface GeminiChatOptions extends BaseAiAgentChatOptions {
  * Chat options specific to OpenAI models, extending base options.
  * @category AI
  */
-export interface OpenAiChatOptions extends BaseAiAgentChatOptions {
+export interface OpenAiChatOptions extends BaseAiChatOptions {
     /** The OpenAI model to use for the chat. */
     model?: OpenAiChatModelName;
     /** An array of file URLs to include in the chat context. */
@@ -481,7 +485,7 @@ export interface OpenAiReasoningChatOptions extends OpenAiChatOptions {
  * Chat options specific to Anthropic models, extending base options.
  * @category AI
  */
-export interface AnthropicChatOptions extends BaseAiAgentChatOptions {
+export interface AnthropicChatOptions extends BaseAiChatOptions {
     /** The Anthropic model to use for the chat. */
     model?: AnthropicChatModelName;
     /** The level of reasoning effort to apply. Defaults to no reasoning. */
@@ -506,12 +510,12 @@ export type AiSessionOptions = Partial<{
  * the type is inferred from the provided overrideModel (or falls back to BaseAiAgentChatOptions).
  * @category AI
  */
-export type AiAgentChatOptions<T extends AiChatModelName | undefined = undefined> = T extends undefined ? BaseAiAgentChatOptions | GeminiChatOptions | OpenAiReasoningChatOptions | OpenAiChatOptions | AnthropicChatOptions : T extends GeminiChatModelName ? GeminiChatOptions : T extends OpenAiReasoningChatModelName ? OpenAiReasoningChatOptions : T extends OpenAiChatModelName ? OpenAiChatOptions : T extends AnthropicChatModelName ? AnthropicChatOptions : never;
+export type AiChatOptions<T extends AiChatModelName | undefined = undefined> = T extends undefined ? BaseAiChatOptions | GeminiChatOptions | OpenAiReasoningChatOptions | OpenAiChatOptions | AnthropicChatOptions : T extends GeminiChatModelName ? GeminiChatOptions : T extends OpenAiReasoningChatModelName ? OpenAiReasoningChatOptions : T extends OpenAiChatModelName ? OpenAiChatOptions : T extends AnthropicChatModelName ? AnthropicChatOptions : T extends SquidAiModelName ? BaseAiChatOptions : never;
 /**
  * @category AI
  */
 export type AllAiAgentChatOptions = {
-    [K in keyof BaseAiAgentChatOptions | keyof GeminiChatOptions | keyof OpenAiReasoningChatOptions | keyof OpenAiChatOptions | keyof AnthropicChatOptions]?: (K extends keyof BaseAiAgentChatOptions ? BaseAiAgentChatOptions[K] : never) | (K extends keyof GeminiChatOptions ? GeminiChatOptions[K] : never) | (K extends keyof OpenAiReasoningChatOptions ? OpenAiReasoningChatOptions[K] : never) | (K extends keyof OpenAiChatOptions ? OpenAiChatOptions[K] : never) | (K extends keyof AnthropicChatOptions ? AnthropicChatOptions[K] : never);
+    [K in keyof BaseAiChatOptions | keyof GeminiChatOptions | keyof OpenAiReasoningChatOptions | keyof OpenAiChatOptions | keyof AnthropicChatOptions]?: (K extends keyof BaseAiChatOptions ? BaseAiChatOptions[K] : never) | (K extends keyof GeminiChatOptions ? GeminiChatOptions[K] : never) | (K extends keyof OpenAiReasoningChatOptions ? OpenAiReasoningChatOptions[K] : never) | (K extends keyof OpenAiChatOptions ? OpenAiChatOptions[K] : never) | (K extends keyof AnthropicChatOptions ? AnthropicChatOptions[K] : never);
 };
 /**
  * A definition of an AI agent with its properties and default chat options.
@@ -531,7 +535,7 @@ export interface AiAgent<T extends AiChatModelName | undefined = undefined> {
     /** Enables audit logging for the agent's activities if true; defaults to false. */
     auditLog?: boolean;
     /** The default chat options for the agent, overridable by the user during use. */
-    options: AiAgentChatOptions<T>;
+    options: AiChatOptions<T>;
     /** The embedding model name used by the agent. */
     embeddingModelName: AiEmbeddingsModelName;
 }
@@ -539,7 +543,7 @@ export interface AiAgent<T extends AiChatModelName | undefined = undefined> {
  * @category AI
  */
 export type UpsertAgentRequest = Omit<AiAgent, 'createdAt' | 'updatedAt' | 'options' | 'embeddingModelName'> & {
-    options?: AiAgentChatOptions;
+    options?: AiChatOptions;
     embeddingModelName?: AiEmbeddingsModelName;
 };
 /**

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

@@ -92,3 +92,80 @@ export interface ExtractDataFromDocumentResponse {
      */
     pages: Array<ExtractDataFromDocumentPage>;
 }
+/**
+ * Create PDF request type.
+ */
+export type CreatePdfType = 'html' | 'url';
+/** The type of output options to apply when creating a PDF document. */
+export type CreatePdfOutputOptionsType = 'format' | 'dimensions';
+/** Base interface for PDF output options. This is used to define the type of output options. */
+export interface BaseCreatePdfOutputOptions {
+    /** The type of output options, either 'format' or 'dimensions'. */
+    type: CreatePdfOutputOptionsType;
+}
+/** Output options by format */
+export interface CreatePdfOutputFormatOptions extends BaseCreatePdfOutputOptions {
+    /** The type of output options, always 'format' for this interface. */
+    type: 'format';
+    /** The type of formatting, always 'format' for this interface. */
+    format: 'letter' | 'legal' | 'tabloid' | 'ledger' | 'a0' | 'a1' | 'a2' | 'a3' | 'a4' | 'a5' | 'a6';
+}
+/** Output options by custom dimensions */
+export interface CreatePdfOutputDimensionsOptions extends BaseCreatePdfOutputOptions {
+    /** The type of formatting, always 'dimensions' for this interface. */
+    type: 'dimensions';
+    /** The width of the PDF document in pixels. */
+    width: number;
+    /** The height of the PDF document in pixels. */
+    height: number;
+}
+/** Combined formatting options for creating a PDF document. */
+export type CreatePdfOutputOptions = CreatePdfOutputFormatOptions | CreatePdfOutputDimensionsOptions;
+/**
+ * Base request for creating a PDF document.
+ */
+export interface BaseCreatePdfRequest {
+    /**
+     * The type of PDF creation to perform, either from HTML or a URL.
+     */
+    type: CreatePdfType;
+    /** The formatting options for the PDF document. Can be either a predefined format (like 'letter') or custom dimensions. */
+    outputOptions?: CreatePdfOutputOptions;
+    /** Optional title for the PDF document. */
+    title?: string;
+}
+/**
+ * Request payload for creating a PDF from a URL.
+ */
+export interface CreatePdfFromUrlRequest extends BaseCreatePdfRequest {
+    /** The type of PDF creation, always 'url' for this request. */
+    type: 'url';
+    /**
+     * The URL of the webpage to convert into a PDF.
+     */
+    url: string;
+}
+/**
+ * Request payload for creating a PDF from HTML content.
+ */
+export interface CreatePdfFromHtmlRequest extends BaseCreatePdfRequest {
+    /** The type of PDF creation, always 'html' for this request. */
+    type: 'html';
+    /** The HTML content to convert into a PDF. Should not contain <html>, <body>, <head>, should just include the inner HTML */
+    innerHtml: string;
+    /** Optional URL for CSS styles to apply to the HTML content. */
+    cssUrl?: string;
+}
+/**
+ * Combined request type for creating a PDF, which can be either from a URL or HTML content.
+ */
+export type CreatePdfRequest = CreatePdfFromUrlRequest | CreatePdfFromHtmlRequest;
+/**
+ * Response type for the PDF creation operation, containing the URL of the generated PDF.
+ */
+export interface CreatePdfResponse {
+    /**
+     * The publicly accessible URL where the generated PDF can be downloaded.
+     */
+    url: string;
+}

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

@@ -1,4 +1,4 @@
-import { AgentContextRequest, AiAgent, AiAgentChatOptions, AiAgentContext, AiAudioCreateSpeechOptions, AiChatModelName, AiContextMetadata, AiContextMetadataFilter, AiEmbeddingsModelName, AiGenerateImageOptions, AiSearchOptions, AiSearchResultChunk, AllAiAgentChatOptions } from '../public-types/ai-agent.public-types';
+import { AgentContextRequest, AiAgent, AiChatOptions, AiAgentContext, AiAudioCreateSpeechOptions, AiChatModelName, AiContextMetadata, AiContextMetadataFilter, AiEmbeddingsModelName, AiGenerateImageOptions, AiSearchOptions, AiSearchResultChunk, AllAiAgentChatOptions } from '../public-types/ai-agent.public-types';
 import { AiAgentId, AppId, ClientRequestId } from '../public-types/communication.public-types';
 import { AiFunctionId } from '../public-types/backend.public-types';
 type ModelDataType = {
@@ -24,7 +24,7 @@ export interface AiGenerateImageRequest {
 export interface AiAskQuestionInternalRequest {
     appId: AppId;
     prompt: string;
-    options: AiAgentChatOptions;
+    options: AiChatOptions;
 }
 export interface AiAskQuestionInternalResponse {
     answer: string;

package/dist/typescript-client/src/agent/ai-agent-client-reference.d.ts

@@ -1,6 +1,6 @@
-import { AgentContextRequest, AiAgent, AiAgentChatOptions, AiAgentContext, AiChatModelName, AiConnectedAgentMetadata, AiObserveStatusOptions, AiSearchOptions, AiSearchResultChunk, AiStatusMessage, AiTranscribeAndAskResponse, GuardrailsOptions, UpsertAgentRequest } from '../../../internal-common/src/public-types/ai-agent.public-types';
+import { AgentContextRequest, AiAgent, AiAgentContext, AiChatModelName, AiConnectedAgentMetadata, AiObserveStatusOptions, AiSearchOptions, AiSearchResultChunk, AiStatusMessage, AiTranscribeAndAskResponse, GuardrailsOptions, UpsertAgentRequest } from '../../../internal-common/src/public-types/ai-agent.public-types';
 import { Observable } from 'rxjs';
-import { AskOptionsWithoutVoice, AskWithVoiceResponse, ChatOptionsWithoutVoice, TranscribeAndAskWithVoiceResponse, TranscribeAndChatResponse } from './ai-agent-client.types';
+import { AiAskOptions, AiAskOptionsWithVoice, AiChatOptionsWithoutVoice, AskWithVoiceResponse, TranscribeAndAskWithVoiceResponse, TranscribeAndChatResponse } from './ai-agent-client.types';
 /**
  * Parameters for creating or updating an AI agent.
  * Excludes the `id` field, as it is derived from the agent instance.
@@ -90,11 +90,11 @@ export declare class AiAgentReference {
     /**
      * Sends a prompt to the agent and receives streamed text responses.
      */
-    chat(prompt: string, options?: ChatOptionsWithoutVoice): Observable<string>;
+    chat<T extends AiChatModelName | undefined>(prompt: string, options?: AiChatOptionsWithoutVoice<T>): Observable<string>;
     /**
      * Transcribes the given file and performs a chat interaction.
      */
-    transcribeAndChat(fileToTranscribe: File, options?: ChatOptionsWithoutVoice): Promise<TranscribeAndChatResponse>;
+    transcribeAndChat(fileToTranscribe: File, options?: AiChatOptionsWithoutVoice): Promise<TranscribeAndChatResponse>;
     /**
      * Performs a semantic search using the agent's knowledge base.
      */
@@ -102,7 +102,7 @@ export declare class AiAgentReference {
     /**
      * Sends a prompt and receives a full string response.
      */
-    ask(prompt: string, options?: AskOptionsWithoutVoice): Promise<string>;
+    ask<T extends AiChatModelName | undefined = undefined>(prompt: string, options?: AiAskOptions<T>): Promise<string>;
     /**
      * Observes live status messages from the agent.
      */
@@ -110,15 +110,15 @@ export declare class AiAgentReference {
     /**
      * Transcribes audio and sends it to the agent for response.
      */
-    transcribeAndAsk(fileToTranscribe: File, options?: AskOptionsWithoutVoice): Promise<AiTranscribeAndAskResponse>;
+    transcribeAndAsk<T extends AiChatModelName | undefined>(fileToTranscribe: File, options?: AiAskOptions<T>): Promise<AiTranscribeAndAskResponse>;
     /**
      * Transcribes audio and gets both text and voice response from the agent.
      */
-    transcribeAndAskWithVoiceResponse(fileToTranscribe: File, options?: Omit<AiAgentChatOptions, 'smoothTyping'>): Promise<TranscribeAndAskWithVoiceResponse>;
+    transcribeAndAskWithVoiceResponse<T extends AiChatModelName | undefined>(fileToTranscribe: File, options?: AiAskOptionsWithVoice<T>): Promise<TranscribeAndAskWithVoiceResponse>;
     /**
      * Sends a prompt and gets both text and voice response from the agent.
      */
-    askWithVoiceResponse(prompt: string, options?: Omit<AiAgentChatOptions, 'smoothTyping'>): Promise<AskWithVoiceResponse>;
+    askWithVoiceResponse<T extends AiChatModelName | undefined>(prompt: string, options?: AiAskOptionsWithVoice<T>): Promise<AskWithVoiceResponse>;
     private askInternal;
     private createStatusSubject;
     private chatInternal;

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

@@ -1,4 +1,4 @@
-import { AiAgentChatOptions } from '../../../internal-common/src/public-types/ai-agent.public-types';
+import { AiChatModelName, AiChatOptions } from '../../../internal-common/src/public-types/ai-agent.public-types';
 import { Observable } from 'rxjs';
 /**
  * Response format for transcribing audio and generating a chat response.
@@ -39,9 +39,20 @@ export interface AskWithVoiceResponse {
  * Chat options that exclude voice-specific configurations.
  * @category AI
  */
-export type ChatOptionsWithoutVoice = Omit<AiAgentChatOptions, 'voiceOptions'>;
+export type AiChatOptionsWithoutVoice<T extends AiChatModelName | undefined = undefined> = Omit<AiChatOptions<T>, 'voiceOptions'> & {
+    model?: T;
+};
 /**
  * Options for AI-generated responses that exclude voice-specific settings and smooth typing behavior.
  * @category AI
  */
-export type AskOptionsWithoutVoice = Omit<AiAgentChatOptions, 'voiceOptions' | 'smoothTyping'>;
+export type AiAskOptions<T extends AiChatModelName | undefined = undefined> = Omit<AiChatOptions<T>, 'voiceOptions' | 'smoothTyping'> & {
+    model?: T;
+};
+/**
+ * Options for AI-generated responses that include voice-specific settings but excludes smooth typing.
+ * @category AI
+ */
+export type AiAskOptionsWithVoice<T extends AiChatModelName | undefined = undefined> = Omit<AiChatOptions<T>, 'smoothTyping'> & {
+    model?: T;
+};

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

@@ -1,4 +1,4 @@
-import { ExtractDataFromDocumentOptions, ExtractDataFromDocumentResponse } from '../../internal-common/src/public-types/extraction.public-types';
+import { CreatePdfRequest, CreatePdfResponse, ExtractDataFromDocumentOptions, ExtractDataFromDocumentResponse } from '../../internal-common/src/public-types/extraction.public-types';
 /**
  * ExtractionClient provides methods for extracting structured data
  * from document files using AI-driven processing.
@@ -22,4 +22,9 @@ export declare class ExtractionClient {
      * @returns A promise that resolves with the extracted document data.
      */
     extractDataFromDocumentUrl(url: string, options?: ExtractDataFromDocumentOptions): Promise<ExtractDataFromDocumentResponse>;
+    /**
+     * Creates a PDF document from the provided request parameters.
+     * @param request - The request containing details for PDF creation, such as content or url.
+     */
+    createPdf(request: CreatePdfRequest): Promise<CreatePdfResponse>;
 }

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.363";
+export declare const SQUIDCLOUD_CLIENT_PACKAGE_VERSION = "1.0.364";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@squidcloud/client",
-  "version": "1.0.363",
+  "version": "1.0.364",
   "description": "A typescript implementation of the Squid client",
   "main": "dist/cjs/index.js",
   "module": "dist/esm/index.js",