@mastra/fastembed 0.10.7 → 1.0.0-beta.1

package/CHANGELOG.md

@@ -1,22 +1,20 @@
 # @mastra/fastembed
 
-## 0.10.7
+## 1.0.0-beta.1
 
 ### Patch Changes
 
-- update peerdeps ([`5ca1cca`](https://github.com/mastra-ai/mastra/commit/5ca1ccac61ffa7141e6d9fa8f22d3ad4d03bf5dc))
+- Embed AI types to fix peerdeps mismatches ([`9650cce`](https://github.com/mastra-ai/mastra/commit/9650cce52a1d917ff9114653398e2a0f5c3ba808))
 
-## 0.10.7-alpha.0
+## 1.0.0-beta.0
 
-### Patch Changes
-
-- update peerdeps ([`5ca1cca`](https://github.com/mastra-ai/mastra/commit/5ca1ccac61ffa7141e6d9fa8f22d3ad4d03bf5dc))
+### Major Changes
 
-## 0.10.6
+- Bump minimum required Node.js version to 22.13.0 ([#9706](https://github.com/mastra-ai/mastra/pull/9706))
 
-### Patch Changes
+- Upgraded to AI SDK v5 (specification version v2) for compatibility with @mastra/core. Default exports now use v2 specification. Legacy v1 exports available for backwards compatibility via `fastembed.smallLegacy` and `fastembed.baseLegacy`. ([#9349](https://github.com/mastra-ai/mastra/pull/9349))
 
-- Fix peerdependencies ([`eb7c1c8`](https://github.com/mastra-ai/mastra/commit/eb7c1c8c592d8fb16dfd250e337d9cdc73c8d5de))
+- Mark as stable ([`83d5942`](https://github.com/mastra-ai/mastra/commit/83d5942669ce7bba4a6ca4fd4da697a10eb5ebdc))
 
 ## 0.10.5
 

package/README.md

@@ -10,19 +10,58 @@ 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)
+
 ```typescript
 import { Memory } from '@mastra/memory';
 import { fastembed } from '@mastra/fastembed';
 
 const memory = new Memory({
   // ... other memory options
-  embedder: fastembed,
+  embedder: fastembed, // Uses v2 specification
 });
 
 // Now you can use this memory instance with an Agent
 // const agent = new Agent({ memory, ... });
 ```
 
+### Available Models
+
+```typescript
+import { fastembed } from '@mastra/fastembed';
+
+// Default export (bge-small-en-v1.5 with v2 spec)
+const embedder = fastembed;
+
+// Named exports for v2 models
+const small = fastembed.small; // bge-small-en-v1.5
+const base = fastembed.base; // bge-base-en-v1.5
+
+// 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
+
+```typescript
+import { embed } from 'ai';
+import { fastembed } from '@mastra/fastembed';
+
+const result = await embed({
+  model: fastembed,
+  value: 'Text to 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.