@mastra/vectorize 1.1.2-alpha.1 → 1.1.3-alpha.0

package/dist/docs/SKILL.md

@@ -3,7 +3,7 @@ name: mastra-vectorize
 description: Documentation for @mastra/vectorize. Use when working with @mastra/vectorize APIs, configuration, or implementation.
 metadata:
   package: "@mastra/vectorize"
-  version: "1.1.2-alpha.1"
+  version: "1.1.3-alpha.0"
 ---
 
 ## When to use

package/dist/docs/assets/SOURCE_MAP.json

@@ -1,5 +1,5 @@
 {
-  "version": "1.1.2-alpha.1",
+  "version": "1.1.3-alpha.0",
   "package": "@mastra/vectorize",
   "exports": {},
   "modules": {}

package/dist/docs/references/reference-rag-retrieval.md

@@ -50,23 +50,25 @@ console.log(results)
 
 The `topK` parameter specifies the maximum number of most similar results to return from the vector search.
 
-Results include both the text content and a similarity score:
+Each result includes an `id`, a similarity `score`, and the stored `metadata`. When you store chunk text in metadata, it's available as `metadata.text`:
 
 ```ts
 [
   {
-    text: 'Climate change poses significant challenges...',
+    id: 'chunk-1',
     score: 0.89,
-    metadata: { source: 'article1.txt' },
+    metadata: { text: 'Climate change poses significant challenges...', source: 'article1.txt' },
   },
   {
-    text: 'Rising temperatures affect crop yields...',
+    id: 'chunk-2',
     score: 0.82,
-    metadata: { source: 'article1.txt' },
+    metadata: { text: 'Rising temperatures affect crop yields...', source: 'article1.txt' },
   },
 ]
 ```
 
+Results can also include `vector` when you set `includeVector: true`, and `document` when the store returns the original document (Chroma only).
+
 ## Advanced retrieval options
 
 ### Metadata Filtering

package/dist/docs/references/reference-rag-vector-databases.md

@@ -54,6 +54,29 @@ const results = await store.hybridQuery({
 
 See the [MongoDB vector reference](https://mastra.ai/reference/vectors/mongodb) for details on `createSearchIndex()`, `textQuery()`, and `hybridQuery()`.
 
+### Automated Embedding
+
+MongoDB can generate the embeddings itself, so you don't need an embedding provider in your application. Create the index with `autoEmbed` and a Voyage AI model, write plain text, and search with a query string:
+
+```ts
+await store.createIndex({
+  indexName: 'myCollection',
+  autoEmbed: { model: 'voyage-4' },
+})
+await store.upsert({
+  indexName: 'myCollection',
+  documents: chunks.map(chunk => chunk.text),
+  metadata: chunks.map(chunk => ({ text: chunk.text })),
+})
+const results = await store.query({
+  indexName: 'myCollection',
+  queryText: 'search terms',
+  topK: 10,
+})
+```
+
+Automated Embedding is a MongoDB Preview feature and needs a deployment where it's available. See the [MongoDB vector reference](https://mastra.ai/reference/vectors/mongodb) for the supported options and requirements.
+
 **PgVector**:
 
 ```ts
@@ -207,7 +230,7 @@ await store.upsert({
 **libSQL**:
 
 ```ts
-import { LibSQLVector } from '@mastra/core/vector/libsql'
+import { LibSQLVector } from '@mastra/libsql'
 
 const store = new LibSQLVector({
   id: 'libsql-vector',
@@ -248,6 +271,34 @@ await store.upsert({
 })
 ```
 
+**Weaviate**:
+
+```ts
+import { WeaviateVector } from '@mastra/weaviate'
+
+const store = new WeaviateVector({
+  id: 'weaviate-vector',
+  httpHost: process.env.WEAVIATE_HOST,
+  httpPort: 443,
+  httpSecure: true,
+  grpcHost: process.env.WEAVIATE_GRPC_HOST,
+  grpcPort: 443,
+  grpcSecure: true,
+  apiKey: process.env.WEAVIATE_API_KEY,
+})
+
+await store.createIndex({
+  indexName: 'myCollection',
+  dimension: 1536,
+})
+
+await store.upsert({
+  indexName: 'myCollection',
+  vectors: embeddings,
+  metadata: chunks.map(chunk => ({ text: chunk.text })),
+})
+```
+
 **Cloudflare**:
 
 ```ts
@@ -317,6 +368,29 @@ await store.upsert({
 
 For detailed setup instructions and best practices, see the [official Elasticsearch documentation](https://www.elastic.co/docs/solutions/search/get-started).
 
+**Azure AI Search**:
+
+```ts
+import { AzureAISearchVector } from '@mastra/azure-ai-search'
+
+const store = new AzureAISearchVector({
+  id: 'azure-search-vectors',
+  endpoint: process.env.AZURE_AI_SEARCH_ENDPOINT!,
+  credential: process.env.AZURE_AI_SEARCH_CREDENTIAL!,
+})
+
+await store.createIndex({
+  indexName: 'my-collection',
+  dimension: 1536,
+})
+
+await store.upsert({
+  indexName: 'my-collection',
+  vectors: embeddings,
+  metadata: chunks.map(chunk => ({ text: chunk.text })),
+})
+```
+
 **Couchbase**:
 
 ```ts
@@ -534,6 +608,17 @@ Namespace names must:
 
 - Example: `_namespace` isn't valid (starts with underscore)
 
+**Weaviate**:
+
+Index names map to Weaviate collections, which:
+
+- Are capitalized by Weaviate (the first letter is upper-cased)
+- Should contain only letters, numbers, and the `_` character
+- Must start with a letter, since only the first character is upper-cased (a leading digit or symbol stays invalid)
+- Preserve the original Mastra index name in the collection description, so `listIndexes()` and `describeIndex()` return the name you supplied
+- Example: `my_collection` is stored as `My_collection` and returned as `my_collection`
+- Example: `123_collection` isn't valid (starts with a digit)
+
 **Cloudflare**:
 
 Index names must:
@@ -587,6 +672,17 @@ Index names must:
 - Example: `myindex-` isn't valid (ends with hyphen)
 - Example: `MyIndex` isn't valid (contains uppercase letters)
 
+**Azure AI Search**:
+
+Index names must:
+
+- Use only lowercase letters, numbers, dashes (`-`), and underscore (`_`) characters
+- Not start or end with a dash
+- Be between 2 and 128 characters long
+- Example: `my-index-123` and `my_index` are valid
+- Example: `MyIndex` isn't valid (contains uppercase letters)
+- Example: `my-index-` isn't valid (ends with a dash)
+
 ### Upserting Embeddings
 
 After creating an index, you can store embeddings along with their basic metadata:
@@ -650,7 +746,7 @@ Key metadata considerations:
 
 ## Deleting vectors
 
-When building RAG applications, you often need to clean up stale vectors when documents are deleted or updated. Mastra provides the `deleteVectors` method that supports deleting vectors by metadata filters, making it straightforward to remove all embeddings associated with a specific document.
+Use `deleteVectors` with a metadata filter to remove embeddings associated with a document. This is useful for cleaning up stale vectors after a document is deleted or updated.
 
 ### Delete by Metadata Filter
 

package/dist/docs/references/reference-vectors-vectorize.md

@@ -133,17 +133,21 @@ interface QueryResult {
 
 ## Error handling
 
-The store throws typed errors that can be caught:
+The store throws `MastraError` instances from `@mastra/core/error`:
 
 ```typescript
+import { MastraError } from '@mastra/core/error'
+
 try {
   await store.query({
     indexName: 'index_name',
     queryVector: queryVector,
   })
 } catch (error) {
-  if (error instanceof VectorStoreError) {
-    console.log(error.code) // 'connection_failed' | 'invalid_dimension' | etc
+  if (error instanceof MastraError) {
+    console.log(error.id) // 'MASTRA_VECTOR_VECTORIZE_QUERY_FAILED'
+    console.log(error.domain) // 'STORAGE'
+    console.log(error.category) // 'USER' | 'THIRD_PARTY'
     console.log(error.details) // Additional error context
   }
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mastra/vectorize",
-  "version": "1.1.2-alpha.1",
+  "version": "1.1.3-alpha.0",
   "description": "Cloudflare Vectorize store provider for Mastra",
   "type": "module",
   "files": [
@@ -27,17 +27,17 @@
   },
   "devDependencies": {
     "@types/node": "22.20.1",
-    "@vitest/coverage-v8": "4.1.10",
-    "@vitest/ui": "4.1.10",
+    "@vitest/coverage-v8": "4.1.11",
+    "@vitest/ui": "4.1.11",
     "dotenv": "^17.4.2",
     "eslint": "^10.7.0",
     "tsdown": "0.22.9",
     "tsx": "^4.23.1",
     "typescript": "^7.0.2",
-    "vitest": "4.1.10",
-    "@internal/lint": "0.0.129",
-    "@internal/types-builder": "0.0.104",
-    "@mastra/core": "1.64.0-alpha.7"
+    "vitest": "4.1.11",
+    "@internal/types-builder": "0.0.119",
+    "@internal/lint": "0.0.144",
+    "@mastra/core": "1.78.1-alpha.0"
   },
   "peerDependencies": {
     "@mastra/core": ">=1.0.0-0 <2.0.0-0"