@soulcraft/brainy 0.10.0 → 0.11.0

package/README.demo.md

@@ -4,7 +4,7 @@ The Brainy interactive demo showcases the library's features in a web browser. F
 
 ## Prerequisites
 
-- Make sure you have Node.js installed (version 23.0.0 or higher)
+- Make sure you have Node.js installed (version 24.4.0 or higher)
 - Ensure the project is built (run both `npm run build` and `npm run build:browser`)
 
 ## Running the Demo

package/README.md

@@ -3,10 +3,10 @@
 <br/><br/>
 
 [![License](https://img.shields.io/badge/license-MIT-green.svg)](LICENSE)
-[![Node.js](https://img.shields.io/badge/node-%3E%3D24.3.0-brightgreen.svg)](https://nodejs.org/)
+[![Node.js](https://img.shields.io/badge/node-%3E%3D24.4.0-brightgreen.svg)](https://nodejs.org/)
 [![TypeScript](https://img.shields.io/badge/TypeScript-5.4.5-blue.svg)](https://www.typescriptlang.org/)
 [![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg)](CONTRIBUTING.md)
-[![npm](https://img.shields.io/badge/npm-v0.10.0-blue.svg)](https://www.npmjs.com/package/@soulcraft/brainy)
+[![npm](https://img.shields.io/badge/npm-v0.11.0-blue.svg)](https://www.npmjs.com/package/@soulcraft/brainy)
 
 [//]: # ([![Cartographer]&#40;https://img.shields.io/badge/Cartographer-Official%20Standard-brightgreen&#41;]&#40;https://github.com/sodal-project/cartographer&#41;)
 
@@ -1246,10 +1246,6 @@ terabyte-scale data that can't fit entirely in memory, we provide several approa
 For detailed information on how to scale Brainy for large datasets, see our
 comprehensive [Scaling Strategy](scalingStrategy.md) document.
 
-## Requirements
-
-- Node.js >= 23.0.0
-
 ## Contributing
 
 For detailed contribution guidelines, please see [CONTRIBUTING.md](CONTRIBUTING.md).

package/dist/augmentations/huggingfaceActivation.d.ts

@@ -0,0 +1,57 @@
+/**
+ * Huggingface Activation Augmentation
+ *
+ * This augmentation provides embedding and text generation capabilities using Huggingface models.
+ * It implements the IActivationAugmentation interface to make it pluggable with other solutions.
+ */
+import { AugmentationResponse, IActivationAugmentation } from '../types/augmentations.js';
+/**
+ * Huggingface Activation Augmentation
+ *
+ * This augmentation uses Huggingface transformers and sentence_transformers (specifically all-MiniLM-L6-v2)
+ * for embedding and text generation capabilities.
+ */
+export declare class HuggingfaceActivation implements IActivationAugmentation {
+    readonly name: string;
+    readonly description: string;
+    enabled: boolean;
+    private embeddingModel;
+    private embeddingFunction;
+    private initialized;
+    private hfInference;
+    constructor();
+    /**
+     * Initializes the augmentation
+     */
+    initialize(): Promise<void>;
+    /**
+     * Shuts down the augmentation
+     */
+    shutDown(): Promise<void>;
+    /**
+     * Gets the status of the augmentation
+     */
+    getStatus(): Promise<'active' | 'inactive' | 'error'>;
+    /**
+     * Triggers an action based on a processed command or internal state
+     * @param actionName The name of the action to trigger
+     * @param parameters Optional parameters for the action
+     */
+    triggerAction(actionName: string, parameters?: Record<string, unknown>): Promise<AugmentationResponse<unknown>>;
+    /**
+     * Generates an expressive output or response from Brainy
+     * @param knowledgeId The identifier of the knowledge to express
+     * @param format The desired output format (e.g., 'text', 'json')
+     */
+    generateOutput(knowledgeId: string, format: string): Promise<AugmentationResponse<string | Record<string, unknown>>>;
+    /**
+     * Interacts with an external system or API
+     * @param systemId The identifier of the external system
+     * @param payload The data to send to the external system
+     */
+    interactExternal(systemId: string, payload: Record<string, unknown>): Promise<AugmentationResponse<unknown>>;
+}
+/**
+ * Creates a new instance of the Huggingface Activation Augmentation
+ */
+export declare function createHuggingfaceActivation(): IActivationAugmentation;

package/dist/augmentations/huggingfaceActivation.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"huggingfaceActivation.d.ts","sourceRoot":"","sources":["../../src/augmentations/huggingfaceActivation.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,OAAO,EAAE,oBAAoB,EAAoB,uBAAuB,EAAE,MAAM,2BAA2B,CAAA;AAI3G;;;;;GAKG;AACH,qBAAa,qBAAsB,YAAW,uBAAuB;IACnE,QAAQ,CAAC,IAAI,EAAE,MAAM,CAA2B;IAChD,QAAQ,CAAC,WAAW,EAAE,MAAM,CAA2F;IACvH,OAAO,EAAE,OAAO,CAAO;IAEvB,OAAO,CAAC,cAAc,CAAgC;IACtD,OAAO,CAAC,iBAAiB,CAAgC;IACzD,OAAO,CAAC,WAAW,CAAiB;IACpC,OAAO,CAAC,WAAW,CAAY;;IAO/B;;OAEG;IACG,UAAU,IAAI,OAAO,CAAC,IAAI,CAAC;IA2BjC;;OAEG;IACG,QAAQ,IAAI,OAAO,CAAC,IAAI,CAAC;IAgB/B;;OAEG;IACG,SAAS,IAAI,OAAO,CAAC,QAAQ,GAAG,UAAU,GAAG,OAAO,CAAC;IAI3D;;;;OAIG;IACG,aAAa,CACjB,UAAU,EAAE,MAAM,EAClB,UAAU,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GACnC,OAAO,CAAC,oBAAoB,CAAC,OAAO,CAAC,CAAC;IAsEzC;;;;OAIG;IACG,cAAc,CAClB,WAAW,EAAE,MAAM,EACnB,MAAM,EAAE,MAAM,GACb,OAAO,CAAC,oBAAoB,CAAC,MAAM,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC,CAAC;IA+ClE;;;;OAIG;IACG,gBAAgB,CACpB,QAAQ,EAAE,MAAM,EAChB,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAC/B,OAAO,CAAC,oBAAoB,CAAC,OAAO,CAAC,CAAC;CAoD1C;AAED;;GAEG;AACH,wBAAgB,2BAA2B,IAAI,uBAAuB,CAErE"}

package/dist/augmentations/huggingfaceActivationRegistration.d.ts

@@ -0,0 +1,6 @@
+/**
+ * Registration file for Huggingface Activation Augmentation
+ *
+ * This file registers the Huggingface Activation Augmentation with the augmentation registry.
+ */
+export declare function registerHuggingfaceActivation(): void;

package/dist/augmentations/huggingfaceActivationRegistration.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"huggingfaceActivationRegistration.d.ts","sourceRoot":"","sources":["../../src/augmentations/huggingfaceActivationRegistration.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAYH,wBAAgB,6BAA6B,IAAI,IAAI,CAEpD"}