@squidcloud/client 1.0.298 → 1.0.300

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

@@ -1,11 +1,12 @@
 import { FunctionName, FunctionNameWithContext } from './bundle-data.public-types';
 import { IntegrationId } from './communication.public-types';
+import { AiChatPromptQuotas, AiConnectedAgentMetadata } from '../types/ai-chatbot.types';
 /** The supported OpenAI models */
-export declare const OPENAI_CHAT_MODEL_NAMES: readonly ["gpt-3.5-turbo", "gpt-3.5-turbo-1106", "gpt-4", "gpt-4-turbo-preview", "gpt-4o", "gpt-4o-mini", "gpt-4o-2024-08-06", "o1-preview", "o1-mini", "gpt-4-turbo"];
-export declare const GEMINI_CHAT_MODEL_NAMES: readonly ["gemini-pro", "gemini-1.5-pro", "gemini-1.5-flash"];
-export declare const ANTHROPIC_CHAT_MODEL_NAMES: readonly ["claude-3-opus-20240229", "claude-3-sonnet-20240229", "claude-3-haiku-20240307", "claude-3-5-sonnet-20240620"];
+export declare const OPENAI_CHAT_MODEL_NAMES: readonly ["gpt-4o", "gpt-4o-mini", "o1-preview", "o1-mini"];
+export declare const GEMINI_CHAT_MODEL_NAMES: readonly ["gemini-1.5-pro", "gemini-1.5-flash"];
+export declare const ANTHROPIC_CHAT_MODEL_NAMES: readonly ["claude-3-5-haiku-latest", "claude-3-5-sonnet-latest"];
 /** The supported AI model names. */
-export declare const AI_CHAT_MODEL_NAMES: readonly ["gpt-3.5-turbo", "gpt-3.5-turbo-1106", "gpt-4", "gpt-4-turbo-preview", "gpt-4o", "gpt-4o-mini", "gpt-4o-2024-08-06", "o1-preview", "o1-mini", "gpt-4-turbo", "claude-3-opus-20240229", "claude-3-sonnet-20240229", "claude-3-haiku-20240307", "claude-3-5-sonnet-20240620", "gemini-pro", "gemini-1.5-pro", "gemini-1.5-flash"];
+export declare const AI_CHAT_MODEL_NAMES: readonly ["gpt-4o", "gpt-4o-mini", "o1-preview", "o1-mini", "claude-3-5-haiku-latest", "claude-3-5-sonnet-latest", "gemini-1.5-pro", "gemini-1.5-flash"];
 export declare const OPENAI_EMBEDDINGS_MODEL_NAMES: readonly ["text-embedding-3-small", "text-embedding-3-large", "text-embedding-ada-002"];
 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. */
@@ -146,6 +147,10 @@ export interface AiChatbotChatOptions {
     contextMetadataFilter?: AiContextMetadataFilter;
     /** The options to use for the response in voice. */
     voiceOptions?: AiAudioCreateSpeechOptions;
+    /** List of connected AI agents can be called by the current agent. */
+    connectedAgents?: Array<AiConnectedAgentMetadata>;
+    /** Current budget for nested or recursive AI chat calls per single prompt. */
+    quotas?: AiChatPromptQuotas;
 }
 export interface AiAskResponse {
     responseString: string;
@@ -180,7 +185,7 @@ export interface AiSearchRequest {
     profileId: string;
     integrationId: IntegrationId;
 }
-export type AiChatbotMutationType = 'insert' | 'update' | 'delete' | 'append';
+export type AiChatbotMutationType = 'insert' | 'update' | 'delete' | 'append' | 'feedback';
 export type AiChatbotResourceType = 'instruction' | 'context' | 'profile';
 export type AiChatbotContextType = 'text' | 'url' | 'file';
 export interface AiChatbotContextBase {

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

@@ -1,5 +1,6 @@
 import { AiChatModelName, AiEmbeddingsModelName, VectorDbType } from '../ai-chatbot.public-types';
 import { FunctionName } from '../bundle-data.public-types';
+import { AiConnectedAgentMetadata } from '../../types/ai-chatbot.types';
 export type AiChatbotConfiguration = {
     apiKey?: string;
 };
@@ -8,12 +9,15 @@ export type AiChatbotProfileMetadata = {
     isPublic: boolean;
     strictContext?: boolean;
     instructions: Record<string, string>;
+    feedbackInstructions?: string;
     /** 'text-embedding-ada-002' if undefined. */
     embeddingModelName?: AiEmbeddingsModelName;
     /** 'pinecone' if undefined. */
     vectorDbType?: VectorDbType;
     /** List of AI functions attached to the profile by default. */
     functions?: Array<FunctionName>;
+    /** List of child AI profiles (agents) that can be used by the current agent. */
+    connectedProfiles?: Array<AiConnectedAgentMetadata>;
     auditLog?: boolean;
 };
 export type AiChatbotContextMetadata = {
@@ -22,3 +26,6 @@ export type AiChatbotContextMetadata = {
     preview: boolean;
     sizeBytes?: number;
 };
+export type MutableAiChatbotProfileMetadataFieldsType = keyof Pick<AiChatbotProfileMetadata, 'modelName' | 'isPublic' | 'functions' | 'connectedProfiles'>;
+/** List of fields that can be updated in runtime via API. */
+export declare const MUTABLE_AI_CHATBOT_PROFILE_METADATA_FIELDS: Array<MutableAiChatbotProfileMetadataFieldsType>;

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

@@ -1,4 +1,4 @@
-import { AiProfileId, AiChatbotChatOptions, AiChatbotContext, AiChatModelName, AiSearchOptions, AiSearchResponse, AiTranscribeAndAskResponse, AiTranscribeAndChatResponse } from './public-types';
+import { AiChatbotChatOptions, AiChatbotContext, AiChatbotProfileMetadata, AiProfileId, AiSearchOptions, AiSearchResponse, AiTranscribeAndAskResponse, AiTranscribeAndChatResponse, MUTABLE_AI_CHATBOT_PROFILE_METADATA_FIELDS } from './public-types';
 import { Observable } from 'rxjs';
 import { BlobAndFilename } from './types';
 export interface TranscribeAndChatResponse {
@@ -66,11 +66,7 @@ export interface AiChatBotContextData {
     title: string;
     context: AiChatbotContext;
 }
-export interface ProfileData {
-    modelName: AiChatModelName;
-    /** If the profile is public, there is no need to write a security rule to access the chat functionality. This can be dangerous, use with caution. */
-    isPublic: boolean;
-}
+export type AiProfileData = Pick<AiChatbotProfileMetadata, (typeof MUTABLE_AI_CHATBOT_PROFILE_METADATA_FIELDS)[number]>;
 export interface InstructionData {
     instruction: string;
 }
@@ -120,25 +116,23 @@ export declare class AiAgentReference {
      * Adds a new profile to the chatbot. This will result in an error if a profile already exists with the same id.
      *
      * @param data An object containing options for creating the profile.
-     * @param data.modelName - The name of the AI model (`gpt-3.5, `gpt-4`, `claude-3-opus-20240229`,
-     *   `claude-3-sonnet-20240229`, `claude-3-5-sonnet-20240620` or `claude-3-haiku-20240307`, `gemini-pro`,
-     *   `gemini-1.5-pro` `gemini-1.5-flash`).
+     * @param data.modelName - The name of the AI model (`gpt-3.5, `gpt-4`, `claude-3-5-sonnet-latest` or
+     *   `claude-3-5-haiku-latest`, `gemini-1.5-pro` `gemini-1.5-flash`).
      * @param data.isPublic - Whether the chat functionality of the profile can be accessed without security rules.
      * @returns A promise that resolves when the profile is successfully created.
      */
-    insert(data: ProfileData): Promise<void>;
+    insert(data: AiProfileData): Promise<void>;
     /**
      * Updates an existing chatbot profile. This will result in an error if a profile has not yet been created for the
      * current profile id.
      *
      * @param data An object containing options for updating the profile.
-     * @param data.modelName - The name of the OpenAI model (`gpt-3.5, `gpt-4`, `claude-3-opus-20240229`,
-     *   `claude-3-sonnet-20240229`, `claude-3-5-sonnet-20240620` or `claude-3-haiku-20240307`, `gemini-pro`,
-     *   `gemini-1.5-pro` `gemini-1.5-flash`).
+     * @param data.modelName - The name of the OpenAI model (`gpt-3.5, `gpt-4`, `claude-3-5-sonnet-latest` or
+     *   `claude-3-5-haiku-latest`, `gemini-1.5-pro` `gemini-1.5-flash`).
      * @param data.isPublic - Whether the chat functionality of the profile can be accessed without security rules.
      * @returns A promise that resolves when the profile is successfully updated.
      */
-    update(data: Partial<ProfileData>): Promise<void>;
+    update(data: Partial<AiProfileData>): Promise<void>;
     /**
      * Deletes an existing chatbot profile. This will result in an error if a profile has not yet been created for the
      * current profile id.
@@ -146,6 +140,8 @@ export declare class AiAgentReference {
      * @returns A promise that resolves when the profile is successfully deleted.
      */
     delete(): Promise<void>;
+    feedback(feedback: string): Promise<void>;
+    resetFeedback(): Promise<void>;
 }
 export declare class AiAgentContextReference {
     private readonly client;

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

@@ -22,6 +22,7 @@ export * from './mutation/mutation-sender';
 export * from './native-query-manager';
 export * from './public-types';
 export * from './public-utils';
+export * from './query-utils';
 export * from './query/deserializer';
 export * from './query/join-query-builder.factory';
 export * from './query/local-query-manager';

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

@@ -0,0 +1,14 @@
+import { DocumentData } from '../../internal-common/src/public-types/document.public-types';
+import { QueryBuilder } from './query/query-builder.factory';
+/** Result of the `visitQueryResults` function. */
+export interface VisitQueryResultsStats {
+    /** Count of documents visited. */
+    count: number;
+    /** Time in millis spent in the function. */
+    time: number;
+}
+/**
+ * Reads all objects from the query in a safe way (with pagination) and calls callback() on every object.
+ * The iteration is interrupted if error is thrown.
+ */
+export declare function visitQueryResults<T extends DocumentData>(query: QueryBuilder<T>, callback: (t: T) => Promise<unknown>, pageSize?: number): Promise<VisitQueryResultsStats>;

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

@@ -1 +1 @@
-export declare const SQUIDCLOUD_CLIENT_PACKAGE_VERSION = "1.0.298";
+export declare const SQUIDCLOUD_CLIENT_PACKAGE_VERSION = "1.0.300";

package/package.json

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