@mastra/rag 0.1.8-alpha.10 → 0.1.8-alpha.11

package/.turbo/turbo-build.log

@@ -1,23 +1,23 @@
 
-> @mastra/rag@0.1.8-alpha.10 build /home/runner/work/mastra/mastra/packages/rag
+> @mastra/rag@0.1.8-alpha.11 build /home/runner/work/mastra/mastra/packages/rag
 > tsup src/index.ts --format esm,cjs --experimental-dts --clean --treeshake
 
 CLI Building entry: src/index.ts
 CLI Using tsconfig: tsconfig.json
 CLI tsup v8.3.6
 TSC Build start
-TSC ⚡️ Build success in 27998ms
+TSC ⚡️ Build success in 21457ms
 DTS Build start
 CLI Target: es2022
 Analysis will use the bundled TypeScript version 5.7.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.7.3
 Writing package typings: /home/runner/work/mastra/mastra/packages/rag/dist/_tsup-dts-rollup.d.cts
-DTS ⚡️ Build success in 34113ms
+DTS ⚡️ Build success in 14197ms
 CLI Cleaning output folder
 ESM Build start
 CJS Build start
-CJS dist/index.cjs 90.62 KB
-CJS ⚡️ Build success in 1827ms
-ESM dist/index.js 89.94 KB
-ESM ⚡️ Build success in 1831ms
+CJS dist/index.cjs 90.75 KB
+CJS ⚡️ Build success in 740ms
+ESM dist/index.js 90.06 KB
+ESM ⚡️ Build success in 741ms

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # @mastra/rag
 
+## 0.1.8-alpha.11
+
+### Patch Changes
+
+- aec08af: Update vector query tool to change input schema depending on filter enabled
+
 ## 0.1.8-alpha.10
 
 ### Patch Changes

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

@@ -143,7 +143,7 @@ declare type ExtractParams = {
 export { ExtractParams }
 export { ExtractParams as ExtractParams_alias_1 }
 
-declare const filterDescription = "JSON-formatted criteria to refine search results.\n- Uses provided filter if specified\n- Default: {} (no filtering)\n- Example: {\"category\": \"health\"}\n- Must be valid JSON format\n- Based on query intent\n- Multiple filters can be combined";
+declare const filterDescription = "JSON-formatted criteria to refine search results.\n- Must be valid JSON format\n- Uses provided filter if specified\n- Default: \"{}\" (no filtering)\n- Example: '{\"category\": \"health\"}'\n- Based on query intent\n- Multiple filters can be combined";
 export { filterDescription }
 export { filterDescription as filterDescription_alias_1 }
 export { filterDescription as filterDescription_alias_2 }
@@ -608,7 +608,7 @@ export declare class TokenTransformer extends TextTransformer {
     }): TokenTransformer;
 }
 
-declare const topKDescription = "Controls how many matching documents to return.\n- Uses provided value if specified\n- Default: 10 results\n- Higher values provide more context\n- Lower values focus on best matches\n- Must be a valid number\n- Based on query requirements";
+declare const topKDescription = "Controls how many matching documents to return.\n- Must be a valid number\n- Uses provided value if specified\n- Default: 10 results\n- Higher values provide more context\n- Lower values focus on best matches\n- Based on query requirements";
 export { topKDescription }
 export { topKDescription as topKDescription_alias_1 }
 export { topKDescription as topKDescription_alias_2 }

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

@@ -143,7 +143,7 @@ declare type ExtractParams = {
 export { ExtractParams }
 export { ExtractParams as ExtractParams_alias_1 }
 
-declare const filterDescription = "JSON-formatted criteria to refine search results.\n- Uses provided filter if specified\n- Default: {} (no filtering)\n- Example: {\"category\": \"health\"}\n- Must be valid JSON format\n- Based on query intent\n- Multiple filters can be combined";
+declare const filterDescription = "JSON-formatted criteria to refine search results.\n- Must be valid JSON format\n- Uses provided filter if specified\n- Default: \"{}\" (no filtering)\n- Example: '{\"category\": \"health\"}'\n- Based on query intent\n- Multiple filters can be combined";
 export { filterDescription }
 export { filterDescription as filterDescription_alias_1 }
 export { filterDescription as filterDescription_alias_2 }
@@ -608,7 +608,7 @@ export declare class TokenTransformer extends TextTransformer {
     }): TokenTransformer;
 }
 
-declare const topKDescription = "Controls how many matching documents to return.\n- Uses provided value if specified\n- Default: 10 results\n- Higher values provide more context\n- Lower values focus on best matches\n- Must be a valid number\n- Based on query requirements";
+declare const topKDescription = "Controls how many matching documents to return.\n- Must be a valid number\n- Uses provided value if specified\n- Default: 10 results\n- Higher values provide more context\n- Lower values focus on best matches\n- Based on query requirements";
 export { topKDescription }
 export { topKDescription as topKDescription_alias_1 }
 export { topKDescription as topKDescription_alias_2 }

package/dist/index.cjs

@@ -1814,17 +1814,17 @@ var vectorQuerySearch = async ({
 var defaultVectorQueryDescription = () => `Access the knowledge base to find information needed to answer user questions.`;
 var defaultGraphRagDescription = () => `Access and analyze relationships between information in the knowledge base to answer complex questions about connections and patterns.`;
 var topKDescription = `Controls how many matching documents to return.
+- Must be a valid number
 - Uses provided value if specified
 - Default: 10 results
 - Higher values provide more context
 - Lower values focus on best matches
-- Must be a valid number
 - Based on query requirements`;
 var filterDescription = `JSON-formatted criteria to refine search results.
-- Uses provided filter if specified
-- Default: {} (no filtering)
-- Example: {"category": "health"}
 - Must be valid JSON format
+- Uses provided filter if specified
+- Default: "{}" (no filtering)
+- Example: '{"category": "health"}'
 - Based on query intent
 - Multiple filters can be combined`;
 
@@ -1922,13 +1922,17 @@ var createVectorQueryTool = ({
 }) => {
   const toolId = id || `VectorQuery ${vectorStoreName} ${indexName} Tool`;
   const toolDescription = description || defaultVectorQueryDescription();
+  const baseSchema = {
+    queryText: zod.z.string().describe("The text query to search for in the vector database"),
+    topK: zod.z.coerce.number().describe(topKDescription)
+  };
+  const inputSchema = enableFilter ? zod.z.object({
+    ...baseSchema,
+    filter: zod.z.coerce.string().describe(filterDescription)
+  }).strict() : zod.z.object(baseSchema).strict();
   return tools.createTool({
     id: toolId,
-    inputSchema: zod.z.object({
-      queryText: zod.z.string().describe("The text query to search for in the vector database"),
-      topK: zod.z.number().describe(topKDescription),
-      filter: zod.z.string().describe(filterDescription)
-    }),
+    inputSchema,
     outputSchema: zod.z.object({
       relevantContext: zod.z.any()
     }),
@@ -1937,14 +1941,14 @@ var createVectorQueryTool = ({
       const vectorStore = mastra?.vectors?.[vectorStoreName];
       if (vectorStore) {
         let queryFilter = {};
-        if (enableFilter) {
-          queryFilter = filter ? (() => {
+        if (enableFilter && filter) {
+          queryFilter = (() => {
             try {
               return JSON.parse(filter);
             } catch {
               return filter;
             }
-          })() : filter;
+          })();
         }
         if (mastra.logger) {
           mastra.logger.debug("Using this filter and topK:", { queryFilter, topK });

package/dist/index.js

@@ -1812,17 +1812,17 @@ var vectorQuerySearch = async ({
 var defaultVectorQueryDescription = () => `Access the knowledge base to find information needed to answer user questions.`;
 var defaultGraphRagDescription = () => `Access and analyze relationships between information in the knowledge base to answer complex questions about connections and patterns.`;
 var topKDescription = `Controls how many matching documents to return.
+- Must be a valid number
 - Uses provided value if specified
 - Default: 10 results
 - Higher values provide more context
 - Lower values focus on best matches
-- Must be a valid number
 - Based on query requirements`;
 var filterDescription = `JSON-formatted criteria to refine search results.
-- Uses provided filter if specified
-- Default: {} (no filtering)
-- Example: {"category": "health"}
 - Must be valid JSON format
+- Uses provided filter if specified
+- Default: "{}" (no filtering)
+- Example: '{"category": "health"}'
 - Based on query intent
 - Multiple filters can be combined`;
 
@@ -1920,13 +1920,17 @@ var createVectorQueryTool = ({
 }) => {
   const toolId = id || `VectorQuery ${vectorStoreName} ${indexName} Tool`;
   const toolDescription = description || defaultVectorQueryDescription();
+  const baseSchema = {
+    queryText: z.string().describe("The text query to search for in the vector database"),
+    topK: z.coerce.number().describe(topKDescription)
+  };
+  const inputSchema = enableFilter ? z.object({
+    ...baseSchema,
+    filter: z.coerce.string().describe(filterDescription)
+  }).strict() : z.object(baseSchema).strict();
   return createTool({
     id: toolId,
-    inputSchema: z.object({
-      queryText: z.string().describe("The text query to search for in the vector database"),
-      topK: z.number().describe(topKDescription),
-      filter: z.string().describe(filterDescription)
-    }),
+    inputSchema,
     outputSchema: z.object({
       relevantContext: z.any()
     }),
@@ -1935,14 +1939,14 @@ var createVectorQueryTool = ({
       const vectorStore = mastra?.vectors?.[vectorStoreName];
       if (vectorStore) {
         let queryFilter = {};
-        if (enableFilter) {
-          queryFilter = filter ? (() => {
+        if (enableFilter && filter) {
+          queryFilter = (() => {
             try {
               return JSON.parse(filter);
             } catch {
               return filter;
             }
-          })() : filter;
+          })();
         }
         if (mastra.logger) {
           mastra.logger.debug("Using this filter and topK:", { queryFilter, topK });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mastra/rag",
-  "version": "0.1.8-alpha.10",
+  "version": "0.1.8-alpha.11",
   "description": "",
   "type": "module",
   "main": "dist/index.js",

package/src/tools/vector-query.test.ts

@@ -0,0 +1,239 @@
+import { describe, it, expect, vi, beforeEach } from 'vitest';
+import { vectorQuerySearch } from '../utils';
+import { createVectorQueryTool } from './vector-query';
+
+// Mock dependencies
+vi.mock('@mastra/core/tools', () => ({
+  createTool: vi.fn(({ inputSchema, execute }) => ({
+    inputSchema,
+    execute,
+    // Return a simplified version of the tool for testing
+    __inputSchema: inputSchema,
+  })),
+}));
+
+vi.mock('../utils', () => ({
+  vectorQuerySearch: vi.fn().mockResolvedValue({ results: [] }),
+  defaultVectorQueryDescription: () => 'Default vector query description',
+  filterDescription: 'Filter description',
+  topKDescription: 'Top K description',
+}));
+
+describe('createVectorQueryTool', () => {
+  const mockModel = { name: 'test-model' } as any;
+  const mockMastra = {
+    vectors: {
+      testStore: {
+        // Mock vector store methods
+      },
+    },
+    logger: {
+      debug: vi.fn(),
+    },
+  };
+
+  beforeEach(() => {
+    vi.clearAllMocks();
+  });
+
+  describe('input schema validation', () => {
+    it('should make filter invalid when enableFilter is false', () => {
+      // Create tool with enableFilter set to false
+      const tool = createVectorQueryTool({
+        vectorStoreName: 'testStore',
+        indexName: 'testIndex',
+        model: mockModel,
+        enableFilter: false,
+      });
+
+      // Get the Zod schema
+      const schema = tool.__inputSchema;
+
+      // Test with no filter (should be valid)
+      const validInput = {
+        queryText: 'test query',
+        topK: 5,
+      };
+      expect(() => schema.parse(validInput)).not.toThrow();
+
+      // Test with filter (should throw - unexpected property)
+      const inputWithFilter = {
+        ...validInput,
+        filter: '{"field": "value"}',
+      };
+      expect(() => schema.parse(inputWithFilter)).toThrow();
+    });
+
+    it('should handle filter permissively when enableFilter is true', () => {
+      const tool = createVectorQueryTool({
+        vectorStoreName: 'testStore',
+        indexName: 'testIndex',
+        model: mockModel,
+        enableFilter: true,
+      });
+
+      // Get the Zod schema
+      const schema = tool.__inputSchema;
+
+      // Test various filter inputs that should all work
+      const testCases = [
+        // String inputs
+        { filter: '{"field": "value"}' },
+        { filter: '{}' },
+        { filter: 'simple-string' },
+        // Object inputs (should be coerced to strings)
+        { filter: { field: 'value' } },
+        { filter: {} },
+        // Numbers (should be coerced)
+        { filter: 123 },
+        // Empty/null values (should be coerced)
+        { filter: '' },
+        { filter: null },
+        { filter: undefined },
+      ];
+
+      testCases.forEach(({ filter }) => {
+        expect(() =>
+          schema.parse({
+            queryText: 'test query',
+            topK: 5,
+            filter,
+          }),
+        ).not.toThrow();
+      });
+
+      // Verify that all parsed values are strings
+      testCases.forEach(({ filter }) => {
+        const result = schema.parse({
+          queryText: 'test query',
+          topK: 5,
+          filter,
+        });
+        expect(typeof result.filter).toBe('string');
+      });
+    });
+
+    it('should reject unexpected properties in both modes', () => {
+      // Test with enableFilter false
+      const toolWithoutFilter = createVectorQueryTool({
+        vectorStoreName: 'testStore',
+        indexName: 'testIndex',
+        model: mockModel,
+        enableFilter: false,
+      });
+
+      // Should reject unexpected property
+      expect(() =>
+        toolWithoutFilter.__inputSchema.parse({
+          queryText: 'test query',
+          topK: 5,
+          unexpectedProp: 'value',
+        }),
+      ).toThrow();
+
+      // Test with enableFilter true
+      const toolWithFilter = createVectorQueryTool({
+        vectorStoreName: 'testStore',
+        indexName: 'testIndex',
+        model: mockModel,
+        enableFilter: true,
+      });
+
+      // Should reject unexpected property even with valid filter
+      expect(() =>
+        toolWithFilter.__inputSchema.parse({
+          queryText: 'test query',
+          topK: 5,
+          filter: '{}',
+          unexpectedProp: 'value',
+        }),
+      ).toThrow();
+    });
+  });
+
+  describe('execute function', () => {
+    it('should not process filter when enableFilter is false', async () => {
+      // Create tool with enableFilter set to false
+      const tool = createVectorQueryTool({
+        vectorStoreName: 'testStore',
+        indexName: 'testIndex',
+        model: mockModel,
+        enableFilter: false,
+      });
+
+      // Execute with no filter
+      await tool.execute({
+        context: {
+          queryText: 'test query',
+          topK: 5,
+        },
+        mastra: mockMastra,
+      });
+
+      // Check that vectorQuerySearch was called with undefined queryFilter
+      expect(vectorQuerySearch).toHaveBeenCalledWith(
+        expect.objectContaining({
+          queryFilter: undefined,
+        }),
+      );
+    });
+
+    it('should process filter when enableFilter is true and filter is provided', async () => {
+      // Create tool with enableFilter set to true
+      const tool = createVectorQueryTool({
+        vectorStoreName: 'testStore',
+        indexName: 'testIndex',
+        model: mockModel,
+        enableFilter: true,
+      });
+
+      const filterJson = '{"field": "value"}';
+
+      // Execute with filter
+      await tool.execute({
+        context: {
+          queryText: 'test query',
+          topK: 5,
+          filter: filterJson,
+        },
+        mastra: mockMastra,
+      });
+
+      // Check that vectorQuerySearch was called with the parsed filter
+      expect(vectorQuerySearch).toHaveBeenCalledWith(
+        expect.objectContaining({
+          queryFilter: { field: 'value' },
+        }),
+      );
+    });
+
+    it('should handle string filters correctly', async () => {
+      // Create tool with enableFilter set to true
+      const tool = createVectorQueryTool({
+        vectorStoreName: 'testStore',
+        indexName: 'testIndex',
+        model: mockModel,
+        enableFilter: true,
+      });
+
+      const stringFilter = 'string-filter';
+
+      // Execute with string filter
+      await tool.execute({
+        context: {
+          queryText: 'test query',
+          topK: 5,
+          filter: stringFilter,
+        },
+        mastra: mockMastra,
+      });
+
+      // Check that vectorQuerySearch was called with the string filter
+      expect(vectorQuerySearch).toHaveBeenCalledWith(
+        expect.objectContaining({
+          queryFilter: 'string-filter',
+        }),
+      );
+    });
+  });
+});

package/src/tools/vector-query.ts

@@ -25,13 +25,22 @@ export const createVectorQueryTool = ({
 }): ReturnType<typeof createTool> => {
   const toolId = id || `VectorQuery ${vectorStoreName} ${indexName} Tool`;
   const toolDescription = description || defaultVectorQueryDescription();
+  // Create base schema with required fields
+  const baseSchema = {
+    queryText: z.string().describe('The text query to search for in the vector database'),
+    topK: z.coerce.number().describe(topKDescription),
+  };
+  const inputSchema = enableFilter
+    ? z
+        .object({
+          ...baseSchema,
+          filter: z.coerce.string().describe(filterDescription),
+        })
+        .strict()
+    : z.object(baseSchema).strict();
   return createTool({
     id: toolId,
-    inputSchema: z.object({
-      queryText: z.string().describe('The text query to search for in the vector database'),
-      topK: z.number().describe(topKDescription),
-      filter: z.string().describe(filterDescription),
-    }),
+    inputSchema,
     outputSchema: z.object({
       relevantContext: z.any(),
     }),
@@ -42,16 +51,14 @@ export const createVectorQueryTool = ({
       // Get relevant chunks from the vector database
       if (vectorStore) {
         let queryFilter = {};
-        if (enableFilter) {
-          queryFilter = filter
-            ? (() => {
-                try {
-                  return JSON.parse(filter);
-                } catch {
-                  return filter;
-                }
-              })()
-            : filter;
+        if (enableFilter && filter) {
+          queryFilter = (() => {
+            try {
+              return JSON.parse(filter);
+            } catch {
+              return filter;
+            }
+          })();
         }
         if (mastra.logger) {
           mastra.logger.debug('Using this filter and topK:', { queryFilter, topK });

package/src/utils/default-settings.ts

@@ -5,17 +5,17 @@ export const defaultGraphRagDescription = () =>
   `Access and analyze relationships between information in the knowledge base to answer complex questions about connections and patterns.`;
 
 export const topKDescription = `Controls how many matching documents to return.
+- Must be a valid number
 - Uses provided value if specified
 - Default: 10 results
 - Higher values provide more context
 - Lower values focus on best matches
-- Must be a valid number
 - Based on query requirements`;
 
 export const filterDescription = `JSON-formatted criteria to refine search results.
-- Uses provided filter if specified
-- Default: {} (no filtering)
-- Example: {"category": "health"}
 - Must be valid JSON format
+- Uses provided filter if specified
+- Default: "{}" (no filtering)
+- Example: '{"category": "health"}'
 - Based on query intent
 - Multiple filters can be combined`;