@crewdle/web-sdk-types 1.0.33 → 1.0.35

package/dist/generative-ai/rag/GenerativeAIRagConnector.d.ts

@@ -0,0 +1,48 @@
+import { IGenerativeAIFile } from '../jobs';
+import { ISearchResult } from '../search';
+/**
+ * Generative AI Rag Connector Interface
+ * @category AI
+ */
+export interface IGenerativeAIRagConnector {
+    /**
+     * Create a collection.
+     * @param collectionId The collection id to create.
+     * @returns A promise that resolves when the collection is created.
+     */
+    createCollection(collectionId: string): Promise<void>;
+    /**
+     * Delete a collection.
+     * @param collectionId The collection id to delete.
+     * @returns A promise that resolves when the collection is deleted.
+     */
+    deleteCollection(collectionId: string): Promise<void>;
+    /**
+     * Query a collection.
+     * @param collectionId The collection id to query.
+     * @param query The query to run.
+     * @returns The search results.
+     */
+    queryCollection(collectionId: string, query: string): Promise<ISearchResult[]>;
+    /**
+     * Delete a file.
+     * @param collectionId The collection id of the file to delete.
+     * @param fileId The file id to delete.
+     * @returns A promise that resolves when the file is deleted.
+     */
+    deleteFile(collectionId: string, fileId: string): Promise<void>;
+    /**
+     * Ingest a file.
+     * @param collectionId The collection id to ingest the file.
+     * @param fileName The name of the file to ingest.
+     * @param content The content of the file to ingest.
+     * @returns A promise that resolves when the file is ingested.
+     */
+    ingestFile(collectionId: string, fileName: string, content: string): Promise<void>;
+    /**
+     * List files in a collection.
+     * @param collectionId The collection id to list files.
+     * @returns The list of files.
+     */
+    listFiles(collectionId: string): Promise<IGenerativeAIFile[]>;
+}

package/dist/generative-ai/rag/GenerativeAIRagConnector.js

@@ -0,0 +1 @@
+export {};

package/dist/generative-ai/rag/GenerativeAIRagConnectorConstructor.d.ts

@@ -0,0 +1,5 @@
+import { IGenerativeAIRagConnector } from './GenerativeAIRagConnector';
+/**
+ * The constructor for the GenerativeAI Rag Connector.
+ */
+export type GenerativeAIRagConnectorConstructor = new (apiKey: string) => IGenerativeAIRagConnector;

package/dist/generative-ai/rag/GenerativeAIRagConnectorConstructor.js

@@ -0,0 +1 @@
+export {};

package/dist/generative-ai/rag/index.d.ts

@@ -0,0 +1,2 @@
+export * from './GenerativeAIRagConnector';
+export * from './GenerativeAIRagConnectorConstructor';

package/dist/generative-ai/rag/index.js

@@ -0,0 +1,2 @@
+export * from './GenerativeAIRagConnector';
+export * from './GenerativeAIRagConnectorConstructor';

package/dist/generative-ai/search/AISearchConnector.d.ts

@@ -9,5 +9,5 @@ export interface IAISearchConnector {
      * @param apiKey The API key to use for the search.
      * @returns A promise that resolves with the search result.
      */
-    search(query: string, apiKey: string): Promise<string>;
+    search(query: string): Promise<string>;
 }

package/dist/generative-ai/search/AISearchConnectorConstructor.d.ts

@@ -3,4 +3,4 @@ import { IAISearchConnector } from './AISearchConnector';
  * Represents an AI search connector constructor.
  * @category AI
  */
-export type AISearchConnectorConstructor = new () => IAISearchConnector;
+export type AISearchConnectorConstructor = new (apiKey: string) => IAISearchConnector;

package/dist/generative-ai/search/SearchConnector.d.ts

@@ -28,5 +28,5 @@ export interface ISearchConnector {
      * @param engineId The engine ID to use for the search.
      * @returns A promise that resolves with the search results.
      */
-    search(query: string, apiKey: string, engineId: string): Promise<ISearchConnectorResult[]>;
+    search(query: string, engineId: string): Promise<ISearchConnectorResult[]>;
 }

package/dist/generative-ai/search/SearchConnectorConstructor.d.ts

@@ -3,4 +3,4 @@ import { ISearchConnector } from './SearchConnector';
  * Represents a search connector constructor.
  * @category AI
  */
-export type SearchConnectorConstructor = new () => ISearchConnector;
+export type SearchConnectorConstructor = new (apiKey: string) => ISearchConnector;

package/dist/generative-ai/union-types/CreateAIJobParameters.d.ts

@@ -1,9 +1,10 @@
-import { IGenerativeAISearchCreateJobParameters } from '../jobs/search/GenerativeAISearchCreateJobParameters';
-import { IGenerativeAIDownloadDocumentCreateJobParameters } from '../jobs/download-document';
+import { IGenerativeAICollectionCreateCreateJobParameters, IGenerativeAICollectionDeleteCreateJobParameters, IGenerativeAIEmbedCreateJobParameters, IGenerativeAIFileDeleteCreateJobParameters, IGenerativeAIFileIngestCreateJobParameters, IGenerativeAIFileListCreateJobParameters, IGenerativeAIInferenceCreateJobParameters, IGenerativeAIRealtimeSessionCreateCreateJobParameters, IGenerativeAIToolCallCreateJobParameters } from '../jobs';
+import { IGenerativeAICollectionQueryCreateJobParameters } from '../jobs/collection-query/GenerativeAICollectionQueryCreateJobParameters';
+import { IGenerativeAIFileDownloadCreateJobParameters } from '../jobs/file-download';
 import { IGenerativeAIPromptCreateJobParameters } from '../jobs/prompt';
 import { IGenerativeAIRatingCreateJobParameters } from '../jobs/rating';
 /**
  * Represents the parameters of an AI job.
  * @category AI
  */
-export type CreateAIJobParameters = IGenerativeAIPromptCreateJobParameters | IGenerativeAIRatingCreateJobParameters | IGenerativeAIDownloadDocumentCreateJobParameters | IGenerativeAISearchCreateJobParameters;
+export type CreateAIJobParameters = IGenerativeAICollectionCreateCreateJobParameters | IGenerativeAICollectionDeleteCreateJobParameters | IGenerativeAICollectionQueryCreateJobParameters | IGenerativeAIEmbedCreateJobParameters | IGenerativeAIFileDeleteCreateJobParameters | IGenerativeAIFileDownloadCreateJobParameters | IGenerativeAIFileIngestCreateJobParameters | IGenerativeAIFileListCreateJobParameters | IGenerativeAIInferenceCreateJobParameters | IGenerativeAIPromptCreateJobParameters | IGenerativeAIRatingCreateJobParameters | IGenerativeAIRealtimeSessionCreateCreateJobParameters | IGenerativeAIToolCallCreateJobParameters;

package/dist/generative-ai/union-types/GenerativeAIJob.d.ts

@@ -1,9 +1,10 @@
-import { IGenerativeAISearchJob } from '../jobs/search/GenerativeAISearchJob';
-import { IGenerativeAIDownloadDocumentJob } from '../jobs/download-document';
+import { IGenerativeAICollectionCreateJob, IGenerativeAICollectionDeleteJob, IGenerativeAIEmbedJob, IGenerativeAIFileDeleteJob, IGenerativeAIFileIngestJob, IGenerativeAIFileListJob, IGenerativeAIInferenceJob, IGenerativeAIRealtimeSessionCreateJob, IGenerativeAIToolCallJob } from '../jobs';
+import { IGenerativeAICollectionQueryJob } from '../jobs/collection-query/GenerativeAICollectionQueryJob';
+import { IGenerativeAIFileDownloadJob } from '../jobs/file-download';
 import { IGenerativeAIPromptJob } from '../jobs/prompt';
 import { IGenerativeAIRatingJob } from '../jobs/rating';
 /**
  * Represents a Generative AI job.
  * @category AI
  */
-export type GenerativeAIJob = IGenerativeAIPromptJob | IGenerativeAIRatingJob | IGenerativeAIDownloadDocumentJob | IGenerativeAISearchJob;
+export type GenerativeAIJob = IGenerativeAICollectionCreateJob | IGenerativeAICollectionDeleteJob | IGenerativeAICollectionQueryJob | IGenerativeAIEmbedJob | IGenerativeAIFileDeleteJob | IGenerativeAIFileDownloadJob | IGenerativeAIFileIngestJob | IGenerativeAIFileListJob | IGenerativeAIInferenceJob | IGenerativeAIPromptJob | IGenerativeAIRatingJob | IGenerativeAIRealtimeSessionCreateJob | IGenerativeAIToolCallJob;

package/dist/generative-ai/union-types/GenerativeAIJobResult.d.ts

@@ -1,9 +1,17 @@
-import { IGenerativeAIDownloadDocumentResult } from '../jobs/download-document';
+import { IGenerativeAIFileDownloadResult } from '../jobs/file-download';
 import { IGenerativeAIPromptResult } from '../jobs/prompt';
 import { IGenerativeAIRatingResult } from '../jobs/rating';
+import { IGenerativeAIFileListResult } from '../jobs/file-list';
+import { IGenerativeAICollectionCreateResult } from '../jobs/collection-create';
+import { IGenerativeAICollectionDeleteResult } from '../jobs/collection-delete';
+import { IGenerativeAIFileDeleteResult } from '../jobs/file-delete';
+import { IGenerativeAIFileIngestResult } from '../jobs/file-ingest';
+import { IGenerativeAICollectionQueryResult } from '../jobs/collection-query';
+import { IGenerativeAIRealtimeSessionCreateResult } from '../jobs/realtime-session-create';
+import { IGenerativeAIToolCallResult } from '../jobs/tool-call';
 /**
  * Union type for an AI job result.
  * Represents the result of an AI job.
  * @category AI
  */
-export type GenerativeAIJobResult = IGenerativeAIPromptResult | IGenerativeAIRatingResult | IGenerativeAIDownloadDocumentResult;
+export type GenerativeAIJobResult = IGenerativeAIPromptResult | IGenerativeAIRatingResult | IGenerativeAICollectionCreateResult | IGenerativeAICollectionDeleteResult | IGenerativeAICollectionQueryResult | IGenerativeAIFileDeleteResult | IGenerativeAIFileDownloadResult | IGenerativeAIFileIngestResult | IGenerativeAIFileListResult | IGenerativeAIRealtimeSessionCreateResult | IGenerativeAIToolCallResult;

package/dist/generative-ai/union-types/GenerativeAIWorkerParameters.d.ts

@@ -1,9 +1,10 @@
-import { IGenerativeAISearchWorkerParameters } from '../jobs/search';
-import { IGenerativeAIDownloadDocumentWorkerParameters } from '../jobs/download-document';
+import { IGenerativeAICollectionCreateWorkerParameters, IGenerativeAICollectionDeleteWorkerParameters, IGenerativeAIEmbedWorkerParameters, IGenerativeAIFileDeleteWorkerParameters, IGenerativeAIFileIngestWorkerParameters, IGenerativeAIFileListWorkerParameters, IGenerativeAIInferenceWorkerParameters, IGenerativeAIRealtimeSessionCreateWorkerParameters, IGenerativeAIToolCallWorkerParameters } from '../jobs';
+import { IGenerativeAICollectionQueryWorkerParameters } from '../jobs/collection-query';
+import { IGenerativeAIFileDownloadWorkerParameters } from '../jobs/file-download';
 import { IGenerativeAIPromptWorkerParameters } from '../jobs/prompt';
 import { IGenerativeAIRatingWorkerParameters } from '../jobs/rating';
 /**
  * Union type for AI job worker parameters.
  * @category AI
  */
-export type GenerativeAIWorkerParameters = IGenerativeAIPromptWorkerParameters | IGenerativeAIRatingWorkerParameters | IGenerativeAIDownloadDocumentWorkerParameters | IGenerativeAISearchWorkerParameters;
+export type GenerativeAIWorkerParameters = IGenerativeAICollectionCreateWorkerParameters | IGenerativeAICollectionDeleteWorkerParameters | IGenerativeAICollectionQueryWorkerParameters | IGenerativeAIEmbedWorkerParameters | IGenerativeAIFileDeleteWorkerParameters | IGenerativeAIFileDownloadWorkerParameters | IGenerativeAIFileIngestWorkerParameters | IGenerativeAIFileListWorkerParameters | IGenerativeAIInferenceWorkerParameters | IGenerativeAIPromptWorkerParameters | IGenerativeAIRatingWorkerParameters | IGenerativeAIRealtimeSessionCreateWorkerParameters | IGenerativeAIToolCallWorkerParameters;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@crewdle/web-sdk-types",
-  "version": "1.0.33",
+  "version": "1.0.35",
   "description": "The Crewdle Mist Web SDK public types and interfaces",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",

package/dist/generative-ai/jobs/download-document/GenerativeAIDownloadDocumentJob.d.ts

@@ -1,25 +0,0 @@
-import { IGenerativeAIJob } from '../generic';
-import { IGenerativeAIDownloadDocumentResult } from './GenerativeAIDownloadDocumentResult';
-/**
- * Represents bounded download document job ready to be executed.
- * @category AI
- */
-export interface IGenerativeAIDownloadDocumentJob extends IGenerativeAIJob {
-    /**
-     * The job ID.
-     */
-    id: string;
-    /**
-     * The object store id of the document to download.
-     */
-    objectStoreId: string;
-    /**
-     * The path of the document to download.
-     */
-    documentPath: string;
-    /**
-     * Run the download document job.
-     * @returns A promise that resolves with the result.
-     */
-    download: () => Promise<IGenerativeAIDownloadDocumentResult>;
-}

package/dist/generative-ai/jobs/download-document/GenerativeAIDownloadDocumentWorkerParameters.d.ts

@@ -1,20 +0,0 @@
-import { GenerativeAIJobType } from '../../GenerativeAIJobType';
-import { IGenerativeAIWorkerParameters } from '../generic/GenerativeAIWorkerParameters';
-/**
- * AI download document job parameters Interface
- * @category AI
- */
-export interface IGenerativeAIDownloadDocumentWorkerParameters extends IGenerativeAIWorkerParameters {
-    /**
-     * The AI job type.
-     */
-    type: GenerativeAIJobType.DownloadDocument;
-    /**
-     * The object store id of the document to download.
-     */
-    objectStoreId: string;
-    /**
-     * The path of the document to download.
-     */
-    documentPath: string;
-}

package/dist/generative-ai/jobs/download-document/index.d.ts

@@ -1,4 +0,0 @@
-export * from './GenerativeAIDownloadDocumentCreateJobParameters';
-export * from './GenerativeAIDownloadDocumentJob';
-export * from './GenerativeAIDownloadDocumentWorkerParameters';
-export * from './GenerativeAIDownloadDocumentResult';

package/dist/generative-ai/jobs/download-document/index.js

@@ -1,4 +0,0 @@
-export * from './GenerativeAIDownloadDocumentCreateJobParameters';
-export * from './GenerativeAIDownloadDocumentJob';
-export * from './GenerativeAIDownloadDocumentWorkerParameters';
-export * from './GenerativeAIDownloadDocumentResult';

package/dist/generative-ai/jobs/search/index.d.ts

@@ -1,3 +0,0 @@
-export * from './GenerativeAISearchCreateJobParameters';
-export * from './GenerativeAISearchJob';
-export * from './GenerativeAISearchWorkerParameter';

package/dist/generative-ai/jobs/search/index.js

@@ -1,3 +0,0 @@
-export * from './GenerativeAISearchCreateJobParameters';
-export * from './GenerativeAISearchJob';
-export * from './GenerativeAISearchWorkerParameter';