@crewdle/web-sdk-types 1.0.15 → 1.0.17

package/dist/ai/GenerativeAI.d.ts

@@ -1,6 +1,7 @@
 import { IJobParameters, IJobResult } from '../job';
 /**
  * The AI prompt source Enum
+ * @category AI
  */
 export declare enum PromptSource {
     /**
@@ -15,7 +16,7 @@ export declare enum PromptSource {
 /**
  * The AI prompt history Interface
  * Represents the history of a prompt.
- * @ignore
+ * @category AI
  */
 export interface IPromptHistory {
     /**
@@ -27,6 +28,11 @@ export interface IPromptHistory {
      */
     message: string;
 }
+/**
+ * The AI prompt options Interface
+ * Represents the options for an AI prompt.
+ * @category AI
+ */
 export interface IPromptOptions {
     /**
      * The instructions for the AI job.
@@ -39,37 +45,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.
- * @ignore
+ * The AI prompt result Interface
+ * Represents the result of an AI prompt.
+ * @category AI
  */
-export interface IJobResultAI extends IJobResult {
+export interface IPromptResult {
     /**
      * The output of the AI job.
      */
@@ -82,6 +89,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.
+ * @category AI
+ */
+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.
+ * @category AI
+ */
+export interface IJobResultAI extends IJobResult, IPromptResult {
     /**
      * The index of the output, in case of partial results.
      */

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

@@ -1,4 +1,5 @@
-import { IPromptOptions } from '.';
+import { IPromptOptions, IPromptResult } from '.';
+import { GenerativeAIModelType } from './GenerativeAIModelType';
 /**
  * Represents a context for a Generative AI service.
  * @category AI
@@ -7,15 +8,29 @@ 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<string>;
+    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<string>;
+    prompt(prompt: string, options?: IPromptOptions): Promise<IPromptResult>;
+    /**
+     * Upload a model to the AI service.
+     * @param model The model file to upload.
+     * @returns A promise that resolves when the model is uploaded.
+     */
+    uploadModel(model: File, type?: GenerativeAIModelType): Promise<void>;
+    /**
+     * Delete a model from the AI service.
+     * @param modelId The optional ID of the model to delete.
+     * @returns A promise that resolves when the model is deleted.
+     */
+    deleteModel(modelId?: string): Promise<void>;
     /**
      * Close the Generative AI Context.
      */

package/dist/ai/GenerativeAIModelType.d.ts

@@ -0,0 +1,14 @@
+/**
+ * Represents the types of generative AI models.
+ * @category AI
+ */
+export declare enum GenerativeAIModelType {
+    /**
+     * The main model to run with the inference engine.
+     */
+    Main = "main",
+    /**
+     * The simalirity model to run to build the vector database.
+     */
+    Similarity = "similarity"
+}

package/dist/ai/GenerativeAIModelType.js

@@ -0,0 +1,15 @@
+/**
+ * Represents the types of generative AI models.
+ * @category AI
+ */
+export var GenerativeAIModelType;
+(function (GenerativeAIModelType) {
+    /**
+     * The main model to run with the inference engine.
+     */
+    GenerativeAIModelType["Main"] = "main";
+    /**
+     * The simalirity model to run to build the vector database.
+     */
+    GenerativeAIModelType["Similarity"] = "similarity";
+})(GenerativeAIModelType || (GenerativeAIModelType = {}));

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/dist/ai/index.d.ts

@@ -1,5 +1,6 @@
 export * from './GenerativeAI';
 export * from './GenerativeAIContext';
+export * from './GenerativeAIModelType';
 export * from './GenerativeAIWorker';
 export * from './GenerativeAIWorkerConnector';
 export * from './GenerativeAIWorkerConnectorConstructor';

package/dist/ai/index.js

@@ -1,5 +1,6 @@
 export * from './GenerativeAI';
 export * from './GenerativeAIContext';
+export * from './GenerativeAIModelType';
 export * from './GenerativeAIWorker';
 export * from './GenerativeAIWorkerConnector';
 export * from './GenerativeAIWorkerConnectorConstructor';

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

@@ -25,7 +25,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.

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,10 @@
+/**
+ * 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;
+}

package/dist/object-storage/FileOptions.js

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

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';
 /**
@@ -43,9 +43,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,9 @@
 export * from './event';
+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 +16,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/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@crewdle/web-sdk-types",
-  "version": "1.0.15",
+  "version": "1.0.17",
   "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/"