@crewdle/web-sdk-types 1.0.15 → 1.0.16

package/dist/ai/GenerativeAI.d.ts

@@ -27,6 +27,11 @@ export interface IPromptHistory {
      */
     message: string;
 }
+/**
+ * The AI prompt options Interface
+ * Represents the options for an AI prompt.
+ * @ignore
+ */
 export interface IPromptOptions {
     /**
      * The instructions for the AI job.
@@ -39,37 +44,38 @@ export interface IPromptOptions {
     /**
      * The context for the AI job.
      */
-    context?: IPromptHistory[];
-}
-/**
- * The AI job parameters Interface
- * Parameters for AI job type.
- * @ignore
- */
-export interface IJobParametersAI extends IJobParameters {
+    history?: IPromptHistory[];
     /**
-     * The prompt for the AI job.
+     * The maximum number of tokens to generate.
      */
-    prompt: string;
+    maxTokens?: number;
     /**
-     * The instructions for the AI job.
+     * The temperature for the LLM.
      */
-    instructions?: string;
+    temperature?: number;
     /**
-     * Whether to use RAG for the AI job.
+     * The maximum number of contents to include in the context.
      */
-    useRAG?: boolean;
+    maxContents?: number;
     /**
-     * The context for the AI job.
+     * The number of chunks to include in one content.
+     */
+    maxChunks?: number;
+    /**
+     * The starting index of the RAG for search.
+     */
+    ragStartingIndex?: number;
+    /**
+     * The minimum relevance of the RAG contents.
      */
-    context?: IPromptHistory[];
+    minRelevance?: number;
 }
 /**
- * The AI job result Interface
- * Represents the result of an AI job.
+ * The AI prompt result Interface
+ * Represents the result of an AI prompt.
  * @ignore
  */
-export interface IJobResultAI extends IJobResult {
+export interface IPromptResult {
     /**
      * The output of the AI job.
      */
@@ -82,6 +88,28 @@ export interface IJobResultAI extends IJobResult {
      * The tokens generated by the AI job.
      */
     outputTokens?: number;
+    /**
+     * The number of contents in the RAG.
+     */
+    contentSize?: number;
+}
+/**
+ * The AI job parameters Interface
+ * Parameters for AI job type.
+ * @ignore
+ */
+export interface IJobParametersAI extends IJobParameters, IPromptOptions {
+    /**
+     * The prompt for the AI job.
+     */
+    prompt: string;
+}
+/**
+ * The AI job result Interface
+ * Represents the result of an AI job.
+ * @ignore
+ */
+export interface IJobResultAI extends IJobResult, IPromptResult {
     /**
      * The index of the output, in case of partial results.
      */

package/dist/ai/GenerativeAIContext.d.ts

@@ -1,4 +1,4 @@
-import { IPromptOptions } from '.';
+import { IPromptOptions, IPromptResult } from '.';
 /**
  * Represents a context for a Generative AI service.
  * @category AI
@@ -9,13 +9,13 @@ export interface IGenerativeAIContext {
      * @param prompt The prompt to start processing.
      * @returns An async generator that yields the response.
      */
-    stream(prompt: string, options?: IPromptOptions): AsyncGenerator<string>;
+    stream(prompt: string, options?: IPromptOptions): AsyncGenerator<IPromptResult>;
     /**
      * Process the response from the AI service.
      * @param prompt The prompt to start processing.
      * @returns A promise that resolves with the response.
      */
-    prompt(prompt: string, options?: IPromptOptions): Promise<string>;
+    prompt(prompt: string, options?: IPromptOptions): Promise<IPromptResult>;
     /**
      * Close the Generative AI Context.
      */

package/dist/ai/VectorDatabaseConnector.d.ts

@@ -7,8 +7,11 @@ export interface IVectorDatabaseConnector {
      * Search for the k nearest vectors.
      * @param vector The vector to search for.
      * @param k The number of nearest vectors to return.
+     * @param minRelevance The minimum relevance of the vectors.
+     * @param startingIndex The starting index of the vectors.
+     * @returns The labels of the k nearest vectors.
      */
-    search(vector: number[], k: number): number[];
+    search(vector: number[], k: number, minRelevance?: number, startingIndex?: number): number[];
     /**
      * Insert vectors into the database.
      * @param vectors The vectors to insert.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@crewdle/web-sdk-types",
-  "version": "1.0.15",
+  "version": "1.0.16",
   "description": "The Crewdle Mist Web SDK public types and interfaces",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -23,7 +23,7 @@
   "dependencies": {
   },
   "devDependencies": {
-    "typescript": "^5.4.3"
+    "typescript": "^5.5.2"
   },
   "files": [
     "dist/"