@mastra/couchbase 1.1.2 → 1.1.3-alpha.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -3,7 +3,7 @@ name: mastra-couchbase
3
3
  description: Documentation for @mastra/couchbase. Use when working with @mastra/couchbase APIs, configuration, or implementation.
4
4
  metadata:
5
5
  package: "@mastra/couchbase"
6
- version: "1.1.2"
6
+ version: "1.1.3-alpha.0"
7
7
  ---
8
8
 
9
9
  ## When to use
@@ -17,7 +17,7 @@ Read the individual reference documents for detailed explanations and code examp
17
17
  ### Reference
18
18
 
19
19
  - [Storing embeddings in a vector database](references/reference-rag-vector-databases.md) - After generating embeddings, you need to store them in a database that supports vector similarity search.
20
- - [Reference: Couchbase vector store](references/reference-vectors-couchbase.md) - The CouchbaseVector class provides vector search using Couchbase Vector Search. It enables efficient similarity search and metadata filtering within your Couchbase collections.
20
+ - [Reference: Couchbase vector store](references/reference-vectors-couchbase.md) - The CouchbaseVector class provides vector search using Couchbase Vector Search. It enables efficient similarity search within your Couchbase collections.
21
21
 
22
22
 
23
23
  Read [assets/SOURCE_MAP.json](assets/SOURCE_MAP.json) for source code references.
@@ -1,5 +1,5 @@
1
1
  {
2
- "version": "1.1.2",
2
+ "version": "1.1.3-alpha.0",
3
3
  "package": "@mastra/couchbase",
4
4
  "exports": {},
5
5
  "modules": {}
@@ -54,6 +54,29 @@ const results = await store.hybridQuery({
54
54
 
55
55
  See the [MongoDB vector reference](https://mastra.ai/reference/vectors/mongodb) for details on `createSearchIndex()`, `textQuery()`, and `hybridQuery()`.
56
56
 
57
+ ### Automated Embedding
58
+
59
+ 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:
60
+
61
+ ```ts
62
+ await store.createIndex({
63
+ indexName: 'myCollection',
64
+ autoEmbed: { model: 'voyage-4' },
65
+ })
66
+ await store.upsert({
67
+ indexName: 'myCollection',
68
+ documents: chunks.map(chunk => chunk.text),
69
+ metadata: chunks.map(chunk => ({ text: chunk.text })),
70
+ })
71
+ const results = await store.query({
72
+ indexName: 'myCollection',
73
+ queryText: 'search terms',
74
+ topK: 10,
75
+ })
76
+ ```
77
+
78
+ 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.
79
+
57
80
  **PgVector**:
58
81
 
59
82
  ```ts
@@ -207,7 +230,7 @@ await store.upsert({
207
230
  **libSQL**:
208
231
 
209
232
  ```ts
210
- import { LibSQLVector } from '@mastra/core/vector/libsql'
233
+ import { LibSQLVector } from '@mastra/libsql'
211
234
 
212
235
  const store = new LibSQLVector({
213
236
  id: 'libsql-vector',
@@ -248,6 +271,34 @@ await store.upsert({
248
271
  })
249
272
  ```
250
273
 
274
+ **Weaviate**:
275
+
276
+ ```ts
277
+ import { WeaviateVector } from '@mastra/weaviate'
278
+
279
+ const store = new WeaviateVector({
280
+ id: 'weaviate-vector',
281
+ httpHost: process.env.WEAVIATE_HOST,
282
+ httpPort: 443,
283
+ httpSecure: true,
284
+ grpcHost: process.env.WEAVIATE_GRPC_HOST,
285
+ grpcPort: 443,
286
+ grpcSecure: true,
287
+ apiKey: process.env.WEAVIATE_API_KEY,
288
+ })
289
+
290
+ await store.createIndex({
291
+ indexName: 'myCollection',
292
+ dimension: 1536,
293
+ })
294
+
295
+ await store.upsert({
296
+ indexName: 'myCollection',
297
+ vectors: embeddings,
298
+ metadata: chunks.map(chunk => ({ text: chunk.text })),
299
+ })
300
+ ```
301
+
251
302
  **Cloudflare**:
252
303
 
253
304
  ```ts
@@ -317,6 +368,29 @@ await store.upsert({
317
368
 
318
369
  For detailed setup instructions and best practices, see the [official Elasticsearch documentation](https://www.elastic.co/docs/solutions/search/get-started).
319
370
 
371
+ **Azure AI Search**:
372
+
373
+ ```ts
374
+ import { AzureAISearchVector } from '@mastra/azure-ai-search'
375
+
376
+ const store = new AzureAISearchVector({
377
+ id: 'azure-search-vectors',
378
+ endpoint: process.env.AZURE_AI_SEARCH_ENDPOINT!,
379
+ credential: process.env.AZURE_AI_SEARCH_CREDENTIAL!,
380
+ })
381
+
382
+ await store.createIndex({
383
+ indexName: 'my-collection',
384
+ dimension: 1536,
385
+ })
386
+
387
+ await store.upsert({
388
+ indexName: 'my-collection',
389
+ vectors: embeddings,
390
+ metadata: chunks.map(chunk => ({ text: chunk.text })),
391
+ })
392
+ ```
393
+
320
394
  **Couchbase**:
321
395
 
322
396
  ```ts
@@ -534,6 +608,17 @@ Namespace names must:
534
608
 
535
609
  - Example: `_namespace` isn't valid (starts with underscore)
536
610
 
611
+ **Weaviate**:
612
+
613
+ Index names map to Weaviate collections, which:
614
+
615
+ - Are capitalized by Weaviate (the first letter is upper-cased)
616
+ - Should contain only letters, numbers, and the `_` character
617
+ - Must start with a letter, since only the first character is upper-cased (a leading digit or symbol stays invalid)
618
+ - Preserve the original Mastra index name in the collection description, so `listIndexes()` and `describeIndex()` return the name you supplied
619
+ - Example: `my_collection` is stored as `My_collection` and returned as `my_collection`
620
+ - Example: `123_collection` isn't valid (starts with a digit)
621
+
537
622
  **Cloudflare**:
538
623
 
539
624
  Index names must:
@@ -587,6 +672,17 @@ Index names must:
587
672
  - Example: `myindex-` isn't valid (ends with hyphen)
588
673
  - Example: `MyIndex` isn't valid (contains uppercase letters)
589
674
 
675
+ **Azure AI Search**:
676
+
677
+ Index names must:
678
+
679
+ - Use only lowercase letters, numbers, dashes (`-`), and underscore (`_`) characters
680
+ - Not start or end with a dash
681
+ - Be between 2 and 128 characters long
682
+ - Example: `my-index-123` and `my_index` are valid
683
+ - Example: `MyIndex` isn't valid (contains uppercase letters)
684
+ - Example: `my-index-` isn't valid (ends with a dash)
685
+
590
686
  ### Upserting Embeddings
591
687
 
592
688
  After creating an index, you can store embeddings along with their basic metadata:
@@ -650,7 +746,7 @@ Key metadata considerations:
650
746
 
651
747
  ## Deleting vectors
652
748
 
653
- 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.
749
+ 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.
654
750
 
655
751
  ### Delete by Metadata Filter
656
752
 
@@ -69,8 +69,6 @@ const store = new CouchbaseVector({
69
69
 
70
70
  **collectionName** (`string`): Name of the Couchbase collection to use
71
71
 
72
- **options** (`CouchbaseClientOptions`): Optional Couchbase client options
73
-
74
72
  ## Methods
75
73
 
76
74
  ### `createIndex()`
@@ -83,7 +81,7 @@ Creates a new vector index in Couchbase.
83
81
 
84
82
  **dimension** (`number`): Vector dimension (must match your embedding model)
85
83
 
86
- **metric** (`'cosine' | 'euclidean' | 'dotproduct'`): Distance metric for similarity search (Default: `cosine`)
84
+ **metric** (`'cosine' | 'euclidean' | 'dotproduct'`): Distance metric for similarity search (Default: `dotproduct`)
87
85
 
88
86
  ### `upsert()`
89
87
 
@@ -111,11 +109,9 @@ Searches for similar vectors.
111
109
 
112
110
  **topK** (`number`): Number of results to return (Default: `10`)
113
111
 
114
- **filter** (`Record<string, any>`): Metadata filters
115
-
116
- **includeVector** (`boolean`): Whether to include vector data in results (Default: `false`)
112
+ **filter** (`Record<string, any>`): Not supported. Filters passed here are ignored.
117
113
 
118
- **minScore** (`number`): Minimum similarity score threshold (Default: `0`)
114
+ **includeVector** (`boolean`): Not supported. Setting this to true throws an error. (Default: `false`)
119
115
 
120
116
  ### `describeIndex()`
121
117
 
@@ -135,7 +131,7 @@ interface IndexStats {
135
131
 
136
132
  ### `deleteIndex()`
137
133
 
138
- Deletes an index and all its data.
134
+ Deletes the Search index. Documents stored in the collection aren't deleted.
139
135
 
140
136
  **indexName** (`string`): Name of the index to delete
141
137
 
@@ -184,7 +180,6 @@ interface QueryResult {
184
180
  id: string
185
181
  score: number
186
182
  metadata: Record<string, any>
187
- vector?: number[] // Only included if includeVector is true
188
183
  }
189
184
  ```
190
185
 
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@mastra/couchbase",
3
- "version": "1.1.2",
3
+ "version": "1.1.3-alpha.0",
4
4
  "description": "Couchbase vector store provider for Mastra",
5
5
  "type": "module",
6
6
  "main": "dist/index.js",
@@ -23,17 +23,17 @@
23
23
  },
24
24
  "devDependencies": {
25
25
  "@types/node": "22.20.1",
26
- "@vitest/coverage-v8": "4.1.10",
27
- "@vitest/ui": "4.1.10",
26
+ "@vitest/coverage-v8": "4.1.11",
27
+ "@vitest/ui": "4.1.11",
28
28
  "eslint": "^10.7.0",
29
29
  "tsdown": "0.22.9",
30
30
  "tsx": "^4.23.1",
31
31
  "typescript": "^7.0.2",
32
- "vitest": "4.1.10",
33
- "@internal/lint": "0.0.130",
34
- "@internal/storage-test-utils": "0.0.126",
35
- "@internal/types-builder": "0.0.105",
36
- "@mastra/core": "1.64.0"
32
+ "vitest": "4.1.11",
33
+ "@internal/lint": "0.0.144",
34
+ "@internal/storage-test-utils": "0.0.140",
35
+ "@mastra/core": "1.78.1-alpha.0",
36
+ "@internal/types-builder": "0.0.119"
37
37
  },
38
38
  "peerDependencies": {
39
39
  "@mastra/core": ">=1.0.0-0 <2.0.0-0"