@mastra/upstash 1.0.0 → 1.0.1

package/dist/docs/{vectors/01-reference.md → references/reference-vectors-upstash.md}

@@ -1,34 +1,63 @@
-# Vectors API Reference
-
-> API reference for vectors - 1 entries
-
-
----
-
-## Reference: Upstash Vector Store
-
-> Documentation for the UpstashVector class in Mastra, which provides vector search using Upstash Vector.
+# Upstash Vector Store
 
 The UpstashVector class provides vector search using [Upstash Vector](https://upstash.com/vector), a serverless vector database service that provides vector similarity search with metadata filtering capabilities and hybrid search support.
 
 ## Constructor Options
 
+**url:** (`string`): Upstash Vector database URL
+
+**token:** (`string`): Upstash Vector API token
+
 ## Methods
 
 ### createIndex()
 
 Note: This method is a no-op for Upstash as indexes are created automatically.
 
+**indexName:** (`string`): Name of the index to create
+
+**dimension:** (`number`): Vector dimension (must match your embedding model)
+
+**metric?:** (`'cosine' | 'euclidean' | 'dotproduct'`): Distance metric for similarity search (Default: `cosine`)
+
 ### upsert()
 
+**indexName:** (`string`): Name of the index to upsert into
+
+**vectors:** (`number[][]`): Array of embedding vectors
+
+**sparseVectors?:** (`{ indices: number[], values: number[] }[]`): Array of sparse vectors for hybrid search. Each sparse vector must have matching indices and values arrays.
+
+**metadata?:** (`Record<string, any>[]`): Metadata for each vector
+
+**ids?:** (`string[]`): Optional vector IDs (auto-generated if not provided)
+
 ### query()
 
+**indexName:** (`string`): Name of the index to query
+
+**queryVector:** (`number[]`): Query vector to find similar vectors
+
+**sparseVector?:** (`{ indices: number[], values: number[] }`): Optional sparse vector for hybrid search. Must have matching indices and values arrays.
+
+**topK?:** (`number`): Number of results to return (Default: `10`)
+
+**filter?:** (`Record<string, any>`): Metadata filters for the query
+
+**includeVector?:** (`boolean`): Whether to include vectors in the results (Default: `false`)
+
+**fusionAlgorithm?:** (`FusionAlgorithm`): Algorithm used to combine dense and sparse search results in hybrid search (e.g., RRF - Reciprocal Rank Fusion)
+
+**queryMode?:** (`QueryMode`): Search mode: 'DENSE' for dense-only, 'SPARSE' for sparse-only, or 'HYBRID' for combined search
+
 ### listIndexes()
 
 Returns an array of index names (namespaces) as strings.
 
 ### describeIndex()
 
+**indexName:** (`string`): Name of the index to describe
+
 Returns:
 
 ```typescript
@@ -41,8 +70,16 @@ interface IndexStats {
 
 ### deleteIndex()
 
+**indexName:** (`string`): Name of the index (namespace) to delete
+
 ### updateVector()
 
+**indexName:** (`string`): Name of the index to update
+
+**id:** (`string`): ID of the item to update
+
+**update:** (`object`): Update object containing vector, sparse vector, and/or metadata
+
 The `update` object can have the following properties:
 
 - `vector` (optional): An array of numbers representing the new dense vector.
@@ -51,6 +88,10 @@ The `update` object can have the following properties:
 
 ### deleteVector()
 
+**indexName:** (`string`): Name of the index from which to delete the item
+
+**id:** (`string`): ID of the item to delete
+
 Attempts to delete an item by its ID from the specified index. Logs an error message if the deletion fails.
 
 ## Hybrid Vector Search
@@ -187,13 +228,33 @@ Embeddings are numeric vectors used by memory's `semanticRecall` to retrieve rel
 
 Install `fastembed` to get started:
 
+**npm**:
+
+```bash
+npm install @mastra/fastembed@latest
+```
+
+**pnpm**:
+
+```bash
+pnpm add @mastra/fastembed@latest
+```
+
+**Yarn**:
+
 ```bash
-npm install @mastra/fastembed@beta
+yarn add @mastra/fastembed@latest
+```
+
+**Bun**:
+
+```bash
+bun add @mastra/fastembed@latest
 ```
 
 Add the following to your agent:
 
-```typescript title="src/mastra/agents/example-upstash-agent.ts"
+```typescript
 import { Memory } from "@mastra/memory";
 import { Agent } from "@mastra/core/agent";
 import { UpstashStore, UpstashVector } from "@mastra/upstash";
@@ -230,4 +291,4 @@ export const upstashAgent = new Agent({
 
 ## Related
 
-- [Metadata Filters](../rag/metadata-filters)
+- [Metadata Filters](https://mastra.ai/reference/rag/metadata-filters)

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mastra/upstash",
-  "version": "1.0.0",
+  "version": "1.0.1",
   "description": "Upstash provider for Mastra - includes both vector and db storage capabilities",
   "type": "module",
   "main": "dist/index.js",
@@ -20,22 +20,22 @@
   },
   "license": "Apache-2.0",
   "dependencies": {
-    "@upstash/redis": "^1.36.0",
+    "@upstash/redis": "^1.36.2",
     "@upstash/vector": "^1.2.2"
   },
   "devDependencies": {
-    "@types/node": "22.13.17",
+    "@types/node": "22.19.7",
     "@vitest/coverage-v8": "4.0.12",
     "@vitest/ui": "4.0.12",
-    "dotenv": "^17.0.0",
+    "dotenv": "^17.2.3",
     "eslint": "^9.37.0",
-    "tsup": "^8.5.0",
+    "tsup": "^8.5.1",
     "typescript": "^5.9.3",
     "vitest": "4.0.16",
-    "@internal/lint": "0.0.54",
-    "@mastra/core": "1.0.0",
-    "@internal/storage-test-utils": "0.0.50",
-    "@internal/types-builder": "0.0.29"
+    "@internal/lint": "0.0.58",
+    "@internal/storage-test-utils": "0.0.54",
+    "@internal/types-builder": "0.0.33",
+    "@mastra/core": "1.3.0"
   },
   "peerDependencies": {
     "@mastra/core": ">=1.0.0-0 <2.0.0-0"
@@ -62,7 +62,6 @@
     "posttest": "docker compose down",
     "lint": "eslint .",
     "build:lib": "tsup --silent --config tsup.config.ts",
-    "build:docs": "pnpx tsx ../../scripts/generate-package-docs.ts stores/upstash",
     "build:watch": "tsup --watch --silent --config tsup.config.ts"
   }
 }

package/dist/docs/README.md

@@ -1,34 +0,0 @@
-# @mastra/upstash Documentation
-
-> Embedded documentation for coding agents
-
-## Quick Start
-
-```bash
-# Read the skill overview
-cat docs/SKILL.md
-
-# Get the source map
-cat docs/SOURCE_MAP.json
-
-# Read topic documentation
-cat docs/<topic>/01-overview.md
-```
-
-## Structure
-
-```
-docs/
-├── SKILL.md           # Entry point
-├── README.md          # This file
-├── SOURCE_MAP.json    # Export index
-├── memory/ (1 files)
-├── rag/ (2 files)
-├── storage/ (1 files)
-├── vectors/ (1 files)
-```
-
-## Version
-
-Package: @mastra/upstash
-Version: 1.0.0