@squidcloud/client 1.0.337 → 1.0.339

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

@@ -1,7 +1,11 @@
 import { AppId, ClientId } from './communication.public-types';
+/**
+ * @category Auth
+ */
 export type AuthType = 'Bearer' | 'ApiKey';
 /**
  * The payload of a JWT token in case an auth token was used.
+ * @category Auth
  */
 export interface AuthWithBearer {
     type: 'Bearer';
@@ -12,13 +16,20 @@ export interface AuthWithBearer {
 }
 /**
  * The authentication object for the current request in case an API key is used.
+ * @category Auth
  */
 export interface AuthWithApiKey {
     type: 'ApiKey';
     apiKey: string;
 }
-/** The authentication object for the current request. */
+/**
+ * The authentication object for the current request.
+ * @category Auth
+ */
 export type Auth = AuthWithBearer | AuthWithApiKey;
+/**
+ * @category Auth
+ */
 export interface AuthToken {
     type: AuthType;
     token: string;

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

@@ -1,32 +1,62 @@
 import { IntegrationId } from './communication.public-types';
+/**
+ * @category Database
+ */
 export type PrimitiveFieldType = string | number | boolean | null | Date;
+/**
+ * @category Database
+ */
 export type FieldType = PrimitiveFieldType | Array<FieldType> | {
     [key: string]: FieldType;
 };
-/** A type alias for a field name. */
+/**
+ * A type alias for a field name.
+ * @category Database
+ */
 export type FieldName<T = any> = string & keyof T;
-/** A type alias for a document id as string. */
+/**
+ * A type alias for a document id as string.
+ * @category Database
+ */
 export type DocId = string;
-/** A type alias for a document id object when the ID is a composite of primary keys. */
+/**
+ * A type alias for a document id object when the ID is a composite of primary keys.
+ * @category Database
+ */
 export type DocIdObj = Record<FieldName, any>;
-/** A type alias for a document id or a document id object. */
+/**
+ * A type alias for a document id or a document id object.
+ * @category Database
+ */
 export type DocIdOrDocIdObj = DocId | DocIdObj;
-/** A type alias for a collection name. */
+/**
+ * A type alias for a collection name.
+ * @category Database
+ */
 export type CollectionName = string;
-/** A generic document data type. */
+/**
+ * A generic document data type.
+ * @category Database
+ */
 export type DocumentData = Record<FieldName, any | undefined>;
+/**
+ * A type alias for timestamp field..
+ * @category Database
+ */
 export type DocTimestamp = number;
+/**
+ * The structure of a Squid Document.
+ * @category Database
+ */
 export interface SquidDocument {
     __docId__: DocId;
     __ts__: DocTimestamp;
     [fieldName: string]: FieldType | undefined;
 }
-/** The before and after documents of a document change. */
-export interface BeforeAndAfterDocs<T = SquidDocument> {
-    before: T | undefined;
-    after: T | undefined;
-}
-/** The full document id, including the collection name and the integration id. */
+/**
+ * The full document id, including the collection name and the integration id.
+ * @category Database
+ */
 export interface SquidDocIdObj {
     collectionName: CollectionName;
     docId: DocId;

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

@@ -1,24 +1,45 @@
+/**
+ * @category Storage
+ */
 export type DocumentFileDataType = 'image';
+/**
+ * @category Storage
+ */
 export interface ExtractDataFromDocumentFileOptions {
     password?: string;
 }
+/**
+ * @category Storage
+ */
 export interface DocumentFileData {
     type: DocumentFileDataType;
     pathInBucket: string;
 }
+/**
+ * @category Storage
+ */
 export interface DocumentPageData {
     title?: string;
     text: string;
     fileDataList: DocumentFileData[];
 }
+/**
+ * @category Storage
+ */
 export interface ExtractDataFromDocumentResponse {
     documentPathInBucket?: string;
     pages: DocumentPageData[];
 }
+/**
+ * @category Storage
+ */
 export interface TextOnlyPageData {
     text: string;
     title?: string;
 }
+/**
+ * @category Storage
+ */
 export interface DocumentTextDataResponse {
     pages: TextOnlyPageData[];
 }

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

@@ -1,17 +1,31 @@
 import { IntegrationId } from './communication.public-types';
-export declare const AI_AGENTS_INTEGRATION_ID = "ai_agents";
 /** List of all integration types supported by Squid. */
 export declare const INTEGRATION_TYPES: readonly ["active_directory", "ai_agents", "ai_chatbot", "algolia", "alloydb", "api", "auth0", "azure_cosmosdb", "azure_postgresql", "azure_sql", "bigquery", "built_in_db", "built_in_gcs", "built_in_queue", "built_in_s3", "cassandra", "clickhouse", "cloudsql", "cockroach", "cognito", "confluence", "confluent", "datadog", "db2", "descope", "documentdb", "dynamodb", "elastic_enterprise_search", "elastic_observability", "elastic_search", "firebase_auth", "firestore", "gcs", "google_docs", "google_drive", "graphql", "hubspot", "jira", "jwt_hmac", "jwt_rsa", "kafka", "linear", "mariadb", "monday", "mongo", "mssql", "mysql", "newrelic", "okta", "onedrive", "oracledb", "pinecone", "postgres", "redis", "s3", "salesforce_crm", "sap_hana", "sentry", "servicenow", "snowflake", "spanner", "xata", "zendesk", "mail", "slack"];
+/**
+ * @category Database
+ */
 export declare const DATA_INTEGRATION_TYPES: readonly ["bigquery", "built_in_db", "clickhouse", "cockroach", "mongo", "mssql", "mysql", "oracledb", "postgres", "sap_hana", "snowflake"];
+/**
+ * @category Auth
+ */
 export declare const AUTH_INTEGRATION_TYPES: readonly ["auth0", "jwt_rsa", "jwt_hmac", "cognito", "okta", "descope", "firebase_auth"];
 export declare const GRAPHQL_INTEGRATION_TYPES: readonly ["graphql", "linear"];
 export declare const HTTP_INTEGRATION_TYPES: readonly ["api", "confluence"];
 export type IntegrationType = (typeof INTEGRATION_TYPES)[number];
 export declare const INTEGRATION_SCHEMA_TYPES: readonly ["data", "api", "graphql"];
 export type IntegrationSchemaType = (typeof INTEGRATION_SCHEMA_TYPES)[number];
+/**
+ * @category Database
+ */
 export declare const BUILT_IN_DB_INTEGRATION_ID: IntegrationId;
+/**
+ * @category Queue
+ */
 export declare const BUILT_IN_QUEUE_INTEGRATION_ID: IntegrationId;
-/** ID for the cloud specific storage integration: s3 (built_in_s3) or gcs (built_in_gcs). */
+/**
+ * ID for the cloud specific storage integration: s3 (built_in_s3) or gcs (built_in_gcs).
+ * @category Storage
+ */
 export declare const BUILT_IN_STORAGE_INTEGRATION_ID: IntegrationId;
 export interface IntegrationInfo<ConfigurationType = Record<string, any> | undefined> {
     id: IntegrationId;

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

@@ -1,6 +1,4 @@
-import { IntegrationType } from '../integration.public-types';
 import { FieldName } from '../document.public-types';
-import { IntegrationId } from '../communication.public-types';
 export type HttpMethod = 'post' | 'get' | 'delete' | 'patch' | 'put';
 export type ApiEndpointId = string;
 export type ApiParameterLocation = 'query' | 'body' | 'header' | 'path';
@@ -60,12 +58,3 @@ export interface ApiEndpoint {
     bodyMimeType?: string;
     isRequestBodyRequired?: boolean;
 }
-export interface DiscoverOpenApiSchemaRequest {
-    integrationId: IntegrationId;
-    integrationType: Extract<IntegrationType, 'api'>;
-    discoveryOptions: OpenApiDiscoveryOptions;
-}
-export interface DiscoverOpenApiSchemaFromFileRequest {
-    integrationId: IntegrationId;
-    integrationType: Extract<IntegrationType, 'api'>;
-}

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

@@ -2,11 +2,13 @@ import { CollectionName, DocumentData, FieldName } from './document.public-types
 import { Paths } from './typescript.public-types';
 /**
  * An alias for a join result. This is used to disambiguate fields in the result.
+ * @category Database
  */
 export type Alias = string;
 /**
  * A join condition.
  * The join conditions defines the alias for the left side of the join and the field names to join on.
+ * @category Database
  */
 export interface JoinCondition {
     leftAlias: Alias;
@@ -14,10 +16,20 @@ export interface JoinCondition {
     right: FieldName;
     isInner: boolean;
 }
-/** A list of query conditions. */
+/**
+ * A list of query conditions.
+ * @category Database
+ */
 export type Condition<Doc extends DocumentData = any> = SimpleCondition<Doc> | CompositeCondition<Doc>;
+/**
+ * A list of query conditions.
+ * @category Database
+ */
 export type Conditions<Doc extends DocumentData = any> = Array<Condition<Doc>>;
-/** A single field query condition. */
+/**
+ * A single field query condition.
+ * @category Database
+ */
 export interface SimpleCondition<Doc extends DocumentData = any, F extends Paths<Doc> = Paths<Doc>, MyOperator = Operator> {
     fieldName: F;
     operator: MyOperator;
@@ -29,23 +41,39 @@ export interface SimpleCondition<Doc extends DocumentData = any, F extends Paths
  * evaluated this way:
  * If A, B, C are the conditions and A` = A with '==' operator:
  * A || (A' && B) || (A' && B' && C)
+ * @category Database
  */
 export interface CompositeCondition<Doc extends DocumentData = any> {
     fields: Array<SimpleCondition<Doc, Paths<Doc>, CompositeConditionOperator>>;
 }
-/** Returns true if the condition is a 'SimpleCondition' or false otherwise. */
-export declare function isSimpleCondition(condition: Condition): condition is SimpleCondition;
 type CompositeConditionOperator = '>=' | '<=' | '>' | '<';
+/**
+ * The list of operators related to arrays.
+ * @category Database
+ */
 export declare const ARRAY_OPERATORS: readonly ["in", "not in", "array_includes_some", "array_includes_all", "array_not_includes"];
+/**
+ * The list of all operators.
+ * @category Database
+ */
 export declare const ALL_OPERATORS: readonly ["in", "not in", "array_includes_some", "array_includes_all", "array_not_includes", "==", "!=", ">=", "<=", ">", "<", "like", "not like", "like_cs", "not like_cs"];
-/** An operator in a query condition. */
+/**
+ * An operator in a query condition.
+ * @category Database
+ */
 export type Operator = (typeof ALL_OPERATORS)[number];
-/** A definition of a sort by a filed. */
+/**
+ * A definition of a sort by a field.
+ * @category Database
+ */
 export interface FieldSort<Doc> {
     fieldName: FieldName<Doc>;
     asc: boolean;
 }
-/** A query object. */
+/**
+ * A query object.
+ * @category Database
+ */
 export interface Query<Doc extends DocumentData = any> {
     collectionName: CollectionName;
     integrationId: string;

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

@@ -1,21 +1,30 @@
-import { ServiceFunctionName } from './bundle-data.public-types';
+import { ServiceFunctionName } from './backend.public-types';
+/**
+ * @category Platform
+ */
 export interface SchedulerConfig {
     functionName: ServiceFunctionName;
     cronExpression: string;
     exclusive: boolean;
 }
+/**
+ * @category Platform
+ */
 export interface SchedulerInfo {
     schedulerId: string;
     config: SchedulerConfig;
     enabled: boolean;
 }
-export interface ListSchedulersResponse {
-    schedulers: SchedulerInfo[];
-}
+/**
+ * @category Platform
+ */
 export interface UpdateSchedulerOptions {
     schedulerId: string;
     enabled?: boolean;
 }
+/**
+ * @category Platform
+ */
 export interface UpdateSchedulersRequest {
     schedulers: UpdateSchedulerOptions[];
 }

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

@@ -1,23 +1,40 @@
-/** A type alias for an ApiKey. */
+/**
+ * A type alias for an ApiKey.
+ * @category Secret
+ */
 export type ApiKey = string;
-/** The secret key, an alias for a string. */
+/**
+ * The secret key, an alias for a string.
+ * @category Secret
+ */
 export type SecretKey = string;
-/** The secret value. */
+/**
+ * The secret value.
+ * @category Secret
+ */
 export type SecretValue = string | number | boolean;
+/**
+ * @category Secret
+ */
 export interface SecretMetadata {
     key: SecretKey;
     lastUpdated: number;
 }
+/**
+ * @category Secret
+ */
 export interface SecretEntry<T extends SecretValue = SecretValue> extends SecretMetadata {
     value: T;
 }
+/**
+ * @category Secret
+ */
 export interface ApiKeyEntry extends SecretMetadata {
     value: string;
 }
-export type SetSecretEntry = {
-    key: SecretKey;
-    value?: SecretValue;
-};
+/**
+ * @category Secret
+ */
 export interface SetSecretRequestEntry {
     key: SecretKey;
     value: SecretValue;

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

@@ -1,10 +1,16 @@
 import { DocumentData } from './document.public-types';
 import { Alias, JoinCondition, Query } from './query.public-types';
+/**
+ * @category Database
+ */
 export type SerializedSimpleQuery = {
     type: 'simple';
     query: Query;
     dereference: boolean;
 };
+/**
+ * @category Database
+ */
 export type SerializedJoinQuery = {
     type: 'join';
     grouped: boolean;
@@ -17,8 +23,14 @@ export type SerializedJoinQuery = {
     joins: Record<Alias, Query<DocumentData>>;
     joinConditions: Record<Alias, JoinCondition>;
 };
+/**
+ * @category Database
+ */
 export type SerializedMergedQuery = {
     type: 'merged';
     queries: Array<SerializedQuery>;
 };
+/**
+ * @category Database
+ */
 export type SerializedQuery = SerializedSimpleQuery | SerializedJoinQuery | SerializedMergedQuery;

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

@@ -1,6 +1,3 @@
-export interface Type<T> extends Function {
-    new (...args: any[]): T;
-}
 export type PartialBy<T, K extends keyof T> = Omit<T, K> & Partial<Pick<T, K>>;
 type PropertiesWithPrefix<Prefix extends string> = {
     [key in `${Prefix}${string}`]: any;

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

@@ -3,6 +3,7 @@ import { SecretClient } from './secret.client';
 /**
  * AdminClient provides access to application administrative operations,
  * including integrations and secrets management.
+ * @category Platform
  */
 export declare class AdminClient {
     private readonly rpcManager;

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

@@ -1,11 +1,17 @@
-import { AgentContextRequest, AiAgent, AiAgentChatOptions, AiAgentContext, AiChatModelName, AiConnectedAgentMetadata, AiObserveStatusOptions, AiSearchOptions, AiSearchResponse, AiStatusMessage, AiTranscribeAndAskResponse, UpsertAgentRequest } from '../../../internal-common/src/public-types/ai-agent.public-types';
+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 { Observable } from 'rxjs';
 import { AskOptionsWithoutVoice, AskWithVoiceResponse, ChatOptionsWithoutVoice, 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.
+ * @category AI
+ */
 export type UpsertAgentRequestParams = Omit<UpsertAgentRequest, 'id'>;
 /**
  * AiAgentReference provides methods for managing AI agents, including
  * retrieving, updating, and deleting agents, handling agent contexts,
  * and interacting with chat or voice-based AI functionalities.
+ * @category AI
  */
 export declare class AiAgentReference {
     private readonly agentId;
@@ -13,27 +19,96 @@ export declare class AiAgentReference {
     private readonly statusUpdates;
     private readonly rpcManager;
     private readonly socketManager;
+    /**
+     * Retrieves metadata and configuration of the AI agent.
+     */
     get(): Promise<AiAgent | undefined>;
+    /**
+     * Creates or updates the AI agent with the provided parameters.
+     */
     upsert(agent: UpsertAgentRequestParams): Promise<void>;
+    /**
+     * Deletes the AI agent.
+     */
     delete(): Promise<void>;
+    /**
+     * Updates the agent's instruction prompt.
+     */
     updateInstructions(instructions: string): Promise<void>;
+    /**
+     * Changes the AI model used by the agent.
+     */
     updateModel(model: AiChatModelName): Promise<void>;
+    /**
+     * Updates the list of agents connected to this agent.
+     */
     updateConnectedAgents(connectedAgents: Array<AiConnectedAgentMetadata>): Promise<void>;
+    /**
+     * Retrieves a specific agent context by its ID.
+     */
     getContext(contextId: string): Promise<AiAgentContext | undefined>;
+    /**
+     * Lists all contexts associated with the agent.
+     */
     listContexts(): Promise<Array<AiAgentContext>>;
+    /**
+     * Deletes a specific context by its ID.
+     */
     deleteContext(contextId: string): Promise<void>;
+    /**
+     * Deletes multiple agent contexts.
+     */
     deleteContexts(contextIds: Array<string>): Promise<void>;
+    /**
+     * Adds or updates a single agent context.
+     */
     upsertContext(contextRequest: AgentContextRequest, file?: File): Promise<void>;
+    /**
+     * Adds or updates multiple agent contexts.
+     */
     upsertContexts(contextRequests: Array<AgentContextRequest>, files?: Array<File>): Promise<void>;
+    /**
+     * Sends user feedback to the agent.
+     */
     provideFeedback(feedback: string): Promise<void>;
+    /**
+     * Resets any feedback previously provided to the agent.
+     */
     resetFeedback(): Promise<void>;
+    updateGuardrails(guardrails: GuardrailsOptions): Promise<void>;
+    upsertCustomGuardrails(customGuardrail: string): Promise<void>;
+    deleteCustomGuardrail(): Promise<void>;
+    /**
+     * Sends a prompt to the agent and receives streamed text responses.
+     */
     chat(prompt: string, options?: ChatOptionsWithoutVoice): Observable<string>;
+    /**
+     * Transcribes the given file and performs a chat interaction.
+     */
     transcribeAndChat(fileToTranscribe: File, options?: ChatOptionsWithoutVoice): Promise<TranscribeAndChatResponse>;
-    search(options: AiSearchOptions): Promise<AiSearchResponse>;
+    /**
+     * Performs a semantic search using the agent's knowledge base.
+     */
+    search(options: AiSearchOptions): Promise<Array<AiSearchResultChunk>>;
+    /**
+     * Sends a prompt and receives a full string response.
+     */
     ask(prompt: string, options?: AskOptionsWithoutVoice): Promise<string>;
+    /**
+     * Observes live status messages from the agent.
+     */
     observeStatusUpdates(options?: AiObserveStatusOptions): Observable<AiStatusMessage>;
+    /**
+     * Transcribes audio and sends it to the agent for response.
+     */
     transcribeAndAsk(fileToTranscribe: File, options?: AskOptionsWithoutVoice): Promise<AiTranscribeAndAskResponse>;
+    /**
+     * Transcribes audio and gets both text and voice response from the agent.
+     */
     transcribeAndAskWithVoiceResponse(fileToTranscribe: File, options?: Omit<AiAgentChatOptions, 'smoothTyping'>): Promise<TranscribeAndAskWithVoiceResponse>;
+    /**
+     * Sends a prompt and gets both text and voice response from the agent.
+     */
     askWithVoiceResponse(prompt: string, options?: Omit<AiAgentChatOptions, 'smoothTyping'>): Promise<AskWithVoiceResponse>;
     private askInternal;
     private createStatusSubject;

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

@@ -4,6 +4,7 @@ import { AiAgentReference } from './ai-agent-client-reference';
  * AiAgentClient manages AI agent interactions, including listing agents,
  * handling real-time chat responses, and processing AI status updates
  * through WebSocket notifications.
+ * @category AI
  */
 export declare class AiAgentClient {
     private readonly rpcManager;

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

@@ -1,17 +1,47 @@
 import { AiAgentChatOptions } from '../../../internal-common/src/public-types/ai-agent.public-types';
 import { Observable } from 'rxjs';
+/**
+ * Response format for transcribing audio and generating a chat response.
+ * Contains the transcribed text and a stream of AI-generated responses.
+ * @category AI
+ */
 export interface TranscribeAndChatResponse {
+    /** Transcribed text from the audio input. */
     transcribedPrompt: string;
+    /** Stream of AI-generated responses. */
     responseStream: Observable<string>;
 }
+/**
+ * Response format for transcribing audio and generating a text and voice response.
+ * Includes the transcribed prompt, the AI-generated response as text, and an audio file.
+ * @category AI
+ */
 export interface TranscribeAndAskWithVoiceResponse {
+    /** Transcribed text from the audio input. */
     transcribedPrompt: string;
+    /** AI-generated response as a string. */
     responseString: string;
+    /** AI-generated voice response as an audio file. */
     voiceResponseFile: File;
 }
+/**
+ * Response format for AI-generated voice responses.
+ * Contains the AI-generated text response and the corresponding audio file.
+ * @category AI
+ */
 export interface AskWithVoiceResponse {
+    /** AI-generated response as a string. */
     responseString: string;
+    /** AI-generated voice response as an audio file. */
     voiceResponseFile: File;
 }
+/**
+ * Chat options that exclude voice-specific configurations.
+ * @category AI
+ */
 export type ChatOptionsWithoutVoice = Omit<AiAgentChatOptions, 'voiceOptions'>;
+/**
+ * Options for AI-generated responses that exclude voice-specific settings and smooth typing behavior.
+ * @category AI
+ */
 export type AskOptionsWithoutVoice = Omit<AiAgentChatOptions, 'voiceOptions' | 'smoothTyping'>;

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

@@ -1,8 +1,9 @@
-import { AssistantToolType, FunctionName, QueryAssistantOptions } from './public-types';
+import { AssistantToolType, QueryAssistantOptions } from './public-types';
 /**
  * Client class for interacting with an AI Assistant server.
  * Provides functionalities like creating and deleting assistants and threads,
  * querying assistants, and managing files associated with assistants and threads.
+ * @category AI
  */
 export declare class AiAssistantClient {
     private readonly rpcManager;
@@ -16,7 +17,7 @@ export declare class AiAssistantClient {
      *   the addFileToAssistant method.
      * @returns A promise that resolves to the created assistant's ID.
      */
-    createAssistant(name: string, instructions: string, functions: Array<FunctionName>, toolTypes?: Array<AssistantToolType>): Promise<string>;
+    createAssistant(name: string, instructions: string, functions: Array<string>, toolTypes?: Array<AssistantToolType>): Promise<string>;
     /**
      * Deletes an AI assistant.
      * @param assistantId - The ID of the assistant to be deleted.

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

@@ -2,9 +2,24 @@ import { AiAudioCreateSpeechOptions, AiAudioTranscribeOptions } from './public-t
 /**
  * AiAudioClient provides methods for AI-driven audio processing,
  * including speech transcription and text-to-speech synthesis.
+ * @category AI
  */
 export declare class AiAudioClient {
     private readonly rpcManager;
+    /**
+     * Transcribes the spoken content of an audio file into text.
+     *
+     * @param file - The audio file to transcribe.
+     * @param options - Options specifying the transcription model and behavior.
+     * @returns A Promise that resolves to the transcribed text.
+     */
     transcribe(file: File, options?: AiAudioTranscribeOptions): Promise<string>;
+    /**
+     * Converts a text input into a spoken audio file using AI-generated speech.
+     *
+     * @param input - The text to convert to speech.
+     * @param options - Options for customizing speech synthesis (e.g., voice, speed).
+     * @returns A Promise that resolves to an audio File containing the synthesized speech.
+     */
     createSpeech(input: string, options: AiAudioCreateSpeechOptions): Promise<File>;
 }

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

@@ -9,6 +9,7 @@ import { AiAgentReference } from './agent/ai-agent-client-reference';
  * AiClient class serves as a facade for interacting with different AI services.
  * It provides simplified access to AI chatbot and assistant functionalities
  * through its methods.
+ * @category AI
  */
 export declare class AiClient {
     private readonly socketManager;
@@ -61,5 +62,9 @@ export declare class AiClient {
      */
     executeAiQuery(integrationId: IntegrationId, prompt: string, options?: ExecuteAiQueryOptions): Promise<ExecuteAiQueryResponse>;
     executeAiQueryMulti(integrationIds: Array<IntegrationId>, prompt: string, options?: ExecuteAiQueryOptions): Promise<ExecuteAiQueryMultiResponse>;
+    /**
+     * Request to execute an AI-powered API call.
+     * Allows specifying allowed endpoints and whether to provide an explanation.
+     */
     executeAiApiCall(integrationId: IntegrationId, prompt: string, allowedEndpoints?: string[], provideExplanation?: boolean): Promise<ExecuteAiApiResponse>;
 }