@mastra/rag 2.6.7 → 2.6.8-alpha.0

package/dist/docs/SKILL.md

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

package/dist/docs/assets/SOURCE_MAP.json

@@ -1,5 +1,5 @@
 {
-  "version": "2.6.7",
+  "version": "2.6.8-alpha.0",
   "package": "@mastra/rag",
   "exports": {},
   "modules": {}

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

@@ -83,7 +83,7 @@ Returns an array of `RankedNode` objects, where each node contains:
 
 **content** (`string`): Text content of the document chunk
 
-**metadata** (`Record<string, any>`): Additional metadata associated with the chunk
+**metadata** (`Record<string, any>`): Additional metadata associated with the chunk, when present
 
 **score** (`number`): Combined relevance score from graph traversal
 

package/dist/docs/references/reference-tools-document-chunker-tool.md

@@ -20,9 +20,9 @@ const chunker = createDocumentChunkerTool({
   doc: document,
   params: {
     strategy: 'recursive',
-    size: 512,
+    maxSize: 512,
     overlap: 50,
-    separator: '\n',
+    separators: ['\n'],
   },
 })
 
@@ -39,11 +39,11 @@ const { chunks } = await chunker.execute()
 
 **strategy** (`'recursive'`): The chunking strategy to use (Default: `'recursive'`)
 
-**size** (`number`): Target size of each chunk in tokens/characters (Default: `512`)
+**maxSize** (`number`): Maximum size of each chunk in tokens/characters (Default: `512`)
 
 **overlap** (`number`): Number of overlapping tokens/characters between chunks (Default: `50`)
 
-**separator** (`string`): Character(s) to use as chunk separator (Default: `'\n'`)
+**separators** (`string[]`): Separators to split on, in order of priority (recursive strategy) (Default: `['\n']`)
 
 ## Returns
 
@@ -64,9 +64,9 @@ const chunker = createDocumentChunkerTool({
   doc: technicalDoc,
   params: {
     strategy: 'recursive',
-    size: 1024, // Larger chunks
+    maxSize: 1024, // Larger chunks
     overlap: 100, // More overlap
-    separator: '\n\n', // Split on double newlines
+    separators: ['\n\n'], // Split on double newlines
   },
 })
 
@@ -82,8 +82,8 @@ chunks.forEach((chunk, index) => {
 
 The chunker is created as a Mastra tool with the following properties:
 
-- **Tool ID**: `Document Chunker {strategy} {size}`
-- **Description**: `Chunks document using {strategy} strategy with size {size} and {overlap} overlap`
+- **Tool ID**: `Document Chunker {strategy} {maxSize}`
+- **Description**: `Chunks document using {strategy} strategy with maxSize {maxSize} and {overlap} overlap`
 - **Input Schema**: Empty object (no additional inputs required)
 - **Output Schema**: Object containing the chunks array
 

package/dist/docs/references/reference-tools-vector-query-tool.md

@@ -21,13 +21,13 @@ const queryTool = createVectorQueryTool({
 
 ## Parameters
 
-> **Note:** **Parameter Requirements:** Most fields can be set at creation as defaults. Some fields can be overridden at runtime via the request context or input. If a required field is missing from both creation and runtime, an error will be thrown. Note that `model`, `id`, and `description` can only be set at creation time.
+> **Note:** **Parameter Requirements:** Most fields can be set at creation as defaults. Some fields can be overridden at runtime via the request context or input. If a required field is missing from both creation and runtime, an error will be thrown. Note that `id` and `description` can only be set at creation time.
 
-**id** (`string`): Custom ID for the tool. By default: 'VectorQuery {vectorStoreName} {indexName} Tool'. (Set at creation only.)
+**id** (`string`): Custom ID for the tool. By default: 'VectorQuery {vectorStoreName} {indexName} Tool', where {vectorStoreName} is 'DirectVectorStore' when a vectorStore instance is passed without a vectorStoreName. (Set at creation only.)
 
 **description** (`string`): Custom description for the tool. By default: 'Access the knowledge base to find information needed to answer user questions' (Set at creation only.)
 
-**model** (`EmbeddingModel`): Embedding model to use for vector search. (Set at creation only.)
+**model** (`EmbeddingModel`): Embedding model to use for vector search. (Can be set at creation or overridden at runtime via the request context.)
 
 **vectorStoreName** (`string`): Name of the vector store to query. (Can be set at creation or overridden at runtime.)
 
@@ -47,7 +47,7 @@ const queryTool = createVectorQueryTool({
 
 **reranker.options.weights** (`WeightConfig`): Weights for scoring components (semantic: 0.4, vector: 0.4, position: 0.2)
 
-**reranker.options.topK** (`number`): Number of top results to return
+**reranker.options.topK** (`number`): Number of top results to return after reranking. Falls back to the query's topK (from the request context, the tool input, or 10) when unset or 0.
 
 **databaseConfig** (`DatabaseConfig`): Database-specific configuration options for optimizing queries. (Can be set at creation or overridden at runtime.)
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mastra/rag",
-  "version": "2.6.7",
+  "version": "2.6.8-alpha.0",
   "description": "",
   "type": "module",
   "main": "dist/index.js",
@@ -50,10 +50,10 @@
     "typescript": "^7.0.2",
     "vitest": "4.1.11",
     "zod": "^4.6.4",
-    "@internal/lint": "0.0.142",
-    "@internal/ai-sdk-v4": "0.0.89",
-    "@internal/types-builder": "0.0.117",
-    "@mastra/core": "1.76.0"
+    "@internal/lint": "0.0.144",
+    "@internal/ai-sdk-v4": "0.0.91",
+    "@internal/types-builder": "0.0.119",
+    "@mastra/core": "1.78.1-alpha.0"
   },
   "keywords": [
     "rag",