@mastra/fastembed 1.0.1 → 1.1.0

package/CHANGELOG.md

@@ -1,5 +1,17 @@
 # @mastra/fastembed
 
+## 1.1.0
+
+### Minor Changes
+
+- Replace the abandoned `fastembed` npm dependency with a maintained, vendored implementation. The public API and all embedding models remain unchanged — no migration needed. ([#16772](https://github.com/mastra-ai/mastra/pull/16772))
+
+## 1.1.0-alpha.0
+
+### Minor Changes
+
+- Replace the abandoned `fastembed` npm dependency with a maintained, vendored implementation. The public API and all embedding models remain unchanged — no migration needed. ([#16772](https://github.com/mastra-ai/mastra/pull/16772))
+
 ## 1.0.1
 
 ### Patch Changes

package/LICENSE-fastembed

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 Anush
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -1,8 +1,8 @@
 # @mastra/fastembed
 
-This package provides a FastEmbed embedding model integration for use with Mastra Memory.
+Local embedding model integration for Mastra, powered by ONNX Runtime.
 
-**Note:** This functionality was previously included directly within `@mastra/core`. It has been moved to this separate package because `fastembed-js` relies on large native dependencies (like `onnxruntime-node`). Separating it keeps `@mastra/core` lightweight for users who may not need FastEmbed.
+This package is a maintained fork of [fastembed-js](https://github.com/Anush008/fastembed-js) (now archived). The upstream source has been vendored directly into this package so that `@mastra/fastembed` no longer depends on the unmaintained `fastembed` npm package.
 
 ## Installation
 
@@ -10,15 +10,9 @@ This package provides a FastEmbed embedding model integration for use with Mastr
 pnpm add @mastra/fastembed
 ```
 
-## AI SDK v2 Compatibility
-
-This package supports AI SDK v5 (specification version v2). The default exports use v2, which is compatible with `@mastra/core` and AI SDK v5.
-
-**Breaking Change:** Previous versions used AI SDK specification v1. If you need v1 compatibility for legacy code, use the `Legacy` exports.
-
 ## Usage
 
-### Default (AI SDK v2)
+### Default (AI SDK v3)
 
 ```typescript
 import { Memory } from '@mastra/memory';
@@ -26,11 +20,8 @@ import { fastembed } from '@mastra/fastembed';
 
 const memory = new Memory({
   // ... other memory options
-  embedder: fastembed, // Uses v2 specification
+  embedder: fastembed,
 });
-
-// Now you can use this memory instance with an Agent
-// const agent = new Agent({ memory, ... });
 ```
 
 ### Available Models
@@ -38,19 +29,23 @@ const memory = new Memory({
 ```typescript
 import { fastembed } from '@mastra/fastembed';
 
-// Default export (bge-small-en-v1.5 with v2 spec)
+// Default export (bge-small-en-v1.5 with v3 spec)
 const embedder = fastembed;
 
-// Named exports for v2 models
+// Named exports for v3 models
 const small = fastembed.small; // bge-small-en-v1.5
 const base = fastembed.base; // bge-base-en-v1.5
 
+// V2 models (for AI SDK v5 compatibility)
+const smallV2 = fastembed.smallV2;
+const baseV2 = fastembed.baseV2;
+
 // Legacy v1 models (for backwards compatibility)
 const smallLegacy = fastembed.smallLegacy; // bge-small-en-v1.5 (v1 spec)
 const baseLegacy = fastembed.baseLegacy; // bge-base-en-v1.5 (v1 spec)
 ```
 
-### Direct Usage with AI SDK v5
+### Direct Usage with AI SDK
 
 ```typescript
 import { embed } from 'ai';
@@ -64,4 +59,18 @@ const result = await embed({
 console.log(result.embedding); // number[]
 ```
 
-This package wraps the `fastembed-js` library to provide an embedding model compatible with the AI SDK and Mastra.
+## Supported Models
+
+| Model                   | Dimensions | Description                 |
+| ----------------------- | ---------- | --------------------------- |
+| `bge-small-en-v1.5`     | 384        | Fast, default English model |
+| `bge-base-en-v1.5`      | 768        | Base English model          |
+| `bge-small-en`          | 384        | Fast English model          |
+| `bge-base-en`           | 768        | Base English model          |
+| `bge-small-zh-v1.5`     | 512        | Fast Chinese model          |
+| `all-MiniLM-L6-v2`      | 384        | Sentence Transformer model  |
+| `multilingual-e5-large` | 1024       | Multilingual model          |
+
+## Attribution
+
+The core embedding engine is forked from [fastembed-js](https://github.com/Anush008/fastembed-js) by [Anush008](https://github.com/Anush008), licensed under MIT. See [LICENSE-fastembed](./LICENSE-fastembed) for the original license.