@crewdle/web-sdk-types 1.0.19 → 1.0.21

package/dist/ai/GenerativeAI.d.ts

@@ -1,4 +1,3 @@
-import { IVectorDatabaseSearchResult } from '../vector-database';
 import { IJobParameters, IJobResult } from '../job';
 /**
  * The AI prompt source Enum
@@ -29,6 +28,37 @@ export interface IPromptHistory {
      */
     message: string;
 }
+/**
+ * The AI prompt function parameters Interface
+ * Represents the parameters for a prompt function.
+ * @category AI
+ */
+export interface IPromptFunctionParams {
+    [key: string]: {
+        type: 'string' | 'number' | 'boolean';
+    };
+}
+/**
+ * The AI prompt function Interface
+ * Represents a function that can be called by the LLM.
+ * @category AI
+ */
+export interface IPromptFunction {
+    /**
+     * The function description.
+     */
+    description: string;
+    /**
+     * The function parameters.
+     */
+    params?: IPromptFunctionParams;
+    /**
+     * The function callback.
+     */
+    callback: (params?: {
+        [key: string]: string | number | boolean;
+    }) => string | Promise<string>;
+}
 /**
  * The AI prompt options Interface
  * Represents the options for an AI prompt.
@@ -51,6 +81,10 @@ export interface IPromptOptions {
      * The temperature for the LLM.
      */
     temperature?: number;
+    /**
+     * The functions that can be called by the LLM.
+     */
+    functions?: Map<string, IPromptFunction>;
 }
 /**
  * The AI prompt type text
@@ -73,7 +107,7 @@ export interface IPromptResult {
     /**
      * The relevant context used by the AI job.
      */
-    context?: IVectorDatabaseSearchResult[];
+    context?: ISearchResult[];
     /**
      * The tokens used by the AI job.
      */
@@ -105,3 +139,40 @@ export interface IJobResultAI extends IJobResult, IPromptResult {
      */
     index?: number;
 }
+/**
+ * Represents a search result.
+ * @category AI
+ */
+export interface ISearchResult {
+    /**
+     * The content of the search result.
+     */
+    content: string;
+    /**
+     * The relevance of the search result.
+     * The relevance is a number between 0 and 1, where 1 is the most relevant.
+     */
+    relevance: number;
+    /**
+     * The path name of the document containing the search result.
+     */
+    pathName: string;
+}
+/**
+ * Represents a content index.
+ * @category AI
+ */
+export interface IIndex {
+    /**
+     * The content of the index.
+     */
+    content: string;
+    /**
+     * The start index of the content.
+     */
+    start: number;
+    /**
+     * The length of the content.
+     */
+    length: number;
+}

package/dist/ai/GenerativeAIWorkerConnector.d.ts

@@ -5,7 +5,9 @@ import { IJobParametersAI, IJobResultAI } from './GenerativeAI';
  * @category AI
  */
 export declare enum GenerativeAIModelInputType {
-    Text = "text"
+    Text = "text",
+    Audio = "audio",
+    Image = "image"
 }
 /**
  * The generative AI model output types.
@@ -13,7 +15,51 @@ export declare enum GenerativeAIModelInputType {
  */
 export declare enum GenerativeAIModelOutputType {
     Text = "text",
-    Vector = "vector"
+    Audio = "audio",
+    Image = "image",
+    Vector = "vector",
+    Entity = "entity"
+}
+/**
+ * The generative AI task types.
+ * @category AI
+ */
+export declare enum GenerativeAITaskType {
+    TextGeneration = "text-generation",
+    Embeddings = "embeddings",
+    FillMask = "fill-mask",
+    QuestionAnswering = "question-answering",
+    SentenceSimilarity = "sentence-similarity",
+    Summarization = "summarization",
+    TextClassification = "text-classification",
+    SentimentAnalysis = "sentiment-analysis",
+    TokenClassification = "token-classification",
+    NamedEntityRecognition = "ner",
+    Translation = "translation",
+    ZeroShotClassification = "zero-shot-classification",
+    FeatureExtraction = "feature-extraction",
+    DepthEstimation = "depth-estimation",
+    ImageClassification = "image-classification",
+    ImageSegmentation = "image-segmentation",
+    ImageToImage = "image-to-image",
+    ObjectDetection = "object-detection",
+    ImageFeatureExtraction = "image-feature-extraction",
+    AudioClassification = "audio-classification",
+    AutomaticSpeechRecognition = "automatic-speech-recognition",
+    TextToSpeech = "text-to-speech",
+    DocumentQuestionAnswering = "document-question-answering",
+    ImageToText = "image-to-text",
+    ZeroShotAudioClassification = "zero-shot-audio-classification",
+    ZeroShotImageClassification = "zero-shot-image-classification",
+    ZeroShotObjectDetection = "zero-shot-object-detection"
+}
+/**
+ * The generative AI engine types.
+ * @category AI
+ */
+export declare enum GenerativeAIEngineType {
+    Llamacpp = "llamacpp",
+    Transformers = "transformers"
 }
 /**
  * The generative AI model interface.
@@ -21,9 +67,12 @@ export declare enum GenerativeAIModelOutputType {
  */
 export interface IGenerativeAIModel {
     id: string;
+    engineType: GenerativeAIEngineType;
+    taskType: GenerativeAITaskType;
     inputType: GenerativeAIModelInputType;
     outputType: GenerativeAIModelOutputType;
     sourceUrl: string;
+    pathName?: string;
 }
 /**
  * The generative AI worker options.
@@ -43,12 +92,17 @@ export interface IGenerativeAIWorkerConnector extends IJobWorkerConnector<IJobPa
      * @param models A map of model IDs and pathnames.
      * @returns A promise that resolves when the model has been initialized.
      */
-    initialize(workflowId: string, models: Map<string, string>): Promise<void>;
+    initialize(workflowId: string, models: Map<string, IGenerativeAIModel>): Promise<void>;
     /**
      * Close the machine learning model.
      * @returns A promise that resolves when the model has been closed.
      */
     close(): Promise<void>;
+    /**
+     * Get the engine type.
+     * @returns The engine type.
+     */
+    getEngineType(): GenerativeAIEngineType;
     /**
      * Process a job.
      * @param parameters The job parameters.

package/dist/ai/GenerativeAIWorkerConnector.js

@@ -5,6 +5,8 @@
 export var GenerativeAIModelInputType;
 (function (GenerativeAIModelInputType) {
     GenerativeAIModelInputType["Text"] = "text";
+    GenerativeAIModelInputType["Audio"] = "audio";
+    GenerativeAIModelInputType["Image"] = "image";
 })(GenerativeAIModelInputType || (GenerativeAIModelInputType = {}));
 /**
  * The generative AI model output types.
@@ -13,5 +15,51 @@ export var GenerativeAIModelInputType;
 export var GenerativeAIModelOutputType;
 (function (GenerativeAIModelOutputType) {
     GenerativeAIModelOutputType["Text"] = "text";
+    GenerativeAIModelOutputType["Audio"] = "audio";
+    GenerativeAIModelOutputType["Image"] = "image";
     GenerativeAIModelOutputType["Vector"] = "vector";
+    GenerativeAIModelOutputType["Entity"] = "entity";
 })(GenerativeAIModelOutputType || (GenerativeAIModelOutputType = {}));
+/**
+ * The generative AI task types.
+ * @category AI
+ */
+export var GenerativeAITaskType;
+(function (GenerativeAITaskType) {
+    GenerativeAITaskType["TextGeneration"] = "text-generation";
+    GenerativeAITaskType["Embeddings"] = "embeddings";
+    GenerativeAITaskType["FillMask"] = "fill-mask";
+    GenerativeAITaskType["QuestionAnswering"] = "question-answering";
+    GenerativeAITaskType["SentenceSimilarity"] = "sentence-similarity";
+    GenerativeAITaskType["Summarization"] = "summarization";
+    GenerativeAITaskType["TextClassification"] = "text-classification";
+    GenerativeAITaskType["SentimentAnalysis"] = "sentiment-analysis";
+    GenerativeAITaskType["TokenClassification"] = "token-classification";
+    GenerativeAITaskType["NamedEntityRecognition"] = "ner";
+    GenerativeAITaskType["Translation"] = "translation";
+    GenerativeAITaskType["ZeroShotClassification"] = "zero-shot-classification";
+    GenerativeAITaskType["FeatureExtraction"] = "feature-extraction";
+    GenerativeAITaskType["DepthEstimation"] = "depth-estimation";
+    GenerativeAITaskType["ImageClassification"] = "image-classification";
+    GenerativeAITaskType["ImageSegmentation"] = "image-segmentation";
+    GenerativeAITaskType["ImageToImage"] = "image-to-image";
+    GenerativeAITaskType["ObjectDetection"] = "object-detection";
+    GenerativeAITaskType["ImageFeatureExtraction"] = "image-feature-extraction";
+    GenerativeAITaskType["AudioClassification"] = "audio-classification";
+    GenerativeAITaskType["AutomaticSpeechRecognition"] = "automatic-speech-recognition";
+    GenerativeAITaskType["TextToSpeech"] = "text-to-speech";
+    GenerativeAITaskType["DocumentQuestionAnswering"] = "document-question-answering";
+    GenerativeAITaskType["ImageToText"] = "image-to-text";
+    GenerativeAITaskType["ZeroShotAudioClassification"] = "zero-shot-audio-classification";
+    GenerativeAITaskType["ZeroShotImageClassification"] = "zero-shot-image-classification";
+    GenerativeAITaskType["ZeroShotObjectDetection"] = "zero-shot-object-detection";
+})(GenerativeAITaskType || (GenerativeAITaskType = {}));
+/**
+ * The generative AI engine types.
+ * @category AI
+ */
+export var GenerativeAIEngineType;
+(function (GenerativeAIEngineType) {
+    GenerativeAIEngineType["Llamacpp"] = "llamacpp";
+    GenerativeAIEngineType["Transformers"] = "transformers";
+})(GenerativeAIEngineType || (GenerativeAIEngineType = {}));

package/dist/ai/NLPLibraryConnector.d.ts

@@ -1,3 +1,17 @@
+/**
+ * Represents the types of entities that can be extracted.
+ * @category AI
+ */
+export interface INLPEntityTypes {
+    ner: boolean;
+    noun: boolean;
+    propn: boolean;
+    verb: boolean;
+}
+/**
+ * Represents a natural language processing library connector.
+ * @category Connector
+ */
 export interface INLPLibraryConnector {
     /**
      * Splits the text into sentences.
@@ -8,7 +22,15 @@ export interface INLPLibraryConnector {
     /**
      * Extracts the entities from the text.
      * @param text The text to extract from.
+     * @param types The types of entities to extract.
      * @returns A promise that resolves with the entities.
      */
-    getEntities(text: string): Promise<string[]>;
+    getEntities(text: string, types: INLPEntityTypes): Promise<string[]>;
+    /**
+     * Extracts the similarity between two texts.
+     * @param text1 The first text.
+     * @param text2 The second text.
+     * @returns A promise that resolves with the similarity between the texts. The value is between 0 and 1.
+     */
+    getSimilarity(text1: string, text2: string): Promise<number>;
 }

package/dist/ai/NLPLibraryConnectorConstructor.d.ts

@@ -1,2 +1,6 @@
 import { INLPLibraryConnector } from './NLPLibraryConnector';
+/**
+ * Represents a natural language processing library connector constructor.
+ * @category AI
+ */
 export type NLPLibraryConnectorConstructor = new () => INLPLibraryConnector;

package/dist/ai/SearchConnector.d.ts

@@ -0,0 +1,32 @@
+/**
+ * Represents a search result.
+ * @category AI
+ */
+export interface ISearchConnectorResult {
+    /**
+     * The title of the search result.
+     */
+    title: string;
+    /**
+     * The snippet of the search result.
+     */
+    snippet: string;
+    /**
+     * The URL of the search result.
+     */
+    url: string;
+}
+/**
+ * Represents a search connector.
+ * @category Connector
+ */
+export interface ISearchConnector {
+    /**
+     * Searches for the query.
+     * @param query The query to search for.
+     * @param apiKey The API key to use for the search.
+     * @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[]>;
+}

package/dist/ai/SearchConnectorConstructor.d.ts

@@ -0,0 +1,6 @@
+import { ISearchConnector } from './SearchConnector';
+/**
+ * Represents a search connector constructor.
+ * @category AI
+ */
+export type SearchConnectorConstructor = new () => ISearchConnector;

package/dist/ai/SearchConnectorConstructor.js

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

package/dist/ai/index.d.ts

@@ -5,3 +5,5 @@ export * from './GenerativeAIWorkerConnector';
 export * from './GenerativeAIWorkerConnectorConstructor';
 export * from './NLPLibraryConnector';
 export * from './NLPLibraryConnectorConstructor';
+export * from './SearchConnector';
+export * from './SearchConnectorConstructor';

package/dist/ai/index.js

@@ -5,3 +5,5 @@ export * from './GenerativeAIWorkerConnector';
 export * from './GenerativeAIWorkerConnectorConstructor';
 export * from './NLPLibraryConnector';
 export * from './NLPLibraryConnectorConstructor';
+export * from './SearchConnector';
+export * from './SearchConnectorConstructor';

package/dist/core/node/agent/AgentCapacity.d.ts

@@ -50,6 +50,19 @@ export interface IAgentCapacity {
          */
         available: number;
     };
+    /**
+     * The agent's VRAM capacity.
+     */
+    vram: {
+        /**
+         * The total VRAM available.
+         */
+        total: number;
+        /**
+         * The available VRAM.
+         */
+        available: number;
+    };
     /**
      * The agent's storage capacity.
      */

package/dist/core/sdk/SDKOptions.d.ts

@@ -2,7 +2,7 @@ import { KeyValueDatabaseConnectorConstructor } from '../../key-value-database';
 import { ILoggingConnector } from '.';
 import { DocumentParserConnectorConstructor, ObjectStoreConnectorConstructor } from '../../object-storage';
 import { PeerConnectionConnectorConstructor } from '../connection';
-import { GenerativeAIWorkerConnectorConstructor, NLPLibraryConnectorConstructor } from '../../ai';
+import { GenerativeAIWorkerConnectorConstructor, NLPLibraryConnectorConstructor, SearchConnectorConstructor } from '../../ai';
 import { VectorDatabaseConnectorConstructor } from '../../vector-database';
 import { GraphDatabaseConnectorConstructor } from '../../graph-database';
 /**
@@ -32,15 +32,19 @@ export interface ISDKOptions {
      * If not provided, the default key-value database connector is IndexedDB.
      */
     keyValueDatabaseConnector?: KeyValueDatabaseConnectorConstructor;
+    /**
+     * The custom logging database connector to use for storing Job logs.
+     */
+    loggingDatabaseConnector?: KeyValueDatabaseConnectorConstructor;
     /**
      * The custom peer connection connector to use for creating peer connections.
      * If not provided, the default peer connection connector is WebRTC in browser.
      */
     peerConnectionConnector?: PeerConnectionConnectorConstructor;
     /**
-     * The custom generative AI worker connector to use for generative AI tasks.
+     * The custom generative AI worker connectors to use for generative AI tasks.
      */
-    generativeAIWorkerConnector?: GenerativeAIWorkerConnectorConstructor;
+    generativeAIWorkerConnectors?: GenerativeAIWorkerConnectorConstructor[];
     /**
      * The custom vector database connector to use for vector database tasks.
      */
@@ -57,6 +61,10 @@ export interface ISDKOptions {
      * The custom natural language processing connector to use for natural language processing tasks.
      */
     nlpLibraryConnector?: NLPLibraryConnectorConstructor;
+    /**
+     * The custom search connector to use for searching the web.
+     */
+    searchConnector?: SearchConnectorConstructor;
     /**
      * The maximum number of outgoing subscriptions.
      */

package/dist/graph-database/GraphDatabase.d.ts

@@ -1,3 +1,4 @@
+import { IIndex } from '../ai';
 import { IDataStream } from '../core';
 /**
  * The interface for the graph database.
@@ -18,9 +19,12 @@ export interface IGraphDatabase extends IDataStream {
     close(): void;
     /**
      * Add a node to the database.
+     * @param name The name of the content.
+     * @param content The content.
+     * @param index The index of the node.
      * @param node The node to add.
      */
-    addNode(node: string): void;
+    addNode(name: string, content: string, index: IIndex[], node: string): void;
     /**
      * Add an edge to the database.
      * @param from The node to add the edge from.
@@ -28,8 +32,13 @@ export interface IGraphDatabase extends IDataStream {
      */
     addEdge(from: string, to: string): void;
     /**
-     * Get the neighbors of a node.
-     * @param node The node to get the neighbors of.
+     * Get the content of the nodes and their neighbors.
+     * @param nodes The nodes to get the content of.
+     * @param maxDepth The maximum depth to search (default 1).
+     * @param contentSize The size of the content to return (content +/- contentSize, default 0).
+     * @returns The content of the nodes and their neighbors.
      */
-    getNeighbors(node: string): string[];
+    getContent(nodes: string[], maxDepth?: number, contentSize?: number): {
+        [key: string]: string[];
+    };
 }

package/dist/graph-database/GraphDatabaseConnector.d.ts

@@ -1,3 +1,4 @@
+import { IIndex } from '../ai';
 /**
  * The graph database connector interface.
  * @category Connector
@@ -5,9 +6,12 @@
 export interface IGraphDatabaseConnector {
     /**
      * Add a node to the database.
+     * @param name The name of the content.
+     * @param content The content.
+     * @param index The index of the node.
      * @param node The node to add.
      */
-    addNode(node: string): void;
+    addNode(name: string, content: string, index: IIndex[], node: string): void;
     /**
      * Add an edge to the database.
      * @param from The node to add the edge from.
@@ -15,10 +19,15 @@ export interface IGraphDatabaseConnector {
      */
     addEdge(from: string, to: string): void;
     /**
-     * Get the neighbors of a node.
-     * @param node The node to get the neighbors of.
+     * Get the content of the nodes and their neighbors.
+     * @param nodes The nodes to get the content of.
+     * @param maxDepth The maximum depth to search (default 1).
+     * @param contentSize The size of the content to return (content +/- contentSize, default 0).
+     * @returns The content of the nodes and their neighbors.
      */
-    getNeighbors(node: string): string[];
+    getContent(nodes: string[], maxDepth?: number, contentSize?: number): {
+        [key: string]: string[];
+    };
     /**
      * Get the size of the database
      * @returns The size of the database.

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

@@ -1,5 +1,5 @@
+import { IIndex, ISearchResult } from '../ai';
 import { IDataStream } from '../core';
-import { IVectorDatabaseSearchResult } from './VectorDatabaseSearchResult';
 /**
  * The interface for the vector database.
  * @category Vector Database
@@ -21,18 +21,19 @@ export interface IVectorDatabase extends IDataStream {
      * 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 contentSize The size of the content to return (vector +/- contentSize, default 0).
+     * @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): IVectorDatabaseSearchResult[];
+    search(vector: number[], k: number, minRelevance?: number, contentSize?: number): ISearchResult[];
     /**
      * Insert vectors into the database.
      * @param name The name of the content.
-     * @param content The content of the vectors.
+     * @param content The content.
+     * @param index The index of the vectors.
      * @param vectors The vectors to insert.
      */
-    insert(name: string, content: string[], vectors: number[][]): void;
+    insert(name: string, content: string, index: IIndex[], vectors: number[][]): void;
     /**
      * Remove vectors from the database.
      * @param name The name of the content.

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

@@ -1,4 +1,4 @@
-import { IVectorDatabaseSearchResult } from './VectorDatabaseSearchResult';
+import { IIndex, ISearchResult } from '../ai';
 /**
  * The vector database connector interface.
  * @category Connector
@@ -8,18 +8,19 @@ 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 contentSize The size of the content to return (vector +/- contentSize, default 0).
+     * @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): IVectorDatabaseSearchResult[];
+    search(vector: number[], k: number, minRelevance?: number, contentSize?: number): ISearchResult[];
     /**
      * Insert vectors into the database.
      * @param name The name of the content.
-     * @param content The content of the vectors.
+     * @param content The content.
+     * @param index The index of the vectors.
      * @param vectors The vectors to insert.
      */
-    insert(name: string, content: string[], vectors: number[][]): void;
+    insert(name: string, content: string, index: IIndex[], vectors: number[][]): void;
     /**
      * Remove vectors from the database.
      * @param name The name of the content.

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

@@ -1,4 +1,3 @@
 export * from './VectorDatabase';
 export * from './VectorDatabaseConnector';
 export * from './VectorDatabaseConnectorConstructor';
-export * from './VectorDatabaseSearchResult';

package/dist/vector-database/index.js

@@ -1,4 +1,3 @@
 export * from './VectorDatabase';
 export * from './VectorDatabaseConnector';
 export * from './VectorDatabaseConnectorConstructor';
-export * from './VectorDatabaseSearchResult';

package/package.json

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

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

@@ -1,19 +0,0 @@
-/**
- * Represents a search result from the vector database.
- * @category Vector Database
- */
-export interface IVectorDatabaseSearchResult {
-    /**
-     * The content of the search result.
-     */
-    content: string;
-    /**
-     * The relevance of the search result.
-     * The relevance is a number between 0 and 1, where 1 is the most relevant.
-     */
-    relevance: number;
-    /**
-     * The path name of the document containing the search result.
-     */
-    pathName: string;
-}