@squidcloud/client 1.0.268 → 1.0.270

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/internal-common/src/public-types/bundle-data.public-types.d.ts

@@ -4,6 +4,8 @@ export type DatabaseActionType = 'read' | 'write' | 'update' | 'insert' | 'delet
 export type StorageActionType = 'read' | 'write' | 'update' | 'insert' | 'delete' | 'all';
 /** The different types of actions that can be performed on a topic. */
 export type TopicActionType = 'read' | 'write' | 'all';
+/** The different type of actions for metrics. */
+export type MetricActionType = 'write' | 'all';
 /** The different types of actions that can be performed on an AI chatbot. */
 export type AiChatbotActionType = 'chat' | 'mutate' | 'all';
 export type AiFunctionParamType = 'string' | 'number' | 'boolean' | 'date';

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

@@ -26,6 +26,7 @@ export declare enum IntegrationType {
     'gcs' = "gcs",
     'built_in_s3' = "built_in_s3",
     'built_in_gcs' = "built_in_gcs",
+    'google_drive' = "google_drive",
     'algolia' = "algolia",
     'elastic_observability' = "elastic_observability",
     'elastic_search' = "elastic_search",

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/index.d.ts

@@ -41,4 +41,5 @@ export * from './squid-http-client';
 export * from './squid';
 export * from './types';
 export * from './storage-client';
+export * from './personal-storage-client';
 export * from './extraction-client';

package/dist/typescript-client/src/personal-storage-client.d.ts

@@ -0,0 +1,59 @@
+import { AiContextMetadata } from '../../internal-common/src/public-types/ai-chatbot.public-types';
+import { DocumentTextDataResponse } from '../../internal-common/src/public-types/extraction.public-types';
+interface PsGetAccessTokenResponse {
+    accessToken: string;
+    expirationTime: Date;
+}
+/**
+ * Client to handle personal storage integrations such as Google Drive or Microsoft OneDrive.
+ * Provides methods for saving authentication tokens, indexing documents or folders for AI processing,
+ * and unindexing documents from AI processing.
+ */
+export declare class PersonalStorageClient {
+    private readonly integrationId;
+    private readonly rpcManager;
+    /**
+     * Saves an authentication token for the personal storage service.
+     *
+     * @param authCode - The authorization code obtained from the OAuth flow for the personal storage service.
+     * @param identifier - A user-provided identifier (usually a user ID) that will be associated with the token.
+     * @returns A promise that resolves with the access token and expiration time.
+     */
+    saveToken(authCode: string, identifier: string): Promise<PsGetAccessTokenResponse>;
+    /**
+     * Retrieves an access token for the personal storage service.
+     *
+     * @param identifier - A user-provided identifier (usually a user ID) that is associated with the token.
+     * @returns A promise that resolves with the access token and expiration time.
+     */
+    getAccessToken(identifier: string): Promise<PsGetAccessTokenResponse>;
+    /**
+     * Extracts text data from a document.
+     * @param documentId - The ID of the document to extract text data from.
+     * @param identifier - A user-provided identifier (usually a user ID) that is associated with the document.
+     * @returns A promise that resolves with the extracted text data.
+     */
+    extractDataFromDocument(documentId: string, identifier: string): Promise<DocumentTextDataResponse>;
+    /**
+     * Indexes a document or folder for AI processing.
+     *
+     * @param documentOrFolderId - The ID of the document or folder to be indexed.
+     * @param identifier - A user-provided identifier (usually a user ID) that will be associated with the document.
+     * @param aiProfileId - The profile ID for the AI processing configuration.
+     * @param aiIntegrationId - The integration ID for the AI processing configuration.
+     * @param metadata - Metadata to include with the index
+     * @returns A promise that resolves when the document or folder is successfully indexed.
+     */
+    indexDocumentOrFolder(documentOrFolderId: string, identifier: string, aiProfileId: string, aiIntegrationId: string, metadata?: AiContextMetadata): Promise<void>;
+    /**
+     * Unindexes a previously indexed document, removing it from AI processing.
+     *
+     * @param documentId - The ID of the document to be unindexed.
+     * @param identifier - A user-provided identifier (usually a user ID) that was associated with the document.
+     * @param aiProfileId - The profile ID for the AI processing configuration.
+     * @param aiIntegrationId - The integration ID for the AI processing configuration.
+     * @returns A promise that resolves when the document is successfully unindexed.
+     */
+    unindexDocument(documentId: string, identifier: string, aiProfileId: string, aiIntegrationId: string): Promise<void>;
+}
+export {};

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

@@ -9,6 +9,7 @@ import { SecretClient } from './secret.client';
 import { StorageClient } from './storage-client';
 import { TransactionId } from './types';
 import { ExtractionClient } from './extraction-client';
+import { PersonalStorageClient } from './personal-storage-client';
 /** The different options that can be used to initialize a Squid instance. */
 export interface SquidOptions {
     /**
@@ -201,6 +202,7 @@ export declare class Squid {
     ai(): AiClient;
     api(): ApiClient;
     storage(integrationId?: IntegrationId): StorageClient;
+    personalStorage(integrationId: IntegrationId): PersonalStorageClient;
     extraction(): ExtractionClient;
     get secrets(): SecretClient;
     /**

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.270";

package/package.json

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