Commit graph

44 commits

Author SHA1 Message Date
0b7b3f947b chore: update README.md and docs with Brainy logo and enhanced formatting
Standardized documentation by adding a centered Brainy logo across README files, examples, and guides. Adjusted text formatting for consistency, improved alignment, and readability of feature descriptions and examples.
2025-06-11 08:49:30 -07:00
f0537a3fc4 feat: add simplified LLM commands and presets with detailed CLI support
Implemented new simplified commands (`create-simple`, `train-simple`, `generate-simple`) for easier LLM model management. Added pre-configured model presets (`tiny`, `small`, `medium`, `large`) and enhanced options to streamline usage for beginners. Updated CLI and API documentation with detailed examples. Incremented version to 0.8.0.
2025-06-10 11:47:05 -07:00
7f95844434 docs: add comprehensive documentation and examples for LLM augmentation
Introduced `llm-augmentation.md`, detailing the creation, training, testing, exporting, and deployment of language models using Brainy's graph database. Added examples showcasing practical usage and pipeline integration. Included class implementations in `llmAugmentations.ts`.
2025-06-10 11:15:22 -07:00
099b192071 feat: update server search augmentations and increment version to 0.7.6 2025-06-06 10:49:29 -07:00
a206b9926d feat: add browser-server search example with server search augmentations 2025-06-06 10:48:10 -07:00
bf3d9a055b feat: implement remote server search capabilities with WebSocket support 2025-06-06 10:48:01 -07:00
e00f1a92ce feat: add WebSocket API, REST API routes, and server setup for Brainy
Implemented a WebSocket API for real-time communication and REST API routes for CRUD operations on nouns and verbs. Added a server initialization script with WebSocket server integration and improved application structure with modularized routing and services.
2025-06-06 09:09:07 -07:00
1635cc229c feat: add WebSocket and WebRTC conduit augmentations with examples
Implemented WebSocketConduitAugmentation and WebRTCConduitAugmentation for syncing Brainy instances. Added comprehensive usage examples to showcase data synchronization via WebSocket and WebRTC.
2025-06-06 08:49:25 -07:00
d7bb6e7d5f chore: update to version 0.7.5, add conduit augmentations, and sync README.md
Incremented version to 0.7.5 across `version.ts` and `README.md`. Introduced WebSocket and WebRTC conduit augmentations in codebase and documented usage examples thoroughly in `README.md`.
2025-06-06 08:48:50 -07:00
32d5f45552 chore: update Node.js requirement to 23.11.0 and optimize pipelines and utilities
Upgraded minimum Node.js version from 18.0.0 to 23.11.0 across `README.md`, `package.json`, and `version.ts`. Optimized distance utilities and pipelines to leverage Node.js 23.11+ native performance improvements (e.g., `array.reduce`, WebStreams API). Incremented version to 0.7.4 for consistency.
2025-06-05 14:51:21 -07:00
e35e07d298 chore: sync README.md with version updates and enhance versioning script
Updated `README.md` to reflect version `0.7.3` with improved feature descriptions and scaling highlights. Enhanced the versioning script to automatically update the version badge in `README.md` for consistency. Incremented `version.ts` to `0.7.3`.
2025-06-05 14:25:29 -07:00
633846e54a docs: revamp README.md with engaging descriptions and expand feature list
Enhanced the `README.md` with more engaging and user-friendly descriptions, highlighting Brainy's adaptability and intelligence. Introduced new sections detailing adaptive intelligence, data pipeline enhancements, and use case expansion. Removed outdated dependencies from `package-lock.json`. Updated `version.ts` to `0.7.2`.
2025-06-05 14:12:50 -07:00
430ba65f41 feat: add version generation script and auto-generated version.ts file
Introduced a script to generate a `version.ts` file exporting the package version from `package.json`. This simplifies accessing version data in the CLI, especially for global installations. Included auto-generated `version.ts` in the project structure.
2025-06-05 14:05:05 -07:00
e2f65c8146 feat: add random graph generation and improve metadata vectorization
Introduced `generateRandomGraph` method to create randomized graphs with configurable entity counts and types, supporting automated testing and experimentation. Enhanced metadata vectorization logic to handle various metadata formats reliably, ensuring compatibility and fallback mechanisms during embedding. Updated `README.md` with detailed feature descriptions and usage guides.
2025-06-05 14:04:29 -07:00
be67c1b753 docs: update README.md and suppress TensorFlow.js warnings
Enhanced the installation section with guidance on resolving TensorFlow.js dependency conflicts using `--legacy-peer-deps`. Added CLI autocomplete setup instructions to improve user experience. Suppressed specific TensorFlow.js Node.js backend warnings in the embedding utils. Updated dependencies to the latest versions.
2025-06-05 11:44:18 -07:00
cdbd2a9db4 feat: introduce CLI for Brainy and enhance type validation
Added a comprehensive command-line interface (CLI) for interacting with the Brainy vector database. The CLI supports various operations, including database initialization, adding/searching nouns, managing relationships, and querying database status. Enhanced type validation logic for nouns and verbs to ensure consistency and enforce default types for invalid inputs. Updated test scripts to verify type validation and edge cases.
2025-06-05 11:18:20 -07:00
a0ce5b0ca9 feat: enhance search functionality with includeVerbs and metadata embedding
Updated search methods to support `includeVerbs` for retrieving associated verbs in results. Enhanced edge creation to allow metadata embedding when no vector is provided. Improved query handling and vectorization logic for consistent processing.
2025-06-05 08:26:40 -07:00
811bbbdbfd feat: enhance storage options and introduce read-only mode
Added extensive configuration support for storage adapters, including S3-compatible storage (R2, Amazon S3, Google Cloud Storage). Introduced environment variable fallback for seamless cloud integration. Updated createStorage logic for improved compatibility. Implemented read-only mode to restrict write operations and provide a safer database configuration.
2025-06-04 10:01:59 -07:00
a774bb0f82 feat: implement SequentialPipeline with threading and WebSocket support
Added the `SequentialPipeline` class for structured augmentation execution. Integrated threading capabilities via the `THREADED` execution mode in `augmentationPipeline`. Enhanced WebSocket support for real-time data processing through pipelines.
2025-06-04 10:01:46 -07:00
9ffc9d965e feat: add environment detection and threading utility functions
Introduced new utilities for detecting execution environments (browser, Node.js, Web Worker) and checking threading availability. Added `workerUtils` for executing functions in Web Workers or Worker Threads seamlessly based on the environment.
2025-06-04 10:01:23 -07:00
7dcba549a1 feat: add file system and sequential pipeline support
Added `FileSystemStorage` and exports for sequential pipelines, including `SequentialPipeline` and related types (`PipelineResult`, `SequentialPipelineOptions`).
2025-06-04 10:00:38 -07:00
18bbe6d428 chore: remove Firestore-related implementations and example files
Deleted all Firestore augmentation, storage, sync implementations, and related type definitions. Removed the FirestoreSync example file as part of the cleanup for disabled Firestore functionality.
2025-06-02 17:03:53 -07:00
3659b0069b chore: temporarily disable Firestore functionality and remove Firebase dependencies
Commented out all Firestore-related code across the project, including sync, storage, and vector search features. Removed Firebase dependencies (`firebase`, `firebase-admin`) from `package.json`. Updated `README.md` to reflect the temporary unavailability of Firestore features.
2025-06-02 12:43:44 -07:00
725610fbe4 feat: add Firestore vector search integration and noun type-based search enhancements
Introduced Firestore vector search integration using `@firebase/firestore-vector-search`. Added support for restricting searches by specific noun types to optimize performance and relevance. Updated `README.md` to document the new functionality and usage examples.
2025-06-02 12:23:11 -07:00
b10a32e8de feat: convert AugmentationResponse methods to use Promises, add search API
Refactored memory augmentation methods to return `Promise<AugmentationResponse>` for async handling. Introduced a new `search` method for vector similarity searches within the memory system.
2025-06-02 09:25:26 -07:00
95a72f4181 chore: reformat code in README.md for improved readability
Applied consistent indentation and line-breaking rules to code and text sections in `README.md`, ensuring better formatting and alignment for readability. No functional changes made.
2025-05-29 10:29:52 -07:00
203b669203 chore: remove examples/externalPlugins.js and pluginLoader.ts, update imports to .js
Deleted `examples/externalPlugins.js` and `pluginLoader.ts` as they are no longer used. Updated all `.ts` imports to `.js` across the codebase. Added `MemberOf` to `VerbType` and filtered disabled augmentations in `executeAugmentationPipeline`. Updated documentation to reflect new augmentation registration process. Removed deprecated `allowImportingTsExtensions` from `tsconfig.json`.
2025-05-29 09:52:30 -07:00
7d2b695ea0 feat: update import statements to use TypeScript file extensions 2025-05-29 08:27:59 -07:00
c7987822e9 feat: enhance fallback logic for storage initialization in opfsStorage
Improved the fallback sequence for storage initialization by adding a secondary attempt to use FileSystemStorage in browser environments before defaulting to in-memory storage. Enhanced error handling and logging for unavailable storage options.
2025-05-28 16:18:59 -07:00
e42c6b7302 feat: improve error handling and storage status reporting in BrainyData
Updated error messages for initialization failures to use "BrainyData" for clarity. Enhanced `getStorageStatus` to handle storage adapters without the `getStorageStatus` method, ensuring proper reporting of storage type, usage, and adapter details.
2025-05-28 16:02:20 -07:00
b031a40b1c feat: add external plugin loader and examples for Brainy
Introduced `pluginLoader.ts` to enable loading and configuring augmentation plugins from external packages. Added `examples/externalPlugins.js` to demonstrate usage. Enhanced storage status reporting in `opfsStorage` and `BrainyData` with detailed storage capacity and usage methods. Updated README with an external plugin usage guide.
2025-05-28 15:39:14 -07:00
aa4a76352f feat: refactor augmentation interface exports for improved structure
Replaced type aliases with interface extensions to enhance type compatibility and readability. Reorganized exports in `index.ts` to streamline imports.
2025-05-28 11:48:24 -07:00
ac5955a922 feat: add persistent storage support for OPFS
Introduced an optional `requestPersistentStorage` flag to enable persistent storage permission requests in the browser. Updated `OPFSStorage` to include methods for requesting and checking persistent storage status, and modified `createStorage` to handle the new flag.
2025-05-28 11:37:28 -07:00
fc9b8b7571 feat: add direct exports for graph types
Introduced direct exports for `GraphNoun`, `GraphVerb`, `EmbeddedGraphVerb`, and related graph types (`Person`, `Place`, `Thing`, etc.) to streamline imports and improve type accessibility.
2025-05-28 11:31:10 -07:00
0d5060aee2 feat: add direct exports for augmentation interfaces
Introduced direct exports for several augmentation interfaces (e.g., ISenseAugmentation, ICognitionAugmentation) to simplify imports and enhance type accessibility. Updated type imports and exports in relevant files.
2025-05-28 11:03:32 -07:00
ce9c5e2522 docs: add separate graph type import section to README and update type definitions
Introduced a new README section explaining how to import graph types individually to enable tree shaking. Updated `package.json` exports to support direct graph type imports. Enhanced `GraphNoun` structure by adding optional `label` and `embeddedVerbs` properties while simplifying the `CreatorMetadata` interface.
2025-05-28 09:56:24 -07:00
1bcfaa96c8 refactor: dynamically import Node.js modules in file system storage adapter
Refactored `fileSystemStorage` to dynamically import `fs` and `path` modules, improving compatibility with various environments. Updated initialization logic to set paths post-import. Added error handling for failed imports and enhanced type annotations for better maintainability.
2025-05-27 17:10:56 -07:00
7fe32d9e8a chore: simplify TensorFlow.js imports and bump package version to 0.2.2
Streamlined TensorFlow.js and Universal Sentence Encoder imports by removing unnecessary explicit file paths. Updated package.json version to 0.2.2.
2025-05-27 15:42:38 -07:00
d77b2bf8fe feat: enhance embedding functionality and improve TensorFlow.js integration
Enhanced embedding functionality by introducing `createTensorFlowEmbeddingFunction` and `createSimpleEmbeddingFunction` for flexible text vectorization. Updated TensorFlow.js dependencies to be automatically included with the package. Added detailed examples and documentation in `README.md`. Improved error handling and refactored default embedding function implementation. Updated `package.json` dependencies.
2025-05-27 15:11:12 -07:00
5566ddfb09 chore: remove example files and release configuration
Deleted augmentation pipeline examples and `.releaserc.json`, streamlining the repository by eliminating redundant example implementations and release automation files.
2025-05-27 13:58:49 -07:00
a22fd7de77 feat: add memory and WebSocket augmentation examples with configuration files 2025-05-27 13:13:04 -07:00
022680a2f5 feat: implement augmentation type system and release automation 2025-05-27 13:12:53 -07:00
d2ddbd2613 Add augmentation pipeline and memory augmentation documentation
Introduced an augmentation event pipeline supporting multiple execution modes (e.g., SEQUENTIAL, PARALLEL). Added new Memory Augmentation type for versatile data storage/retrieval (e.g., fileSystem, in-memory, Firestore). Updated `README.md` with pipeline usage, examples, and augmentations reorganization. Included new demo files for augmentation examples.
2025-05-27 10:08:01 -07:00
49480e694c Initial commit of Brainy vector database v0.1.0 2025-05-23 10:55:20 -07:00