@mastra/rag 2.1.2 → 2.1.3-alpha.0

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

@@ -2,7 +2,7 @@
 
 The `createVectorQueryTool()` function creates a tool for semantic search over vector stores. It supports filtering, reranking, database-specific configurations, and integrates with various vector store backends.
 
-## Basic Usage
+## Basic usage
 
 ```typescript
 import { createVectorQueryTool } from '@mastra/rag'
@@ -19,55 +19,67 @@ const queryTool = createVectorQueryTool({
 
 > **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.
 
-**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'. (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.)
+**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. (Set at creation only.)
 
-**vectorStoreName:** (`string`): Name of the vector store to query. (Can be set at creation or overridden at runtime.)
+**vectorStoreName** (`string`): Name of the vector store to query. (Can be set at creation or overridden at runtime.)
 
-**indexName:** (`string`): Name of the index within the vector store. (Can be set at creation or overridden at runtime.)
+**indexName** (`string`): Name of the index within the vector store. (Can be set at creation or overridden at runtime.)
 
-**enableFilter?:** (`boolean`): Enable filtering of results based on metadata. (Set at creation only, but will be automatically enabled if a filter is provided in the request context.) (Default: `false`)
+**enableFilter** (`boolean`): Enable filtering of results based on metadata. (Set at creation only, but will be automatically enabled if a filter is provided in the request context.) (Default: `false`)
 
-**includeVectors?:** (`boolean`): Include the embedding vectors in the results. (Can be set at creation or overridden at runtime.) (Default: `false`)
+**includeVectors** (`boolean`): Include the embedding vectors in the results. (Can be set at creation or overridden at runtime.) (Default: `false`)
 
-**includeSources?:** (`boolean`): Include the full retrieval objects in the results. (Can be set at creation or overridden at runtime.) (Default: `true`)
+**includeSources** (`boolean`): Include the full retrieval objects in the results. (Can be set at creation or overridden at runtime.) (Default: `true`)
 
-**reranker?:** (`RerankConfig`): Options for reranking results. (Can be set at creation or overridden at runtime.)
+**reranker** (`RerankConfig`): Options for reranking results. (Can be set at creation or overridden at runtime.)
 
-**databaseConfig?:** (`DatabaseConfig`): Database-specific configuration options for optimizing queries. (Can be set at creation or overridden at runtime.)
+**reranker.model** (`MastraLanguageModel`): Language model to use for reranking
 
-**providerOptions?:** (`Record<string, Record<string, any>>`): Provider-specific options for the embedding model (e.g., outputDimensionality). \*\*Important\*\*: Only works with AI SDK EmbeddingModelV2 models. For V1 models, configure options when creating the model itself.
+**reranker.options** (`RerankerOptions`): Options for the reranking process
 
-**vectorStore?:** (`MastraVector | VectorStoreResolver`): Direct vector store instance or a resolver function for dynamic selection. Use a function for multi-tenant applications where the vector store is selected based on request context. When provided, \`vectorStoreName\` becomes optional.
+**reranker.options.weights** (`WeightConfig`): Weights for scoring components (semantic: 0.4, vector: 0.4, position: 0.2)
 
-### DatabaseConfig
+**reranker.options.topK** (`number`): Number of top results to return
 
-The `DatabaseConfig` type allows you to specify database-specific configurations that are automatically applied to query operations. This enables you to take advantage of unique features and optimizations offered by different vector stores.
+**databaseConfig** (`DatabaseConfig`): Database-specific configuration options for optimizing queries. (Can be set at creation or overridden at runtime.)
 
-**pinecone?:** (`PineconeConfig`): objectnamespace?:stringPinecone namespace for organizing vectorssparseVector?:{ indices: number\[]; values: number\[]; }Sparse vector for hybrid search
+**databaseConfig.pinecone** (`PineconeConfig`): Configuration specific to Pinecone vector store
 
-**pgvector?:** (`PgVectorConfig`): objectminScore?:numberMinimum similarity score threshold for resultsef?:numberHNSW search parameter - controls accuracy vs speed tradeoffprobes?:numberIVFFlat probe parameter - number of cells to visit during search
+**databaseConfig.pinecone.namespace** (`string`): Pinecone namespace for organizing vectors
 
-**chroma?:** (`ChromaConfig`): objectwhere?:Record\<string, any>Metadata filtering conditionswhereDocument?:Record\<string, any>Document content filtering conditions
+**databaseConfig.pinecone.sparseVector** (`{ indices: number[]; values: number[]; }`): Sparse vector for hybrid search
 
-### RerankConfig
+**databaseConfig.pgvector** (`PgVectorConfig`): Configuration specific to PostgreSQL with pgvector extension
 
-**model:** (`MastraLanguageModel`): Language model to use for reranking
+**databaseConfig.pgvector.minScore** (`number`): Minimum similarity score threshold for results
 
-**options?:** (`RerankerOptions`): objectweights?:WeightConfigWeights for scoring components (semantic: 0.4, vector: 0.4, position: 0.2)topK?:numberNumber of top results to return
+**databaseConfig.pgvector.ef** (`number`): HNSW search parameter - controls accuracy vs speed tradeoff
+
+**databaseConfig.pgvector.probes** (`number`): IVFFlat probe parameter - number of cells to visit during search
+
+**databaseConfig.chroma** (`ChromaConfig`): Configuration specific to Chroma vector store
+
+**databaseConfig.chroma.where** (`Record<string, any>`): Metadata filtering conditions
+
+**databaseConfig.chroma.whereDocument** (`Record<string, any>`): Document content filtering conditions
+
+**providerOptions** (`Record<string, Record<string, any>>`): Provider-specific options for the embedding model (e.g., outputDimensionality). \*\*Important\*\*: Only works with AI SDK EmbeddingModelV2 models. For V1 models, configure options when creating the model itself.
+
+**vectorStore** (`MastraVector | VectorStoreResolver`): Direct vector store instance or a resolver function for dynamic selection. Use a function for multi-tenant applications where the vector store is selected based on request context. When provided, \`vectorStoreName\` becomes optional.
 
 ## Returns
 
 The tool returns an object with:
 
-**relevantContext:** (`string`): Combined text from the most relevant document chunks
+**relevantContext** (`string`): Combined text from the most relevant document chunks
 
-**sources:** (`QueryResult[]`): Array of full retrieval result objects. Each object contains all information needed to reference the original document, chunk, and similarity score.
+**sources** (`QueryResult[]`): Array of full retrieval result objects. Each object contains all information needed to reference the original document, chunk, and similarity score.
 
-### QueryResult object structure
+### `QueryResult` object structure
 
 ```typescript
 {
@@ -79,7 +91,7 @@ The tool returns an object with:
 }
 ```
 
-## Default Tool Description
+## Default tool description
 
 The default description focuses on:
 
@@ -87,11 +99,11 @@ The default description focuses on:
 - Answering user questions
 - Retrieving factual content
 
-## Result Handling
+## Result handling
 
 The tool determines the number of results to return based on the user's query, with a default of 10 results. This can be adjusted based on the query requirements.
 
-## Example with Filters
+## Example with filters
 
 ```typescript
 const queryTool = createVectorQueryTool({
@@ -122,7 +134,7 @@ For detailed filter syntax and store-specific capabilities, see the [Metadata Fi
 
 For an example of how agent-driven filtering works, see the [Agent-Driven Metadata Filtering](https://github.com/mastra-ai/mastra/tree/main/examples/basics/rag/filter-rag) example.
 
-## Example with Reranking
+## Example with reranking
 
 ```typescript
 const queryTool = createVectorQueryTool({
@@ -130,7 +142,7 @@ const queryTool = createVectorQueryTool({
   indexName: 'documentation',
   model: new ModelRouterEmbeddingModel('openai/text-embedding-3-small'),
   reranker: {
-    model: 'openai/gpt-5.1',
+    model: 'openai/gpt-5.4',
     options: {
       weights: {
         semantic: 0.5, // Semantic relevance weight
@@ -152,7 +164,7 @@ Reranking improves result quality by combining:
 
 The reranker processes the initial vector search results and returns a reordered list optimized for relevance.
 
-## Example with Custom Description
+## Example with custom description
 
 ```typescript
 const queryTool = createVectorQueryTool({
@@ -166,7 +178,7 @@ const queryTool = createVectorQueryTool({
 
 This example shows how to customize the tool description for a specific use case while maintaining its core purpose of information retrieval.
 
-## Database-Specific Configuration Examples
+## Database-specific configuration examples
 
 The `databaseConfig` parameter allows you to leverage unique features and optimizations specific to each vector database. These configurations are automatically applied during query execution.
 
@@ -323,7 +335,7 @@ This approach allows you to:
 - Adjust performance parameters based on load
 - Apply different filtering strategies per request
 
-## Example: Using Request Context
+## Example: Using request context
 
 ```typescript
 const queryTool = createVectorQueryTool({
@@ -362,7 +374,7 @@ For more information on request context, please see:
 - [Agent Request Context](https://mastra.ai/docs/server/request-context)
 - [Request Context](https://mastra.ai/docs/server/request-context)
 
-## Usage Without a Mastra Server
+## Usage without a Mastra server
 
 The tool can be used by itself to retrieve documents matching a query:
 
@@ -389,7 +401,7 @@ const queryResult = await vectorQueryTool.execute({ queryText: 'foo', topK: 1 },
 console.log(queryResult.sources)
 ```
 
-## Dynamic Vector Store for Multi-Tenant Applications
+## Dynamic vector store for multi-tenant applications
 
 For multi-tenant applications where each tenant has isolated data (e.g., separate PostgreSQL schemas), you can pass a resolver function instead of a static vector store instance. The function receives the request context and can return the appropriate vector store for the current tenant:
 
@@ -445,7 +457,7 @@ This pattern is similar to how `Agent.memory` supports dynamic configuration and
 - **Database isolation**: Route to different database instances per tenant
 - **Dynamic configuration**: Adjust vector store settings based on request context
 
-## Tool Details
+## Tool details
 
 The tool is created with:
 

package/dist/document/validation.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"validation.d.ts","sourceRoot":"","sources":["../../src/document/validation.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,SAAS,CAAC;AAsH7C,wBAAgB,mBAAmB,CAAC,QAAQ,EAAE,aAAa,EAAE,MAAM,EAAE,GAAG,GAAG,IAAI,CAsB9E"}
+{"version":3,"file":"validation.d.ts","sourceRoot":"","sources":["../../src/document/validation.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,SAAS,CAAC;AAsH7C,wBAAgB,mBAAmB,CAAC,QAAQ,EAAE,aAAa,EAAE,MAAM,EAAE,GAAG,GAAG,IAAI,CAwB9E"}

package/dist/index.cjs

@@ -735,7 +735,7 @@ var customAlphabet = (alphabet, defaultSize = 21) => {
   };
 };
 
-// ../../node_modules/.pnpm/@ai-sdk+provider-utils@2.2.8_zod@3.25.76/node_modules/@ai-sdk/provider-utils/dist/index.mjs
+// ../../node_modules/.pnpm/@ai-sdk+provider-utils@2.2.8_zod@4.3.6/node_modules/@ai-sdk/provider-utils/dist/index.mjs
 var import_secure_json_parse = __toESM(require_secure_json_parse());
 function combineHeaders(...headers) {
   return headers.reduce(
@@ -6644,12 +6644,13 @@ function validateChunkParams(strategy, params) {
   }
   const result = schema.safeParse(params);
   if (!result.success) {
-    const unrecognizedError = result.error.errors.find((e) => e.code === "unrecognized_keys");
+    const issues = result.error.issues;
+    const unrecognizedError = issues.find((e) => e.code === "unrecognized_keys");
     if (unrecognizedError && "keys" in unrecognizedError) {
       const keys = unrecognizedError.keys.join(", ");
       throw new Error(`Invalid parameters for ${strategy} strategy: '${keys}' not supported`);
     }
-    const errorMessage = result.error.errors.map((e) => `${e.path.length > 0 ? e.path.join(".") : "parameter"}: ${e.message}`).join(", ");
+    const errorMessage = issues.map((e) => `${e.path.length > 0 ? e.path.join(".") : "parameter"}: ${e.message}`).join(", ");
     throw new Error(`Invalid parameters for ${strategy} strategy: ${errorMessage}`);
   }
 }
@@ -7696,7 +7697,7 @@ var createGraphRAGTool = (options) => {
         const vectorStore = await resolveVectorStore(options, { requestContext, mastra, vectorStoreName });
         if (!vectorStore) {
           if (logger) {
-            logger.error(`Vector store '${vectorStoreName}' not found`);
+            logger.error("Vector store not found", { vectorStore: vectorStoreName });
           }
           return { relevantContext: [], sources: [] };
         }
@@ -7801,7 +7802,7 @@ var createVectorQueryTool = (options) => {
         const vectorStore = await resolveVectorStore(options, { requestContext, mastra, vectorStoreName });
         if (!vectorStore) {
           if (logger) {
-            logger.error(`Vector store '${vectorStoreName}' not found`);
+            logger.error("Vector store not found", { vectorStore: vectorStoreName });
           }
           return { relevantContext: [], sources: [] };
         }