@crewdle/web-sdk-types 1.0.30 → 1.0.31

package/dist/generative-ai/GenerativeAIContext.d.ts

@@ -1,10 +1,8 @@
-import { IGenerativeAIRatingResult, IGenerativeAIDownloadDocumentResult } from '.';
-import { IGenerativeAIDownloadDocumentCreateJobParameters } from './jobs/download-document/GenerativeAIDownloadDocumentCreateJobParameters';
-import { IGenerativeAIDownloadDocumentJob } from './jobs/download-document/GenerativeAIDownloadDocumentJob';
-import { IGenerativeAIPromptCreateJobParameters } from './jobs/prompt/GenerativeAIPromptCreateJobParameters';
-import { IGenerativeAIPromptJob } from './jobs/prompt/GenerativeAIPromptJob';
-import { IGenerativeAIRatingCreateJobParameters } from './jobs/rating/GenerativeAIRatingCreateJobParameters';
-import { IGenerativeAIRatingJob } from './jobs/rating/GenerativeAIRatingJob';
+import { IGenerativeAIRatingResult, IGenerativeAIDownloadDocumentResult, ISearchResult } from '.';
+import { IGenerativeAIDownloadDocumentCreateJobParameters, IGenerativeAIDownloadDocumentJob } from './jobs/download-document';
+import { IGenerativeAIPromptCreateJobParameters, IGenerativeAIPromptJob } from './jobs/prompt';
+import { IGenerativeAIRatingCreateJobParameters, IGenerativeAIRatingJob } from './jobs/rating';
+import { IGenerativeAISearchCreateJobParameters, IGenerativeAISearchJob } from './jobs/search';
 /**
  * Represents a context for a Generative AI service.
  * @category AI
@@ -18,6 +16,7 @@ export interface IGenerativeAIContext {
     createAIJob(parameters: IGenerativeAIPromptCreateJobParameters): IGenerativeAIPromptJob;
     createAIJob(parameters: IGenerativeAIRatingCreateJobParameters): IGenerativeAIRatingJob;
     createAIJob(parameters: IGenerativeAIDownloadDocumentCreateJobParameters): IGenerativeAIDownloadDocumentJob;
+    createAIJob(parameters: IGenerativeAISearchCreateJobParameters): IGenerativeAISearchJob;
     /**
      * Rate a prompt.
      * @param parameters The parameters of the rating job.
@@ -30,6 +29,12 @@ export interface IGenerativeAIContext {
      * @returns A promise that resolves with the result containing the document as an ArrayBuffer.
      */
     downloadDocument(documentPath: string): Promise<IGenerativeAIDownloadDocumentResult>;
+    /**
+     * Search for documents.
+     * @param parameters The parameters of the search job.
+     * @returns A promise that resolves with the result containing the search results.
+     */
+    search(parameters: IGenerativeAISearchCreateJobParameters): Promise<ISearchResult[]>;
     /**
      * Get the data bucket IDs.
      * @returns An array of data bucket IDs.

package/dist/generative-ai/GenerativeAIJobType.d.ts

@@ -14,5 +14,9 @@ export declare const enum GenerativeAIJobType {
     /**
      * The user requests to download a document related to the answer they got.
      */
-    DownloadDocument = "downloadDocument"
+    DownloadDocument = "downloadDocument",
+    /**
+     * The AI job retrieves documents.
+     */
+    Search = "search"
 }

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

@@ -2,3 +2,4 @@ export * from './download-document';
 export * from './generic';
 export * from './prompt';
 export * from './rating';
+export * from './search';

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

@@ -2,3 +2,4 @@ export * from './download-document';
 export * from './generic';
 export * from './prompt';
 export * from './rating';
+export * from './search';

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

@@ -0,0 +1,20 @@
+import { GenerativeAIJobType } from '../../GenerativeAIJobType';
+import { IGenerativeAICreateJobParameters } from '../generic/GenerativeAICreateJobParameters';
+/**
+ * AI search job parameters Interface
+ * @category AI
+ */
+export interface IGenerativeAISearchCreateJobParameters extends IGenerativeAICreateJobParameters {
+    /**
+     * The AI job type.
+     */
+    type: GenerativeAIJobType.Search;
+    /**
+     * The query for the search.
+     */
+    query: string;
+    /**
+     * The collection id for the search.
+     */
+    collectionId: string;
+}

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

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

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

@@ -0,0 +1,25 @@
+import { ISearchResult } from '../../search';
+import { IGenerativeAIJob } from '../generic';
+/**
+ * AI search job Interface
+ * @category AI
+ */
+export interface IGenerativeAISearchJob extends IGenerativeAIJob {
+    /**
+     * The job ID.
+     */
+    id: string;
+    /**
+     * The query for the search.
+     */
+    query: string;
+    /**
+     * The collection id for the search.
+     */
+    collectionId: string;
+    /**
+     * Run the search job.
+     * @returns A promise that resolves with the result.
+     */
+    search: () => Promise<ISearchResult[]>;
+}

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

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

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

@@ -0,0 +1,20 @@
+import { GenerativeAIJobType } from '../../GenerativeAIJobType';
+import { IGenerativeAIWorkerParameters } from '../generic/GenerativeAIWorkerParameters';
+/**
+ * AI search job parameters Interface
+ * @category AI
+ */
+export interface IGenerativeAISearchWorkerParameters extends IGenerativeAIWorkerParameters {
+    /**
+     * The AI job type.
+     */
+    type: GenerativeAIJobType.Search;
+    /**
+     * The query for the search.
+     */
+    query: string;
+    /**
+     * The collection id for the search.
+     */
+    collectionId: string;
+}

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

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

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

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

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

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

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

@@ -1,3 +1,4 @@
+import { IGenerativeAISearchCreateJobParameters } from '../jobs/search/GenerativeAISearchCreateJobParameters';
 import { IGenerativeAIDownloadDocumentCreateJobParameters } from '../jobs/download-document';
 import { IGenerativeAIPromptCreateJobParameters } from '../jobs/prompt';
 import { IGenerativeAIRatingCreateJobParameters } from '../jobs/rating';
@@ -5,4 +6,4 @@ import { IGenerativeAIRatingCreateJobParameters } from '../jobs/rating';
  * Represents the parameters of an AI job.
  * @category AI
  */
-export type CreateAIJobParameters = IGenerativeAIPromptCreateJobParameters | IGenerativeAIRatingCreateJobParameters | IGenerativeAIDownloadDocumentCreateJobParameters;
+export type CreateAIJobParameters = IGenerativeAIPromptCreateJobParameters | IGenerativeAIRatingCreateJobParameters | IGenerativeAIDownloadDocumentCreateJobParameters | IGenerativeAISearchCreateJobParameters;

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

@@ -1,3 +1,4 @@
+import { IGenerativeAISearchJob } from '../jobs/search/GenerativeAISearchJob';
 import { IGenerativeAIDownloadDocumentJob } from '../jobs/download-document';
 import { IGenerativeAIPromptJob } from '../jobs/prompt';
 import { IGenerativeAIRatingJob } from '../jobs/rating';
@@ -5,4 +6,4 @@ import { IGenerativeAIRatingJob } from '../jobs/rating';
  * Represents a Generative AI job.
  * @category AI
  */
-export type GenerativeAIJob = IGenerativeAIPromptJob | IGenerativeAIRatingJob | IGenerativeAIDownloadDocumentJob;
+export type GenerativeAIJob = IGenerativeAIPromptJob | IGenerativeAIRatingJob | IGenerativeAIDownloadDocumentJob | IGenerativeAISearchJob;

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

@@ -1,3 +1,4 @@
+import { IGenerativeAISearchWorkerParameters } from '../jobs/search';
 import { IGenerativeAIDownloadDocumentWorkerParameters } from '../jobs/download-document';
 import { IGenerativeAIPromptWorkerParameters } from '../jobs/prompt';
 import { IGenerativeAIRatingWorkerParameters } from '../jobs/rating';
@@ -5,4 +6,4 @@ import { IGenerativeAIRatingWorkerParameters } from '../jobs/rating';
  * Union type for AI job worker parameters.
  * @category AI
  */
-export type GenerativeAIWorkerParameters = IGenerativeAIPromptWorkerParameters | IGenerativeAIRatingWorkerParameters | IGenerativeAIDownloadDocumentWorkerParameters;
+export type GenerativeAIWorkerParameters = IGenerativeAIPromptWorkerParameters | IGenerativeAIRatingWorkerParameters | IGenerativeAIDownloadDocumentWorkerParameters | IGenerativeAISearchWorkerParameters;

package/dist/vector-database/VectorDatabase.d.ts

@@ -19,13 +19,14 @@ export interface IVectorDatabase extends IDataStream {
     close(): void;
     /**
      * Search for the k nearest vectors.
+     * @param keywords The keywords to search for.
      * @param vector The vector to search for.
      * @param k The number of nearest vectors to return.
      * @param minRelevance The minimum relevance of the vectors (default 0).
      * @param contentSize The size of the content to return (content +/- contentSize, default 0).
      * @returns An array of search results.
      */
-    search(vector: number[], k: number, minRelevance?: number, contentSize?: number): ISearchResult[];
+    search(keywords: string[], vector: number[], k: number, minRelevance?: number, contentSize?: number): ISearchResult[];
     /**
      * Insert vectors into the database.
      * @param name The name of the content.

package/dist/vector-database/VectorDatabaseConnector.d.ts

@@ -6,13 +6,14 @@ import { IIndex, ISearchResult } from '../generative-ai';
 export interface IVectorDatabaseConnector {
     /**
      * Search for the k nearest vectors.
+     * @param keywords The keywords to search for.
      * @param vector The vector to search for.
      * @param k The number of nearest vectors to return.
      * @param minRelevance The minimum relevance of the vectors (default 0).
      * @param contentSize The size of the content to return (content +/- contentSize, default 0).
      * @returns An array of search results.
      */
-    search(vector: number[], k: number, minRelevance?: number, contentSize?: number): ISearchResult[];
+    search(keywords: string[], vector: number[], k: number, minRelevance?: number, contentSize?: number): ISearchResult[];
     /**
      * Insert vectors into the database.
      * @param name The name of the content.

package/package.json

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