@crewdle/web-sdk-types 1.0.16 → 1.0.18

package/dist/ai/GenerativeAI.d.ts

@@ -1,6 +1,8 @@
+import { IVectorDatabaseSearchResult } from '../vector-database';
 import { IJobParameters, IJobResult } from '../job';
 /**
  * The AI prompt source Enum
+ * @category AI
  */
 export declare enum PromptSource {
     /**
@@ -15,7 +17,7 @@ export declare enum PromptSource {
 /**
  * The AI prompt history Interface
  * Represents the history of a prompt.
- * @ignore
+ * @category AI
  */
 export interface IPromptHistory {
     /**
@@ -30,17 +32,13 @@ export interface IPromptHistory {
 /**
  * The AI prompt options Interface
  * Represents the options for an AI prompt.
- * @ignore
+ * @category AI
  */
 export interface IPromptOptions {
     /**
      * The instructions for the AI job.
      */
     instructions?: string;
-    /**
-     * Whether to use RAG for the AI job.
-     */
-    useRAG?: boolean;
     /**
      * The context for the AI job.
      */
@@ -53,33 +51,29 @@ export interface IPromptOptions {
      * The temperature for the LLM.
      */
     temperature?: number;
-    /**
-     * The maximum number of contents to include in the context.
-     */
-    maxContents?: number;
-    /**
-     * 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.
-     */
-    minRelevance?: number;
 }
+/**
+ * The AI prompt type text
+ */
+export type PromptTypeText = string | string[];
+/**
+ * The AI prompt type vector
+ */
+export type PromptTypeVector = number[];
 /**
  * The AI prompt result Interface
  * Represents the result of an AI prompt.
- * @ignore
+ * @category AI
  */
 export interface IPromptResult {
     /**
      * The output of the AI job.
      */
-    output: string;
+    output?: PromptTypeText | PromptTypeVector;
+    /**
+     * The relevant context used by the AI job.
+     */
+    context?: IVectorDatabaseSearchResult[];
     /**
      * The tokens used by the AI job.
      */
@@ -88,15 +82,11 @@ export interface IPromptResult {
      * 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
+ * @category AI
  */
 export interface IJobParametersAI extends IJobParameters, IPromptOptions {
     /**
@@ -107,7 +97,7 @@ export interface IJobParametersAI extends IJobParameters, IPromptOptions {
 /**
  * The AI job result Interface
  * Represents the result of an AI job.
- * @ignore
+ * @category AI
  */
 export interface IJobResultAI extends IJobResult, IPromptResult {
     /**

package/dist/ai/GenerativeAI.js

@@ -1,5 +1,6 @@
 /**
  * The AI prompt source Enum
+ * @category AI
  */
 export var PromptSource;
 (function (PromptSource) {

package/dist/ai/GenerativeAIContext.d.ts

@@ -7,15 +7,22 @@ export interface IGenerativeAIContext {
     /**
      * Stream the response from the AI service.
      * @param prompt The prompt to start processing.
+     * @param options Optional parameters for the prompt.
      * @returns An async generator that yields the response.
      */
     stream(prompt: string, options?: IPromptOptions): AsyncGenerator<IPromptResult>;
     /**
      * Process the response from the AI service.
      * @param prompt The prompt to start processing.
+     * @param options Optional parameters for the prompt.
      * @returns A promise that resolves with the response.
      */
     prompt(prompt: string, options?: IPromptOptions): Promise<IPromptResult>;
+    /**
+     * Get the data bucket IDs.
+     * @returns An array of data bucket IDs.
+     */
+    getDataBucketIds(): Promise<string[]>;
     /**
      * Close the Generative AI Context.
      */

package/dist/ai/GenerativeAIWorkerConnector.d.ts

@@ -1,5 +1,37 @@
-import { IJobRequest, IJobWorkerConnector, JobResponse } from '../job';
+import { IJobWorkerConnector, IJobWorkerOptions } from '../job';
 import { IJobParametersAI, IJobResultAI } from './GenerativeAI';
+/**
+ * The generative AI model input types.
+ * @category AI
+ */
+export declare enum GenerativeAIModelInputType {
+    Text = "text"
+}
+/**
+ * The generative AI model output types.
+ * @category AI
+ */
+export declare enum GenerativeAIModelOutputType {
+    Text = "text",
+    Vector = "vector"
+}
+/**
+ * The generative AI model interface.
+ * @category AI
+ */
+export interface IGenerativeAIModel {
+    id: string;
+    inputType: GenerativeAIModelInputType;
+    outputType: GenerativeAIModelOutputType;
+    sourceUrl: string;
+}
+/**
+ * The generative AI worker options.
+ * @category AI
+ */
+export interface IGenerativeAIWorkerOptions extends IJobWorkerOptions {
+    model: IGenerativeAIModel;
+}
 /**
  * The generative AI worker connector interface.
  * @category Connector
@@ -7,33 +39,28 @@ import { IJobParametersAI, IJobResultAI } from './GenerativeAI';
 export interface IGenerativeAIWorkerConnector extends IJobWorkerConnector<IJobParametersAI, IJobResultAI> {
     /**
      * Initialize the machine learning model.
-     * @param llmModel The path to the LLM model.
-     * @param similarityModel The path to the similarity model.
+     * @param workflowId The workflow ID.
+     * @param models A map of model IDs and pathnames.
      * @returns A promise that resolves when the model has been initialized.
      */
-    initialize(llmModel?: string, similarityModel?: string): Promise<void>;
-    /**
-     * Add content to the machine learning model.
-     * @param name The name of the content.
-     * @param content The content to add.
-     * @returns A promise that resolves when the content has been added.
-     */
-    addContent(name: string, content: string): Promise<void>;
+    initialize(workflowId: string, models: Map<string, string>): Promise<void>;
     /**
-     * Remove content from the machine learning model.
-     * @param name The name of the content.
+     * Close the machine learning model.
+     * @returns A promise that resolves when the model has been closed.
      */
-    removeContent(name: string): void;
+    close(): Promise<void>;
     /**
      * Process a job.
-     * @param job The job to process.
+     * @param parameters The job parameters.
+     * @param options The job options.
      * @returns A promise that resolves with the job result.
      */
-    processJob(job: IJobRequest<IJobParametersAI>): Promise<JobResponse<IJobResultAI>>;
+    processJob(parameters: IJobParametersAI, options?: IGenerativeAIWorkerOptions): Promise<IJobResultAI>;
     /**
      * Stream a job.
-     * @param job The job to stream.
+     * @param parameters The job parameters.
+     * @param options The job options.
      * @returns An async generator that yields the job result.
      */
-    processJobStream(job: IJobRequest<IJobParametersAI>): AsyncGenerator<JobResponse<IJobResultAI>>;
+    processJobStream(parameters: IJobParametersAI, options?: IGenerativeAIWorkerOptions): AsyncGenerator<IJobResultAI>;
 }

package/dist/ai/GenerativeAIWorkerConnector.js

@@ -1 +1,17 @@
-export {};
+/**
+ * The generative AI model input types.
+ * @category AI
+ */
+export var GenerativeAIModelInputType;
+(function (GenerativeAIModelInputType) {
+    GenerativeAIModelInputType["Text"] = "text";
+})(GenerativeAIModelInputType || (GenerativeAIModelInputType = {}));
+/**
+ * The generative AI model output types.
+ * @category AI
+ */
+export var GenerativeAIModelOutputType;
+(function (GenerativeAIModelOutputType) {
+    GenerativeAIModelOutputType["Text"] = "text";
+    GenerativeAIModelOutputType["Vector"] = "vector";
+})(GenerativeAIModelOutputType || (GenerativeAIModelOutputType = {}));

package/dist/ai/GenerativeAIWorkerConnectorConstructor.d.ts

@@ -1,6 +1,6 @@
-import { IGenerativeAIWorkerConnector, VectorDatabaseConnectorConstructor } from '.';
+import { IGenerativeAIWorkerConnector } from '.';
 /**
  * The generative AI worker connector constructor type.
  * @category AI
  */
-export type GenerativeAIWorkerConnectorConstructor = new (vectorDatabaseConnector: VectorDatabaseConnectorConstructor) => IGenerativeAIWorkerConnector;
+export type GenerativeAIWorkerConnectorConstructor = new () => IGenerativeAIWorkerConnector;

package/dist/ai/NLPLibraryConnector.d.ts

@@ -0,0 +1,14 @@
+export interface INLPLibraryConnector {
+    /**
+     * Splits the text into sentences.
+     * @param text The text to split.
+     * @returns A promise that resolves with the sentences.
+     */
+    getSentences(text: string): Promise<string[]>;
+    /**
+     * Extracts the entities from the text.
+     * @param text The text to extract from.
+     * @returns A promise that resolves with the entities.
+     */
+    getEntities(text: string): Promise<string[]>;
+}

package/dist/ai/NLPLibraryConnectorConstructor.d.ts

@@ -0,0 +1,2 @@
+import { INLPLibraryConnector } from './NLPLibraryConnector';
+export type NLPLibraryConnectorConstructor = new () => INLPLibraryConnector;

package/dist/ai/index.d.ts

@@ -3,5 +3,5 @@ export * from './GenerativeAIContext';
 export * from './GenerativeAIWorker';
 export * from './GenerativeAIWorkerConnector';
 export * from './GenerativeAIWorkerConnectorConstructor';
-export * from './VectorDatabaseConnector';
-export * from './VectorDatabaseConnectorConstructor';
+export * from './NLPLibraryConnector';
+export * from './NLPLibraryConnectorConstructor';

package/dist/ai/index.js

@@ -3,5 +3,5 @@ export * from './GenerativeAIContext';
 export * from './GenerativeAIWorker';
 export * from './GenerativeAIWorkerConnector';
 export * from './GenerativeAIWorkerConnectorConstructor';
-export * from './VectorDatabaseConnector';
-export * from './VectorDatabaseConnectorConstructor';
+export * from './NLPLibraryConnector';
+export * from './NLPLibraryConnectorConstructor';

package/dist/core/cluster/Cluster.d.ts

@@ -1,9 +1,11 @@
+import { IGraphDatabase } from '../../graph-database';
 import { IClusterEventEmitter } from '.';
 import { IGenerativeAIContext, IGenerativeAIWorker } from '../../ai';
 import { IKeyValueDatabase, IDatabaseLayout, ILayoutBuilder } from '../../key-value-database';
 import { ILocalMediaStream, ILocalDynamicMediaStream, IRemoteMediaStream, MediaStreamSource } from '../../media-stream';
 import { IObjectStoreBucket, IObjectStoreBucketOptions } from '../../object-storage';
 import { IPubSubTopic } from '../../pubsub';
+import { IVectorDatabase } from '../../vector-database';
 import { LocalNode, Node } from '../node';
 /**
  * The cluster interface.
@@ -25,7 +27,7 @@ export interface ICluster extends IClusterEventEmitter {
     /**
      * Open a object store bucket.
      * @param name The name of the Object Store bucket.
-     * @param syncContent Whether to sync the content of the object store.
+     * @param options The {@link IObjectStoreBucketOptions | options} of the Object Store bucket.
      * @throws {@link SDKClientErrorCodes.ObjectStoreAlreadyExists} if the data stream is already open.
      * @throws {@link SDKClientErrorCodes.ObjectStoreNameNotString} if the name is not a string.
      * @returns A promise that resolves with the data stream.
@@ -51,6 +53,16 @@ export interface ICluster extends IClusterEventEmitter {
      * @param label The label of the generative AI Worker.
      */
     openGenerativeAIWorker(label: string): Promise<IGenerativeAIWorker>;
+    /**
+     * Open a vector database.
+     * @param label The label of the vector database.
+     */
+    openVectorDatabase(label: string): IVectorDatabase;
+    /**
+     * Open a graph database.
+     * @param label The label of the graph database.
+     */
+    openGraphDatabase(label: string): IGraphDatabase;
     /**
      * Publish a local media stream.
      * @param label The label of the media stream.
@@ -102,6 +114,16 @@ export interface ICluster extends IClusterEventEmitter {
      * @param strategy The strategy to use to filter the media streams.
      */
     getRemoteMediaStreams(strategy?: (item: IRemoteMediaStream) => boolean): IRemoteMediaStream[];
+    /**
+     * Get an array of opened vector databases.
+     * @param strategy The strategy to use to filter the vector databases.
+     */
+    getVectorDatabases(strategy?: (item: IVectorDatabase) => boolean): IVectorDatabase[];
+    /**
+     * Get an array of opened graph databases.
+     * @param strategy The strategy to use to filter the graph databases.
+     */
+    getGraphDatabases(strategy?: (item: IGraphDatabase) => boolean): IGraphDatabase[];
     /**
      * Get the local node for this cluster.
      */

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

@@ -1,8 +1,10 @@
 import { KeyValueDatabaseConnectorConstructor } from '../../key-value-database';
 import { ILoggingConnector } from '.';
-import { ObjectStoreConnectorConstructor } from '../../object-storage';
+import { DocumentParserConnectorConstructor, ObjectStoreConnectorConstructor } from '../../object-storage';
 import { PeerConnectionConnectorConstructor } from '../connection';
-import { GenerativeAIWorkerConnectorConstructor, VectorDatabaseConnectorConstructor } from '../../ai';
+import { GenerativeAIWorkerConnectorConstructor, NLPLibraryConnectorConstructor } from '../../ai';
+import { VectorDatabaseConnectorConstructor } from '../../vector-database';
+import { GraphDatabaseConnectorConstructor } from '../../graph-database';
 /**
  * Options to configure the SDK.
  * @category Core
@@ -43,6 +45,18 @@ export interface ISDKOptions {
      * The custom vector database connector to use for vector database tasks.
      */
     vectorDatabaseConnector?: VectorDatabaseConnectorConstructor;
+    /**
+     * The custom graph database connector to use for graph database tasks.
+     */
+    graphDatabaseConnector?: GraphDatabaseConnectorConstructor;
+    /**
+     * The custom document parser connector to use for parsing documents.
+     */
+    documentParserConnector?: DocumentParserConnectorConstructor;
+    /**
+     * The custom natural language processing connector to use for natural language processing tasks.
+     */
+    nlpLibraryConnector?: NLPLibraryConnectorConstructor;
     /**
      * The maximum number of outgoing subscriptions.
      */

package/dist/core/stream/ContentType.d.ts

@@ -30,5 +30,13 @@ export declare enum ContentType {
     /**
      * @ignore
      */
-    Job = "job"
+    Job = "job",
+    /**
+     * @ignore
+     */
+    VectorDatabase = "vectordatabase",
+    /**
+     * @ignore
+     */
+    GraphDatabase = "graphdatabase"
 }

package/dist/core/stream/ContentType.js

@@ -33,4 +33,12 @@ export var ContentType;
      * @ignore
      */
     ContentType["Job"] = "job";
+    /**
+     * @ignore
+     */
+    ContentType["VectorDatabase"] = "vectordatabase";
+    /**
+     * @ignore
+     */
+    ContentType["GraphDatabase"] = "graphdatabase";
 })(ContentType || (ContentType = {}));

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

@@ -0,0 +1,35 @@
+import { IDataStream } from '../core';
+/**
+ * The interface for the graph database.
+ * @category Graph Database
+ */
+export interface IGraphDatabase extends IDataStream {
+    /**
+     * Get the name of the database.
+     */
+    getName(): string;
+    /**
+     * Get the owner ID of the database.
+     */
+    getOwnerId(): string;
+    /**
+     * Close the database.
+     */
+    close(): void;
+    /**
+     * Add a node to the database.
+     * @param node The node to add.
+     */
+    addNode(node: string): void;
+    /**
+     * Add an edge to the database.
+     * @param from The node to add the edge from.
+     * @param to The node to add the edge to.
+     */
+    addEdge(from: string, to: string): void;
+    /**
+     * Get the neighbors of a node.
+     * @param node The node to get the neighbors of.
+     */
+    getNeighbors(node: string): string[];
+}

package/dist/graph-database/GraphDatabase.js

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

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

@@ -0,0 +1,27 @@
+/**
+ * The graph database connector interface.
+ * @category Connector
+ */
+export interface IGraphDatabaseConnector {
+    /**
+     * Add a node to the database.
+     * @param node The node to add.
+     */
+    addNode(node: string): void;
+    /**
+     * Add an edge to the database.
+     * @param from The node to add the edge from.
+     * @param to The node to add the edge to.
+     */
+    addEdge(from: string, to: string): void;
+    /**
+     * Get the neighbors of a node.
+     * @param node The node to get the neighbors of.
+     */
+    getNeighbors(node: string): string[];
+    /**
+     * Get the size of the database
+     * @returns The size of the database.
+     */
+    getSize(): number;
+}

package/dist/graph-database/GraphDatabaseConnector.js

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

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

@@ -0,0 +1,6 @@
+import { IGraphDatabaseConnector } from './GraphDatabaseConnector';
+/**
+ * The graph database connector constructor type.
+ * @category Graph Database
+ */
+export type GraphDatabaseConnectorConstructor = new () => IGraphDatabaseConnector;

package/dist/graph-database/GraphDatabaseConnectorConstructor.js

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

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

@@ -0,0 +1,3 @@
+export * from './GraphDatabase';
+export * from './GraphDatabaseConnector';
+export * from './GraphDatabaseConnectorConstructor';

package/dist/graph-database/index.js

@@ -0,0 +1,3 @@
+export * from './GraphDatabase';
+export * from './GraphDatabaseConnector';
+export * from './GraphDatabaseConnectorConstructor';

package/dist/index.d.ts

@@ -5,3 +5,5 @@ export * from './object-storage';
 export * from './pubsub';
 export * from './job';
 export * from './ai';
+export * from './vector-database';
+export * from './graph-database';

package/dist/index.js

@@ -5,3 +5,5 @@ export * from './object-storage';
 export * from './pubsub';
 export * from './job';
 export * from './ai';
+export * from './vector-database';
+export * from './graph-database';

package/dist/job/Job.d.ts

@@ -1,14 +1,14 @@
 /**
  * Base IJobParameters Interface
  * Allows providing parameters specific to the job type.
- * @ignore
+ * @category Job
  */
 export interface IJobParameters {
 }
 /**
  * Job request Interface
  * Represents a job to be executed by the JobService.
- * @ignore
+ * @category Job
  */
 export interface IJobRequest<T extends IJobParameters> {
     /**
@@ -31,7 +31,7 @@ export interface IJobRequest<T extends IJobParameters> {
 /**
  * JobType Enum
  * Represents the type of a job.
- * @ignore
+ * @category Job
  */
 export declare enum JobType {
     /**
@@ -46,7 +46,7 @@ export declare enum JobType {
 /**
  * JobStatus Enum
  * Represents the status of a job.
- * @ignore
+ * @category Job
  */
 export declare enum JobStatus {
     /**
@@ -73,14 +73,14 @@ export declare enum JobStatus {
 /**
  * Base job result Interface
  * Represents the result of a job.
- * @ignore
+ * @category Job
  */
 export interface IJobResult {
 }
 /**
  * Job response Interface
  * Represents the response from a job.
- * @ignore
+ * @category Job
  */
 export interface IJobResultResponse<T extends IJobResult> {
     /**
@@ -99,7 +99,7 @@ export interface IJobResultResponse<T extends IJobResult> {
 /**
  * Job failed response Interface
  * Represents a failed job response.
- * @ignore
+ * @category Job
  */
 export interface IJobFailedResponse {
     /**
@@ -118,6 +118,6 @@ export interface IJobFailedResponse {
 /**
  * Job response type
  * Represents the response type from a job.
- * @ignore
+ * @category Job
  */
 export type JobResponse<T extends IJobResult> = IJobResultResponse<T> | IJobFailedResponse;

package/dist/job/Job.js

@@ -1,7 +1,7 @@
 /**
  * JobType Enum
  * Represents the type of a job.
- * @ignore
+ * @category Job
  */
 export var JobType;
 (function (JobType) {
@@ -17,7 +17,7 @@ export var JobType;
 /**
  * JobStatus Enum
  * Represents the status of a job.
- * @ignore
+ * @category Job
  */
 export var JobStatus;
 (function (JobStatus) {

package/dist/job/JobDispatcher.d.ts

@@ -3,7 +3,7 @@ import { IDataStream } from '../core/stream';
 import { IJobParameters, IJobRequest, IJobResult, JobResponse } from './Job';
 /**
  * The Job Dispatcher interface.
- * @ignore
+ * @category Job
  */
 export interface IJobDispatcher<T extends IJobParameters, U extends IJobResult> extends IDataStream {
     /**

package/dist/job/JobWorker.d.ts

@@ -1,6 +1,6 @@
 /**
  * The Job Worker interface.
- * @ignore
+ * @category Job
  */
 export interface IJobWorker {
     /**

package/dist/job/JobWorkerConnector.d.ts

@@ -1,17 +1,23 @@
-import { IJobParameters, IJobRequest, IJobResult, JobResponse } from './Job';
+import { IJobParameters, IJobResult } from './Job';
+export interface IJobWorkerOptions {
+}
 /**
  * The Job Worker Connector interface.
- * @ignore
+ * @category Connector
  */
 export interface IJobWorkerConnector<T extends IJobParameters, U extends IJobResult> {
     /**
      * Process a job.
-     * @param job The job to process.
+     * @param parameters The job parameters.
+     * @param options The job options.
+     * @returns A promise that resolves with the job result.
      */
-    processJob(job: IJobRequest<T>): Promise<JobResponse<U>>;
+    processJob(parameters: T, options?: IJobWorkerOptions): Promise<U>;
     /**
      * Process a job stream.
-     * @param job The job to process.
+     * @param parameters The job parameters.
+     * @param options The job options.
+     * @returns An async generator that yields job results.
      */
-    processJobStream(job: IJobRequest<T>): AsyncGenerator<JobResponse<U>>;
+    processJobStream(parameters: T, options?: IJobWorkerOptions): AsyncGenerator<U>;
 }

package/dist/object-storage/DocumentParserConnector.d.ts

@@ -0,0 +1,9 @@
+import { IFile } from './File';
+export interface IDocumentParserConnector {
+    /**
+     * Parses a document.
+     * @param file The file to parse.
+     * @returns A promise that resolves with the parsed document.
+     */
+    parse(file: IFile): Promise<string>;
+}

package/dist/object-storage/DocumentParserConnector.js

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

package/dist/object-storage/DocumentParserConnectorConstructor.d.ts

@@ -0,0 +1,2 @@
+import { IDocumentParserConnector } from './DocumentParserConnector';
+export type DocumentParserConnectorConstructor = new () => IDocumentParserConnector;

package/dist/object-storage/DocumentParserConnectorConstructor.js

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

package/dist/object-storage/File.d.ts

@@ -0,0 +1,43 @@
+import { IReadableStream } from './ReadableStream';
+/**
+ * Represents a file in the object storage.
+ * @category Object Storage
+ */
+export interface IFile {
+    /**
+     * The name of the file.
+     */
+    name: string;
+    /**
+     * The size of the file in bytes.
+     */
+    size: number;
+    /**
+     * The MIME type of the file.
+     */
+    type: string;
+    /**
+     * The last modified timestamp of the file.
+     */
+    lastModified: number;
+    /**
+     * Returns a promise that resolves to an ArrayBuffer containing the file's data.
+     */
+    arrayBuffer(): Promise<ArrayBuffer>;
+    /**
+     * Returns a promise that resolves to a string containing the file's data.
+     */
+    text(): Promise<string>;
+    /**
+     * Returns a readable stream for streaming the file's data.
+     */
+    stream(): IReadableStream;
+    /**
+     * Returns a new Blob object that contains a subset of the file's data.
+     * @param start - The start position (inclusive) of the subset. Defaults to 0.
+     * @param end - The end position (exclusive) of the subset. Defaults to the end of the file.
+     * @param contentType - The MIME type of the subset. Defaults to the original file's type.
+     * @returns A Blob object representing the subset of the file's data.
+     */
+    slice(start?: number, end?: number, contentType?: string): Blob;
+}

package/dist/object-storage/File.js

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

package/dist/object-storage/FileOptions.d.ts

@@ -0,0 +1,14 @@
+/**
+ * Represents the options for reading or writing a file.
+ * @category Object Storage
+ */
+export interface IFileOptions {
+    /**
+     * Specifies whether encryption should be skipped for the file.
+     */
+    skipEncryption?: boolean;
+    /**
+     * Specifies whether the file should be fetched from a URL.
+     */
+    fetchUrl?: string;
+}

package/dist/object-storage/FileOptions.js

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

package/dist/object-storage/FilePayload.d.ts

@@ -1,4 +1,4 @@
-import { PayloadAction } from '.';
+import { IFileOptions, PayloadAction } from '.';
 /**
  * The file payload interface.
  * @category Object Storage
@@ -19,5 +19,5 @@ export interface IFilePayload {
     /**
      * The flag to skip encryption.
      */
-    skipEncryption?: boolean;
+    options?: IFileOptions;
 }

package/dist/object-storage/FileStatus.d.ts

@@ -1,5 +1,6 @@
 /**
  * File status enum
+ * @category Object Storage
  */
 export declare enum FileStatus {
     /**

package/dist/object-storage/FileStatus.js

@@ -1,5 +1,6 @@
 /**
  * File status enum
+ * @category Object Storage
  */
 export var FileStatus;
 (function (FileStatus) {

package/dist/object-storage/ObjectStoreBucket.d.ts

@@ -1,5 +1,5 @@
 import { IDataStream } from '../core/stream';
-import { ObjectDescriptor, Payload } from '.';
+import { IFile, IFileOptions, ObjectDescriptor, Payload } from '.';
 import { StorageEvent } from './event';
 import { IObjectStoreListOptions } from './ObjectStoreListOptions';
 /**
@@ -21,13 +21,15 @@ export interface IObjectStoreBucket extends IDataStream {
     close(): void;
     /**
      * Subscribe to the bucket events.
+     * @param label The label of the subscriber.
      * @param callback The callback function.
      */
-    subscribe(callback: (data: StorageEvent) => void): void;
+    subscribe(label: string, callback: (data: StorageEvent) => void): void;
     /**
      * Unsubscribe from the bucket.
+     * @param label The label of the subscriber.
      */
-    unsubscribe(): void;
+    unsubscribe(label: string): void;
     /**
      * Publish an action to the bucket.
      * @param payload The object store payload.
@@ -43,9 +45,10 @@ export interface IObjectStoreBucket extends IDataStream {
     /**
      * Get an object from the bucket.
      * @param path The path of the object.
+     * @param options The optional options for getting the object.
      * @returns The object.
      */
-    get(path: string): Promise<File>;
+    get(path: string, options?: IFileOptions): Promise<IFile>;
     /**
      * List the objects and folders of the bucket.
      * @param path The path of the folder.

package/dist/object-storage/ObjectStoreConnector.d.ts

@@ -1,15 +1,16 @@
-import { IFileDescriptor, IFolderDescriptor, ObjectDescriptor, ObjectKind } from '.';
+import { IFileDescriptor, IFolderDescriptor, IWritableStream, ObjectDescriptor, ObjectKind, IFileOptions, IFile } from '.';
 /**
- * The object store connector interface.
+ * Represents a connector for interacting with an object store.
  * @category Connector
  */
 export interface IObjectStoreConnector {
     /**
      * Gets a file.
      * @param path The path to the file.
+     * @param options The options for writing the file.
      * @returns A promise that resolves with the file.
      */
-    get(path: string): Promise<File>;
+    get(path: string, options?: IFileOptions): Promise<IFile>;
     /**
      * Lists the objects in a folder.
      * @param path The path to the folder.
@@ -27,10 +28,17 @@ export interface IObjectStoreConnector {
      * Writes a file.
      * @param file The file to write.
      * @param path The path to write the file to.
-     * @param skipEncryption Whether to skip encryption.
+     * @param options The options for writing the file.
      * @returns A promise that resolves with the file descriptor.
      */
-    writeFile(file: File, path?: string, skipEncryption?: boolean): Promise<IFileDescriptor>;
+    writeFile(file: File, path?: string, options?: IFileOptions): Promise<IFileDescriptor>;
+    /**
+     * Creates a writable stream for a file.
+     * @param path The path to the file.
+     * @param options The options for creating the writable stream.
+     * @returns A promise that resolves with an {@link IWritableStream}.
+     */
+    createWritableStream(path: string, options?: IFileOptions): Promise<IWritableStream>;
     /**
      * Moves an object.
      * @param path The path to the object.

package/dist/object-storage/ReadableStream.d.ts

@@ -0,0 +1,16 @@
+/**
+ * Represents a readable stream that provides a way to read data asynchronously.
+ * @category Object Storage
+ */
+export interface IReadableStream {
+    /**
+     * Reads the next chunk of data from the stream.
+     * @returns A promise that resolves to a Uint8Array containing the data read from the stream, or null if the end of the stream has been reached.
+     */
+    read(): Promise<Uint8Array | null>;
+    /**
+     * Closes the stream and releases any resources associated with it.
+     * @returns A promise that resolves when the stream is successfully closed.
+     */
+    close(): Promise<void>;
+}

package/dist/object-storage/ReadableStream.js

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

package/dist/object-storage/WritableStream.d.ts

@@ -0,0 +1,15 @@
+/**
+ * Represents a writable stream.
+ * @category Object Storage
+ */
+export interface IWritableStream {
+    /**
+     * Writes data to the stream.
+     * @param chunk The data to write as an ArrayBuffer.
+     */
+    write(chunk: ArrayBuffer): Promise<void>;
+    /**
+     * Closes the stream.
+     */
+    close(): Promise<void>;
+}

package/dist/object-storage/WritableStream.js

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

package/dist/object-storage/event/SyncCompleteEvent.d.ts

@@ -1,4 +1,8 @@
 import { StorageEventType } from '.';
+/**
+ * The sync complete event.
+ * @category Object Storage
+ */
 export interface ISyncCompleteEvent {
     /**
      * The event type.

package/dist/object-storage/index.d.ts

@@ -1,7 +1,11 @@
 export * from './event';
+export { IDocumentParserConnector } from './DocumentParserConnector';
+export { DocumentParserConnectorConstructor } from './DocumentParserConnectorConstructor';
+export { IFile } from './File';
 export { FileStatus } from './FileStatus';
 export { IFileDescriptor } from './FileDescriptor';
 export { IFilePayload } from './FilePayload';
+export { IFileOptions } from './FileOptions';
 export { IFolderDescriptor } from './FolderDescriptor';
 export { IFolderPayload } from './FolderPayload';
 export { IMovePayload } from './MovePayload';
@@ -14,3 +18,5 @@ export { IObjectStoreListOptions } from './ObjectStoreListOptions';
 export { ObjectStoreConnectorConstructor } from './ObjectStoreConnectorConstructor';
 export { Payload } from './Payload';
 export { PayloadAction } from './PayloadAction';
+export { IReadableStream } from './ReadableStream';
+export { IWritableStream } from './WritableStream';

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

@@ -0,0 +1,41 @@
+import { IDataStream } from '../core';
+import { IVectorDatabaseSearchResult } from './VectorDatabaseSearchResult';
+/**
+ * The interface for the vector database.
+ * @category Vector Database
+ */
+export interface IVectorDatabase extends IDataStream {
+    /**
+     * Get the name of the database.
+     */
+    getName(): string;
+    /**
+     * Get the owner ID of the database.
+     */
+    getOwnerId(): string;
+    /**
+     * Close the database.
+     */
+    close(): void;
+    /**
+     * 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).
+     * @returns An array of search results.
+     */
+    search(vector: number[], k: number, minRelevance?: number, contentSize?: number): IVectorDatabaseSearchResult[];
+    /**
+     * Insert vectors into the database.
+     * @param name The name of the content.
+     * @param content The content of the vectors.
+     * @param vectors The vectors to insert.
+     */
+    insert(name: string, content: string[], vectors: number[][]): void;
+    /**
+     * Remove vectors from the database.
+     * @param name The name of the content.
+     */
+    remove(name: string): void;
+}

package/dist/vector-database/VectorDatabase.js

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

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

@@ -0,0 +1,33 @@
+import { IVectorDatabaseSearchResult } from './VectorDatabaseSearchResult';
+/**
+ * The vector database connector interface.
+ * @category Connector
+ */
+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).
+     * @returns An array of search results.
+     */
+    search(vector: number[], k: number, minRelevance?: number, contentSize?: number): IVectorDatabaseSearchResult[];
+    /**
+     * Insert vectors into the database.
+     * @param name The name of the content.
+     * @param content The content of the vectors.
+     * @param vectors The vectors to insert.
+     */
+    insert(name: string, content: string[], vectors: number[][]): void;
+    /**
+     * Remove vectors from the database.
+     * @param name The name of the content.
+     */
+    remove(name: string): void;
+    /**
+     * Get the content of the database.
+     * @returns The content of the database.
+     */
+    getBuffer(): ArrayBuffer;
+}

package/dist/vector-database/VectorDatabaseConnector.js

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

package/dist/{ai → vector-database}/VectorDatabaseConnectorConstructor.d.ts

@@ -1,6 +1,6 @@
 import { IVectorDatabaseConnector } from '.';
 /**
  * The vector database connector constructor type.
- * @category AI
+ * @category Vector Database
  */
 export type VectorDatabaseConnectorConstructor = new () => IVectorDatabaseConnector;

package/dist/vector-database/VectorDatabaseConnectorConstructor.js

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

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

@@ -0,0 +1,19 @@
+/**
+ * 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;
+}

package/dist/vector-database/VectorDatabaseSearchResult.js

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

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

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

package/dist/vector-database/index.js

@@ -0,0 +1,4 @@
+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.16",
+  "version": "1.0.18",
   "description": "The Crewdle Mist Web SDK public types and interfaces",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",

package/dist/ai/VectorDatabaseConnector.d.ts

@@ -1,25 +0,0 @@
-/**
- * The vector database connector interface.
- * @category Connector
- */
-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, minRelevance?: number, startingIndex?: number): number[];
-    /**
-     * Insert vectors into the database.
-     * @param vectors The vectors to insert.
-     */
-    insert(vectors: number[][]): void;
-    /**
-     * Remove vectors from the database.
-     * @param ids The IDs of the vectors to remove.
-     */
-    remove(ids: number[]): void;
-}