@squidcloud/client 1.0.268 → 1.0.269

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

@@ -1,4 +1,5 @@
 import { FunctionName } from './bundle-data.public-types';
+import { IntegrationId } from './communication.public-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", "gpt-4-turbo"];
 export declare const GEMINI_CHAT_MODEL_NAMES: readonly ["gemini-pro"];
@@ -89,6 +90,20 @@ export interface AiChatbotChatOptions {
     /** A set of filters that will limit the context the AI can access */
     contextMetadataFilter?: AiContextMetadataFilter;
 }
+/** The options for the AI chatbot search method. */
+export interface AiSearchOptions {
+    /** The prompt to search for */
+    prompt: string;
+    /** A set of filters that will limit the context the AI can access */
+    contextMetadataFilter?: AiContextMetadataFilter;
+    /** The maximum number of results to return */
+    limit?: number;
+}
+export interface AiSearchRequest {
+    options: AiSearchOptions;
+    profileId: string;
+    integrationId: IntegrationId;
+}
 export type AiChatbotMutationType = 'insert' | 'update' | 'delete';
 export type AiChatbotResourceType = 'instruction' | 'context' | 'profile';
 export type AiChatbotContextType = 'text' | 'url' | 'file';
@@ -97,6 +112,14 @@ export interface AiChatbotContextBase {
     data: string;
     metadata?: AiContextMetadata;
 }
+export interface AiSearchResponse {
+    chunks: Array<AiSearchResultChunk>;
+}
+export interface AiSearchResultChunk {
+    data: string;
+    metadata?: AiContextMetadata;
+    score: number;
+}
 export interface AiChatbotTextContext extends AiChatbotContextBase {
     type: 'text';
 }

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

@@ -1,4 +1,4 @@
-import { AiChatbotChatOptions, AiChatbotContext, AiChatModelName } from './public-types';
+import { AiChatbotChatOptions, AiChatbotContext, AiChatModelName, AiSearchOptions, AiSearchResponse } from './public-types';
 import { Observable } from 'rxjs';
 export declare class AiChatbotClient {
     private readonly rpcManager;
@@ -24,6 +24,7 @@ export declare class AiChatbotClient {
      * that has been received so far.
      */
     chat(profileId: string, prompt: string, options?: AiChatbotChatOptions): Observable<string>;
+    search(profileId: string, options: AiSearchOptions): Promise<AiSearchResponse>;
     /**
      * Sends a prompt to the specified profile id and returns the response as a Promise of string.
      *
@@ -66,6 +67,7 @@ export declare class AiChatbotProfileReference {
      * @param options - The chat options.
      */
     ask(prompt: string, options?: Omit<AiChatbotChatOptions, 'smoothTyping'>): Promise<string>;
+    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
      * to the profile, or update/delete an existing entry context.

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

@@ -1 +1 @@
-export declare const SQUIDCLOUD_CLIENT_PACKAGE_VERSION = "1.0.268";
+export declare const SQUIDCLOUD_CLIENT_PACKAGE_VERSION = "1.0.269";

package/package.json

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