@mastra/rag 0.1.23 → 0.2.0-alpha.1

package/.turbo/turbo-build.log

@@ -1,23 +1,23 @@
 
-> @mastra/rag@0.1.23-alpha.4 build /home/runner/work/mastra/mastra/packages/rag
+> @mastra/rag@0.2.0-alpha.1 build /home/runner/work/mastra/mastra/packages/rag
 > tsup src/index.ts --format esm,cjs --experimental-dts --clean --treeshake=smallest --splitting
 
 CLI Building entry: src/index.ts
 CLI Using tsconfig: tsconfig.json
 CLI tsup v8.4.0
 TSC Build start
-TSC ⚡️ Build success in 14504ms
+TSC ⚡️ Build success in 13960ms
 DTS Build start
 CLI Target: es2022
 Analysis will use the bundled TypeScript version 5.8.3
 Writing package typings: /home/runner/work/mastra/mastra/packages/rag/dist/_tsup-dts-rollup.d.ts
 Analysis will use the bundled TypeScript version 5.8.3
 Writing package typings: /home/runner/work/mastra/mastra/packages/rag/dist/_tsup-dts-rollup.d.cts
-DTS ⚡️ Build success in 13278ms
+DTS ⚡️ Build success in 14823ms
 CLI Cleaning output folder
 ESM Build start
 CJS Build start
-CJS dist/index.cjs 237.78 KB
-CJS ⚡️ Build success in 3717ms
-ESM dist/index.js 236.08 KB
-ESM ⚡️ Build success in 3718ms
+ESM dist/index.js 238.92 KB
+ESM ⚡️ Build success in 4442ms
+CJS dist/index.cjs 240.69 KB
+CJS ⚡️ Build success in 4451ms

package/CHANGELOG.md

@@ -1,5 +1,41 @@
 # @mastra/rag
 
+## 0.2.0-alpha.1
+
+### Minor Changes
+
+- 83da932: Move @mastra/core to peerdeps
+
+### Patch Changes
+
+- 4424836: [MASTRA-2591] Rag Tool Return Types
+- 8cdd799: [MASTRA-3078] added sources to return for vector query tool
+- 4f62987: update rerank weight sum to use big.js
+- Updated dependencies [b3a3d63]
+- Updated dependencies [344f453]
+- Updated dependencies [0a3ae6d]
+- Updated dependencies [95911be]
+- Updated dependencies [5eb5a99]
+- Updated dependencies [7e632c5]
+- Updated dependencies [1e9fbfa]
+- Updated dependencies [b2ae5aa]
+- Updated dependencies [a7292b0]
+- Updated dependencies [0dcb9f0]
+  - @mastra/core@0.10.0-alpha.1
+
+## 0.1.24-alpha.0
+
+### Patch Changes
+
+- Updated dependencies [f53a6ac]
+- Updated dependencies [eabdcd9]
+- Updated dependencies [90be034]
+- Updated dependencies [99f050a]
+- Updated dependencies [d0ee3c6]
+- Updated dependencies [23f258c]
+- Updated dependencies [2672a05]
+  - @mastra/core@0.9.5-alpha.0
+
 ## 0.1.23
 
 ### Patch Changes

package/dist/_tsup-dts-rollup.d.cts

@@ -3,9 +3,13 @@ import type { EmbeddingModel } from 'ai';
 import type { MastraLanguageModel } from '@mastra/core/agent';
 import type { MastraVector } from '@mastra/core/vector';
 import type { QueryResult } from '@mastra/core/vector';
+import type { QueryResult as QueryResult_2 } from '@mastra/core';
 import type { TiktokenEncoding } from 'js-tiktoken';
 import type { TiktokenModel } from 'js-tiktoken';
+import { Tool } from '@mastra/core/tools';
+import { ToolExecutionContext } from '@mastra/core';
 import type { VectorFilter } from '@mastra/core/vector/filter';
+import { z } from 'zod';
 
 /** @deprecated Import from @mastra/astra instead */
 declare const ASTRA_PROMPT = "When querying Astra, you can ONLY use the operators listed below. Any other operators will be rejected.\nImportant: Don't explain how to construct the filter - use the specified operators and fields to search the content and return relevant results.\nIf a user tries to give an explicit operator that is not supported, reject the filter entirely and let them know that the operator is not supported.\n\nBasic Comparison Operators:\n- $eq: Exact match (default when using field: value)\n  Example: { \"category\": \"electronics\" }\n- $ne: Not equal\n  Example: { \"category\": { \"$ne\": \"electronics\" } }\n- $gt: Greater than\n  Example: { \"price\": { \"$gt\": 100 } }\n- $gte: Greater than or equal\n  Example: { \"price\": { \"$gte\": 100 } }\n- $lt: Less than\n  Example: { \"price\": { \"$lt\": 100 } }\n- $lte: Less than or equal\n  Example: { \"price\": { \"$lte\": 100 } }\n\nArray Operators:\n- $in: Match any value in array\n  Example: { \"category\": { \"$in\": [\"electronics\", \"books\"] } }\n- $nin: Does not match any value in array\n  Example: { \"category\": { \"$nin\": [\"electronics\", \"books\"] } }\n- $all: Match all values in array\n  Example: { \"tags\": { \"$all\": [\"premium\", \"sale\"] } }\n\nLogical Operators:\n- $and: Logical AND (can be implicit or explicit)\n  Implicit Example: { \"price\": { \"$gt\": 100 }, \"category\": \"electronics\" }\n  Explicit Example: { \"$and\": [{ \"price\": { \"$gt\": 100 } }, { \"category\": \"electronics\" }] }\n- $or: Logical OR\n  Example: { \"$or\": [{ \"price\": { \"$lt\": 50 } }, { \"category\": \"books\" }] }\n- $not: Logical NOT\n  Example: { \"$not\": { \"category\": \"electronics\" } }\n\nElement Operators:\n- $exists: Check if field exists\n  Example: { \"rating\": { \"$exists\": true } }\n\nSpecial Operators:\n- $size: Array length check\n  Example: { \"tags\": { \"$size\": 2 } }\n\nRestrictions:\n- Regex patterns are not supported\n- Only $and, $or, and $not logical operators are supported\n- Nested fields are supported using dot notation\n- Multiple conditions on the same field are supported with both implicit and explicit $and\n- Empty arrays in $in/$nin will return no results\n- A non-empty array is required for $all operator\n- Only logical operators ($and, $or, $not) can be used at the top level\n- All other operators must be used within a field condition\n  Valid: { \"field\": { \"$gt\": 100 } }\n  Valid: { \"$and\": [...] }\n  Invalid: { \"$gt\": 100 }\n- Logical operators must contain field conditions, not direct operators\n  Valid: { \"$and\": [{ \"field\": { \"$gt\": 100 } }] }\n  Invalid: { \"$and\": [{ \"$gt\": 100 }] }\n- $not operator:\n  - Must be an object\n  - Cannot be empty\n  - Can be used at field level or top level\n  - Valid: { \"$not\": { \"field\": \"value\" } }\n  - Valid: { \"field\": { \"$not\": { \"$eq\": \"value\" } } }\n- Other logical operators ($and, $or):\n  - Can only be used at top level or nested within other logical operators\n  - Can not be used on a field level, or be nested inside a field\n  - Can not be used inside an operator\n  - Valid: { \"$and\": [{ \"field\": { \"$gt\": 100 } }] }\n  - Valid: { \"$or\": [{ \"$and\": [{ \"field\": { \"$gt\": 100 } }] }] }\n  - Invalid: { \"field\": { \"$and\": [{ \"$gt\": 100 }] } }\n  - Invalid: { \"field\": { \"$or\": [{ \"$gt\": 100 }] } }\n  - Invalid: { \"field\": { \"$gt\": { \"$and\": [{...}] } } }\n\nExample Complex Query:\n{\n  \"$and\": [\n    { \"category\": { \"$in\": [\"electronics\", \"computers\"] } },\n    { \"price\": { \"$gte\": 100, \"$lte\": 1000 } },\n    { \"tags\": { \"$all\": [\"premium\"] } },\n    { \"rating\": { \"$exists\": true, \"$gt\": 4 } },\n    { \"$or\": [\n      { \"stock\": { \"$gt\": 0 } },\n      { \"preorder\": true }\n    ]}\n  ]\n}";
@@ -143,6 +147,19 @@ declare type ChunkStrategy = 'recursive' | 'character' | 'token' | 'markdown' |
 export { ChunkStrategy }
 export { ChunkStrategy as ChunkStrategy_alias_1 }
 
+/**
+ * Convert an array of source inputs (QueryResult, RankedNode, or RerankResult) to an array of sources.
+ * @param results Array of source inputs to convert.
+ * @returns Array of sources.
+ */
+export declare const convertToSources: (results: SourceInput[]) => {
+    id: string;
+    vector: number[];
+    score: number;
+    metadata: Record<string, any> | undefined;
+    document: string;
+}[];
+
 declare const createDocumentChunkerTool: ({ doc, params, }: {
     doc: MDocument;
     params?: ChunkParams;
@@ -151,11 +168,12 @@ export { createDocumentChunkerTool }
 export { createDocumentChunkerTool as createDocumentChunkerTool_alias_1 }
 export { createDocumentChunkerTool as createDocumentChunkerTool_alias_2 }
 
-declare const createGraphRAGTool: ({ vectorStoreName, indexName, model, enableFilter, graphOptions, id, description, }: {
+declare const createGraphRAGTool: ({ vectorStoreName, indexName, model, enableFilter, includeSources, graphOptions, id, description, }: {
     vectorStoreName: string;
     indexName: string;
     model: EmbeddingModel<string>;
     enableFilter?: boolean;
+    includeSources?: boolean;
     graphOptions?: {
         dimension?: number;
         randomWalkSteps?: number;
@@ -164,20 +182,258 @@ declare const createGraphRAGTool: ({ vectorStoreName, indexName, model, enableFi
     };
     id?: string;
     description?: string;
-}) => ReturnType<typeof createTool>;
+}) => Tool<z.ZodObject<{
+queryText: z.ZodString;
+topK: z.ZodNumber;
+}, "passthrough", z.ZodTypeAny, z.objectOutputType<{
+queryText: z.ZodString;
+topK: z.ZodNumber;
+}, z.ZodTypeAny, "passthrough">, z.objectInputType<{
+queryText: z.ZodString;
+topK: z.ZodNumber;
+}, z.ZodTypeAny, "passthrough">>, z.ZodObject<{
+relevantContext: z.ZodAny;
+sources: z.ZodArray<z.ZodObject<{
+id: z.ZodString;
+metadata: z.ZodAny;
+vector: z.ZodArray<z.ZodNumber, "many">;
+score: z.ZodNumber;
+document: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+id: string;
+vector: number[];
+score: number;
+document: string;
+metadata?: any;
+}, {
+id: string;
+vector: number[];
+score: number;
+document: string;
+metadata?: any;
+}>, "many">;
+}, "strip", z.ZodTypeAny, {
+sources: {
+id: string;
+vector: number[];
+score: number;
+document: string;
+metadata?: any;
+}[];
+relevantContext?: any;
+}, {
+sources: {
+id: string;
+vector: number[];
+score: number;
+document: string;
+metadata?: any;
+}[];
+relevantContext?: any;
+}>, ToolExecutionContext<z.ZodObject<{
+queryText: z.ZodString;
+topK: z.ZodNumber;
+}, "passthrough", z.ZodTypeAny, z.objectOutputType<{
+queryText: z.ZodString;
+topK: z.ZodNumber;
+}, z.ZodTypeAny, "passthrough">, z.objectInputType<{
+queryText: z.ZodString;
+topK: z.ZodNumber;
+}, z.ZodTypeAny, "passthrough">>>> & {
+    inputSchema: z.ZodObject<{
+        queryText: z.ZodString;
+        topK: z.ZodNumber;
+    }, "passthrough", z.ZodTypeAny, z.objectOutputType<{
+        queryText: z.ZodString;
+        topK: z.ZodNumber;
+    }, z.ZodTypeAny, "passthrough">, z.objectInputType<{
+        queryText: z.ZodString;
+        topK: z.ZodNumber;
+    }, z.ZodTypeAny, "passthrough">>;
+    outputSchema: z.ZodObject<{
+        relevantContext: z.ZodAny;
+        sources: z.ZodArray<z.ZodObject<{
+            id: z.ZodString;
+            metadata: z.ZodAny;
+            vector: z.ZodArray<z.ZodNumber, "many">;
+            score: z.ZodNumber;
+            document: z.ZodString;
+        }, "strip", z.ZodTypeAny, {
+            id: string;
+            vector: number[];
+            score: number;
+            document: string;
+            metadata?: any;
+        }, {
+            id: string;
+            vector: number[];
+            score: number;
+            document: string;
+            metadata?: any;
+        }>, "many">;
+    }, "strip", z.ZodTypeAny, {
+        sources: {
+            id: string;
+            vector: number[];
+            score: number;
+            document: string;
+            metadata?: any;
+        }[];
+        relevantContext?: any;
+    }, {
+        sources: {
+            id: string;
+            vector: number[];
+            score: number;
+            document: string;
+            metadata?: any;
+        }[];
+        relevantContext?: any;
+    }>;
+    execute: (context: ToolExecutionContext<z.ZodObject<{
+    queryText: z.ZodString;
+    topK: z.ZodNumber;
+    }, "passthrough", z.ZodTypeAny, z.objectOutputType<{
+    queryText: z.ZodString;
+    topK: z.ZodNumber;
+    }, z.ZodTypeAny, "passthrough">, z.objectInputType<{
+    queryText: z.ZodString;
+    topK: z.ZodNumber;
+    }, z.ZodTypeAny, "passthrough">>>) => Promise<any>;
+};
 export { createGraphRAGTool }
 export { createGraphRAGTool as createGraphRAGTool_alias_1 }
 export { createGraphRAGTool as createGraphRAGTool_alias_2 }
 
-declare const createVectorQueryTool: ({ vectorStoreName, indexName, model, enableFilter, reranker, id, description, }: {
+declare const createVectorQueryTool: ({ vectorStoreName, indexName, model, enableFilter, includeVectors, includeSources, reranker, id, description, }: {
     vectorStoreName: string;
     indexName: string;
     model: EmbeddingModel<string>;
     enableFilter?: boolean;
+    includeVectors?: boolean;
+    includeSources?: boolean;
     reranker?: RerankConfig;
     id?: string;
     description?: string;
-}) => ReturnType<typeof createTool>;
+}) => Tool<z.ZodObject<{
+queryText: z.ZodString;
+topK: z.ZodNumber;
+}, "passthrough", z.ZodTypeAny, z.objectOutputType<{
+queryText: z.ZodString;
+topK: z.ZodNumber;
+}, z.ZodTypeAny, "passthrough">, z.objectInputType<{
+queryText: z.ZodString;
+topK: z.ZodNumber;
+}, z.ZodTypeAny, "passthrough">>, z.ZodObject<{
+relevantContext: z.ZodAny;
+sources: z.ZodArray<z.ZodObject<{
+id: z.ZodString;
+metadata: z.ZodAny;
+vector: z.ZodArray<z.ZodNumber, "many">;
+score: z.ZodNumber;
+document: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+id: string;
+vector: number[];
+score: number;
+document: string;
+metadata?: any;
+}, {
+id: string;
+vector: number[];
+score: number;
+document: string;
+metadata?: any;
+}>, "many">;
+}, "strip", z.ZodTypeAny, {
+sources: {
+id: string;
+vector: number[];
+score: number;
+document: string;
+metadata?: any;
+}[];
+relevantContext?: any;
+}, {
+sources: {
+id: string;
+vector: number[];
+score: number;
+document: string;
+metadata?: any;
+}[];
+relevantContext?: any;
+}>, ToolExecutionContext<z.ZodObject<{
+queryText: z.ZodString;
+topK: z.ZodNumber;
+}, "passthrough", z.ZodTypeAny, z.objectOutputType<{
+queryText: z.ZodString;
+topK: z.ZodNumber;
+}, z.ZodTypeAny, "passthrough">, z.objectInputType<{
+queryText: z.ZodString;
+topK: z.ZodNumber;
+}, z.ZodTypeAny, "passthrough">>>> & {
+    inputSchema: z.ZodObject<{
+        queryText: z.ZodString;
+        topK: z.ZodNumber;
+    }, "passthrough", z.ZodTypeAny, z.objectOutputType<{
+        queryText: z.ZodString;
+        topK: z.ZodNumber;
+    }, z.ZodTypeAny, "passthrough">, z.objectInputType<{
+        queryText: z.ZodString;
+        topK: z.ZodNumber;
+    }, z.ZodTypeAny, "passthrough">>;
+    outputSchema: z.ZodObject<{
+        relevantContext: z.ZodAny;
+        sources: z.ZodArray<z.ZodObject<{
+            id: z.ZodString;
+            metadata: z.ZodAny;
+            vector: z.ZodArray<z.ZodNumber, "many">;
+            score: z.ZodNumber;
+            document: z.ZodString;
+        }, "strip", z.ZodTypeAny, {
+            id: string;
+            vector: number[];
+            score: number;
+            document: string;
+            metadata?: any;
+        }, {
+            id: string;
+            vector: number[];
+            score: number;
+            document: string;
+            metadata?: any;
+        }>, "many">;
+    }, "strip", z.ZodTypeAny, {
+        sources: {
+            id: string;
+            vector: number[];
+            score: number;
+            document: string;
+            metadata?: any;
+        }[];
+        relevantContext?: any;
+    }, {
+        sources: {
+            id: string;
+            vector: number[];
+            score: number;
+            document: string;
+            metadata?: any;
+        }[];
+        relevantContext?: any;
+    }>;
+    execute: (context: ToolExecutionContext<z.ZodObject<{
+    queryText: z.ZodString;
+    topK: z.ZodNumber;
+    }, "passthrough", z.ZodTypeAny, z.objectOutputType<{
+    queryText: z.ZodString;
+    topK: z.ZodNumber;
+    }, z.ZodTypeAny, "passthrough">, z.objectInputType<{
+    queryText: z.ZodString;
+    topK: z.ZodNumber;
+    }, z.ZodTypeAny, "passthrough">>>) => Promise<any>;
+};
 export { createVectorQueryTool }
 export { createVectorQueryTool as createVectorQueryTool_alias_1 }
 export { createVectorQueryTool as createVectorQueryTool_alias_2 }
@@ -622,7 +878,7 @@ declare class QuestionsAnsweredExtractor extends BaseExtractor {
 export { QuestionsAnsweredExtractor }
 export { QuestionsAnsweredExtractor as QuestionsAnsweredExtractor_alias_1 }
 
-declare interface RankedNode extends GraphNode {
+export declare interface RankedNode extends GraphNode {
     score: number;
 }
 
@@ -796,6 +1052,8 @@ declare interface ScoringDetails {
     };
 }
 
+declare type SourceInput = QueryResult_2 | RankedNode | RerankResult;
+
 export declare function splitTextOnTokens({ text, tokenizer }: {
     text: string;
     tokenizer: Tokenizer;