@mastra/chroma 0.0.0-switch-to-core-20250424015131 → 0.0.0-vector-query-sources-20250516172905

package/src/vector/index.test.ts

@@ -16,7 +16,7 @@ describe('ChromaVector Integration Tests', () => {
   beforeEach(async () => {
     // Clean up any existing test index
     try {
-      await vectorDB.deleteIndex(testIndexName);
+      await vectorDB.deleteIndex({ indexName: testIndexName });
     } catch {
       // Ignore errors if index doesn't exist
     }
@@ -26,7 +26,7 @@ describe('ChromaVector Integration Tests', () => {
   afterEach(async () => {
     // Cleanup after tests
     try {
-      await vectorDB.deleteIndex(testIndexName);
+      await vectorDB.deleteIndex({ indexName: testIndexName });
     } catch {
       // Ignore cleanup errors
     }
@@ -39,14 +39,14 @@ describe('ChromaVector Integration Tests', () => {
     });
 
     it('should describe index correctly', async () => {
-      const stats: IndexStats = await vectorDB.describeIndex(testIndexName);
+      const stats: IndexStats = await vectorDB.describeIndex({ indexName: testIndexName });
       expect(stats.dimension).toBe(dimension);
       expect(stats.count).toBe(0);
       expect(stats.metric).toBe('cosine');
     });
 
     it('should delete index', async () => {
-      await vectorDB.deleteIndex(testIndexName);
+      await vectorDB.deleteIndex({ indexName: testIndexName });
       const indexes = await vectorDB.listIndexes();
       expect(indexes).not.toContain(testIndexName);
     });
@@ -58,10 +58,10 @@ describe('ChromaVector Integration Tests', () => {
         const testIndex = `test-index-${metric}`;
         await vectorDB.createIndex({ indexName: testIndex, dimension, metric });
 
-        const stats = await vectorDB.describeIndex(testIndex);
+        const stats = await vectorDB.describeIndex({ indexName: testIndex });
         expect(stats.metric).toBe(metric);
 
-        await vectorDB.deleteIndex(testIndex);
+        await vectorDB.deleteIndex({ indexName: testIndex });
       }
     });
   });
@@ -80,14 +80,14 @@ describe('ChromaVector Integration Tests', () => {
       expect(ids).toHaveLength(testVectors.length);
       ids.forEach(id => expect(typeof id).toBe('string'));
 
-      const stats = await vectorDB.describeIndex(testIndexName);
+      const stats = await vectorDB.describeIndex({ indexName: testIndexName });
       expect(stats.count).toBe(testVectors.length);
     });
 
     it('should upsert vectors with provided ids and metadata', async () => {
       await vectorDB.upsert({ indexName: testIndexName, vectors: testVectors, metadata: testMetadata, ids: testIds });
 
-      const stats = await vectorDB.describeIndex(testIndexName);
+      const stats = await vectorDB.describeIndex({ indexName: testIndexName });
       expect(stats.count).toBe(testVectors.length);
 
       // Query each vector to verify metadata
@@ -133,7 +133,7 @@ describe('ChromaVector Integration Tests', () => {
         metadata: newMetaData,
       };
 
-      await vectorDB.updateIndexById(testIndexName, idToBeUpdated, update);
+      await vectorDB.updateVector({ indexName: testIndexName, id: idToBeUpdated, update });
 
       const results: QueryResult[] = await vectorDB.query({
         indexName: testIndexName,
@@ -159,7 +159,7 @@ describe('ChromaVector Integration Tests', () => {
         metadata: newMetaData,
       };
 
-      await vectorDB.updateIndexById(testIndexName, idToBeUpdated, update);
+      await vectorDB.updateVector({ indexName: testIndexName, id: idToBeUpdated, update });
 
       const results: QueryResult[] = await vectorDB.query({
         indexName: testIndexName,
@@ -183,7 +183,7 @@ describe('ChromaVector Integration Tests', () => {
         vector: newVector,
       };
 
-      await vectorDB.updateIndexById(testIndexName, idToBeUpdated, update);
+      await vectorDB.updateVector({ indexName: testIndexName, id: idToBeUpdated, update });
 
       const results: QueryResult[] = await vectorDB.query({
         indexName: testIndexName,
@@ -196,7 +196,9 @@ describe('ChromaVector Integration Tests', () => {
     });
 
     it('should throw exception when no updates are given', async () => {
-      await expect(vectorDB.updateIndexById(testIndexName, 'id', {})).rejects.toThrow('No updates provided');
+      await expect(vectorDB.updateVector({ indexName: testIndexName, id: 'id', update: {} })).rejects.toThrow(
+        'No updates provided',
+      );
     });
 
     it('should delete the vector by id', async () => {
@@ -204,7 +206,7 @@ describe('ChromaVector Integration Tests', () => {
       expect(ids).toHaveLength(3);
       const idToBeDeleted = ids[0];
 
-      await vectorDB.deleteIndexById(testIndexName, idToBeDeleted);
+      await vectorDB.deleteVector({ indexName: testIndexName, id: idToBeDeleted });
 
       const results: QueryResult[] = await vectorDB.query({
         indexName: testIndexName,
@@ -273,8 +275,17 @@ describe('ChromaVector Integration Tests', () => {
   });
 
   describe('Error Handling', () => {
+    const testIndexName = 'test_index_error';
+    beforeAll(async () => {
+      await vectorDB.createIndex({ indexName: testIndexName, dimension: 3 });
+    });
+
+    afterAll(async () => {
+      await vectorDB.deleteIndex({ indexName: testIndexName });
+    });
+
     it('should handle non-existent index queries', async () => {
-      await expect(vectorDB.query({ indexName: 'non-existent-index-yu', queryVector: [1, 2, 3] })).rejects.toThrow();
+      await expect(vectorDB.query({ indexName: 'non-existent-index', queryVector: [1, 2, 3] })).rejects.toThrow();
     });
 
     it('should handle invalid dimension vectors', async () => {
@@ -282,10 +293,59 @@ describe('ChromaVector Integration Tests', () => {
       await expect(vectorDB.upsert({ indexName: testIndexName, vectors: [invalidVector] })).rejects.toThrow();
     });
 
-    it('should handle mismatched metadata and vectors length', async () => {
-      const vectors = [[1, 2, 3]];
-      const metadata = [{}, {}]; // More metadata than vectors
-      await expect(vectorDB.upsert({ indexName: testIndexName, vectors, metadata })).rejects.toThrow();
+    it('should handle duplicate index creation gracefully', async () => {
+      const infoSpy = vi.spyOn(vectorDB['logger'], 'info');
+      const warnSpy = vi.spyOn(vectorDB['logger'], 'warn');
+
+      const duplicateIndexName = `duplicate-test`;
+      const dimension = 768;
+
+      try {
+        // Create index first time
+        await vectorDB.createIndex({
+          indexName: duplicateIndexName,
+          dimension,
+          metric: 'cosine',
+        });
+
+        // Try to create with same dimensions - should not throw
+        await expect(
+          vectorDB.createIndex({
+            indexName: duplicateIndexName,
+            dimension,
+            metric: 'cosine',
+          }),
+        ).resolves.not.toThrow();
+
+        expect(infoSpy).toHaveBeenCalledWith(expect.stringContaining('already exists with'));
+
+        // Try to create with same dimensions and different metric - should not throw
+        await expect(
+          vectorDB.createIndex({
+            indexName: duplicateIndexName,
+            dimension,
+            metric: 'euclidean',
+          }),
+        ).resolves.not.toThrow();
+
+        expect(warnSpy).toHaveBeenCalledWith(expect.stringContaining('Attempted to create index with metric'));
+
+        // Try to create with different dimensions - should throw
+        await expect(
+          vectorDB.createIndex({
+            indexName: duplicateIndexName,
+            dimension: dimension + 1,
+            metric: 'cosine',
+          }),
+        ).rejects.toThrow(
+          `Index "${duplicateIndexName}" already exists with ${dimension} dimensions, but ${dimension + 1} dimensions were requested`,
+        );
+      } finally {
+        infoSpy.mockRestore();
+        warnSpy.mockRestore();
+        // Cleanup
+        await vectorDB.deleteIndex({ indexName: duplicateIndexName });
+      }
     });
   });
 
@@ -461,7 +521,7 @@ describe('ChromaVector Integration Tests', () => {
     // Set up test vectors and metadata
     beforeAll(async () => {
       try {
-        await vectorDB.deleteIndex(testIndexName2);
+        await vectorDB.deleteIndex({ indexName: testIndexName2 });
       } catch {
         // Ignore errors if index doesn't exist
       }
@@ -509,7 +569,7 @@ describe('ChromaVector Integration Tests', () => {
     afterAll(async () => {
       // Cleanup after tests
       try {
-        await vectorDB.deleteIndex(testIndexName2);
+        await vectorDB.deleteIndex({ indexName: testIndexName2 });
       } catch {
         // Ignore cleanup errors
       }
@@ -1180,7 +1240,7 @@ describe('ChromaVector Integration Tests', () => {
 
     beforeAll(async () => {
       try {
-        await vectorDB.deleteIndex(testIndexName3);
+        await vectorDB.deleteIndex({ indexName: testIndexName3 });
       } catch {
         // Ignore errors if index doesn't exist
       }
@@ -1214,7 +1274,7 @@ describe('ChromaVector Integration Tests', () => {
     afterAll(async () => {
       // Cleanup after tests
       try {
-        await vectorDB.deleteIndex(testIndexName3);
+        await vectorDB.deleteIndex({ indexName: testIndexName3 });
       } catch {
         // Ignore cleanup errors
       }
@@ -1410,17 +1470,17 @@ describe('ChromaVector Integration Tests', () => {
     let warnSpy;
 
     beforeAll(async () => {
-      await vectorDB.createIndex({ indexName: indexName, dimension: 3 });
+      await vectorDB.createIndex({ indexName, dimension: 3 });
     });
 
     afterAll(async () => {
       try {
-        await vectorDB.deleteIndex(indexName);
+        await vectorDB.deleteIndex({ indexName });
       } catch {
         // Ignore errors if index doesn't exist
       }
       try {
-        await vectorDB.deleteIndex(indexName2);
+        await vectorDB.deleteIndex({ indexName: indexName2 });
       } catch {
         // Ignore errors if index doesn't exist
       }
@@ -1433,7 +1493,7 @@ describe('ChromaVector Integration Tests', () => {
     afterEach(async () => {
       warnSpy.mockRestore();
       try {
-        await vectorDB.deleteIndex(indexName2);
+        await vectorDB.deleteIndex({ indexName: indexName2 });
       } catch {
         // Ignore errors if index doesn't exist
       }
@@ -1517,7 +1577,7 @@ describe('ChromaVector Integration Tests', () => {
 
     beforeEach(async () => {
       try {
-        await vectorDB.deleteIndex(perfTestIndex);
+        await vectorDB.deleteIndex({ indexName: perfTestIndex });
       } catch {
         // Ignore errors if index doesn't exist
       }
@@ -1526,7 +1586,7 @@ describe('ChromaVector Integration Tests', () => {
 
     afterEach(async () => {
       try {
-        await vectorDB.deleteIndex(perfTestIndex);
+        await vectorDB.deleteIndex({ indexName: perfTestIndex });
       } catch {
         // Ignore cleanup errors
       }
@@ -1569,7 +1629,7 @@ describe('ChromaVector Integration Tests', () => {
       });
 
       // Verify all vectors were inserted
-      const stats = await vectorDB.describeIndex(perfTestIndex);
+      const stats = await vectorDB.describeIndex({ indexName: perfTestIndex });
       expect(stats.count).toBe(batchSize);
 
       const results = await vectorDB.query({

package/src/vector/index.ts

@@ -8,6 +8,10 @@ import type {
   ParamsToArgs,
   QueryVectorArgs,
   UpsertVectorArgs,
+  DescribeIndexParams,
+  DeleteIndexParams,
+  DeleteVectorParams,
+  UpdateVectorParams,
 } from '@mastra/core/vector';
 
 import type { VectorFilter } from '@mastra/core/vector/filter';
@@ -80,7 +84,7 @@ export class ChromaVector extends MastraVector {
     const collection = await this.getCollection(indexName);
 
     // Get index stats to check dimension
-    const stats = await this.describeIndex(indexName);
+    const stats = await this.describeIndex({ indexName });
 
     // Validate vector dimensions
     this.validateVectorDimensions(vectors, stats.dimension);
@@ -111,7 +115,6 @@ export class ChromaVector extends MastraVector {
 
   async createIndex(...args: ParamsToArgs<CreateIndexParams>): Promise<void> {
     const params = this.normalizeArgs<CreateIndexParams>('createIndex', args);
-
     const { indexName, dimension, metric = 'cosine' } = params;
 
     if (!Number.isInteger(dimension) || dimension <= 0) {
@@ -121,13 +124,24 @@ export class ChromaVector extends MastraVector {
     if (!['cosine', 'l2', 'ip'].includes(hnswSpace)) {
       throw new Error(`Invalid metric: "${metric}". Must be one of: cosine, euclidean, dotproduct`);
     }
-    await this.client.createCollection({
-      name: indexName,
-      metadata: {
-        dimension,
-        'hnsw:space': this.HnswSpaceMap[metric],
-      },
-    });
+    try {
+      await this.client.createCollection({
+        name: indexName,
+        metadata: {
+          dimension,
+          'hnsw:space': hnswSpace,
+        },
+      });
+    } catch (error: any) {
+      // Check for 'already exists' error
+      const message = error?.message || error?.toString();
+      if (message && message.toLowerCase().includes('already exists')) {
+        // Fetch collection info and check dimension
+        await this.validateExistingIndex(indexName, dimension, metric);
+        return;
+      }
+      throw error;
+    }
   }
 
   transformFilter(filter?: VectorFilter) {
@@ -167,7 +181,17 @@ export class ChromaVector extends MastraVector {
     return collections.map(collection => collection);
   }
 
-  async describeIndex(indexName: string): Promise<IndexStats> {
+  /**
+   * Retrieves statistics about a vector index.
+   *
+   * @param params - The parameters for describing an index
+   * @param params.indexName - The name of the index to describe
+   * @returns A promise that resolves to the index statistics including dimension, count and metric
+   */
+  async describeIndex(...args: ParamsToArgs<DescribeIndexParams>): Promise<IndexStats> {
+    const params = this.normalizeArgs<DescribeIndexParams>('describeIndex', args);
+    const { indexName } = params;
+
     const collection = await this.getCollection(indexName);
     const count = await collection.count();
     const metadata = collection.metadata;
@@ -181,41 +205,108 @@ export class ChromaVector extends MastraVector {
     };
   }
 
-  async deleteIndex(indexName: string): Promise<void> {
+  async deleteIndex(...args: ParamsToArgs<DeleteIndexParams>): Promise<void> {
+    const params = this.normalizeArgs<DeleteIndexParams>('deleteIndex', args);
+    const { indexName } = params;
     await this.client.deleteCollection({ name: indexName });
     this.collections.delete(indexName);
   }
 
+  /**
+   * @deprecated Use {@link updateVector} instead. This method will be removed on May 20th, 2025.
+   *
+   * Updates a vector by its ID with the provided vector and/or metadata.
+   * @param indexName - The name of the index containing the vector.
+   * @param id - The ID of the vector to update.
+   * @param update - An object containing the vector and/or metadata to update.
+   * @param update.vector - An optional array of numbers representing the new vector.
+   * @param update.metadata - An optional record containing the new metadata.
+   * @returns A promise that resolves when the update is complete.
+   * @throws Will throw an error if no updates are provided or if the update operation fails.
+   */
   async updateIndexById(
     indexName: string,
     id: string,
     update: { vector?: number[]; metadata?: Record<string, any> },
   ): Promise<void> {
-    if (!update.vector && !update.metadata) {
-      throw new Error('No updates provided');
-    }
+    this.logger.warn(
+      `Deprecation Warning: updateIndexById() is deprecated. 
+    Please use updateVector() instead. 
+    updateIndexById() will be removed on May 20th, 2025.`,
+    );
+    await this.updateVector({ indexName, id, update });
+  }
 
-    const collection: Collection = await this.getCollection(indexName, true);
+  /**
+   * Updates a vector by its ID with the provided vector and/or metadata.
+   * @param indexName - The name of the index containing the vector.
+   * @param id - The ID of the vector to update.
+   * @param update - An object containing the vector and/or metadata to update.
+   * @param update.vector - An optional array of numbers representing the new vector.
+   * @param update.metadata - An optional record containing the new metadata.
+   * @returns A promise that resolves when the update is complete.
+   * @throws Will throw an error if no updates are provided or if the update operation fails.
+   */
+  async updateVector(...args: ParamsToArgs<UpdateVectorParams>): Promise<void> {
+    const params = this.normalizeArgs<UpdateVectorParams>('updateVector', args);
+    const { indexName, id, update } = params;
+    try {
+      if (!update.vector && !update.metadata) {
+        throw new Error('No updates provided');
+      }
 
-    const updateOptions: UpdateRecordsParams = { ids: [id] };
+      const collection: Collection = await this.getCollection(indexName, true);
 
-    if (update?.vector) {
-      updateOptions.embeddings = [update.vector];
-    }
+      const updateOptions: UpdateRecordsParams = { ids: [id] };
 
-    if (update?.metadata) {
-      updateOptions.metadatas = [update.metadata];
-    }
+      if (update?.vector) {
+        const stats = await this.describeIndex({ indexName });
+        this.validateVectorDimensions([update.vector], stats.dimension);
+        updateOptions.embeddings = [update.vector];
+      }
+
+      if (update?.metadata) {
+        updateOptions.metadatas = [update.metadata];
+      }
 
-    return await collection.update(updateOptions);
+      return await collection.update(updateOptions);
+    } catch (error: any) {
+      throw new Error(`Failed to update vector by id: ${id} for index name: ${indexName}: ${error.message}`);
+    }
   }
 
+  /**
+   * @deprecated Use {@link deleteVector} instead. This method will be removed on May 20th, 2025.
+   *
+   * Deletes a vector by its ID.
+   * @param indexName - The name of the index containing the vector.
+   * @param id - The ID of the vector to delete.
+   * @returns A promise that resolves when the deletion is complete.
+   * @throws Will throw an error if the deletion operation fails.
+   */
   async deleteIndexById(indexName: string, id: string): Promise<void> {
+    this.logger.warn(
+      `Deprecation Warning: deleteIndexById() is deprecated. Please use deleteVector() instead. deleteIndexById() will be removed on May 20th.`,
+    );
+    await this.deleteVector(indexName, id);
+  }
+
+  /**
+   * Deletes a vector by its ID.
+   * @param indexName - The name of the index containing the vector.
+   * @param id - The ID of the vector to delete.
+   * @returns A promise that resolves when the deletion is complete.
+   * @throws Will throw an error if the deletion operation fails.
+   */
+  async deleteVector(...args: ParamsToArgs<DeleteVectorParams>): Promise<void> {
+    const params = this.normalizeArgs<DeleteVectorParams>('deleteVector', args);
+
+    const { indexName, id } = params;
     try {
       const collection: Collection = await this.getCollection(indexName, true);
       await collection.delete({ ids: [id] });
     } catch (error: any) {
-      throw new Error(`Failed to delete index by id: ${id} for index name: ${indexName}: ${error.message}`);
+      throw new Error(`Failed to delete vector by id: ${id} for index name: ${indexName}: ${error.message}`);
     }
   }
 }

package/src/vector/prompt.ts

@@ -0,0 +1,72 @@
+/**
+ * Vector store specific prompt that details supported operators and examples.
+ * This prompt helps users construct valid filters for Chroma Vector.
+ */
+export const CHROMA_PROMPT = `When querying Chroma, you can ONLY use the operators listed below. Any other operators will be rejected.
+Important: Don't explain how to construct the filter - use the specified operators and fields to search the content and return relevant results.
+If 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.
+
+Basic Comparison Operators:
+- $eq: Exact match (default when using field: value)
+  Example: { "category": "electronics" }
+- $ne: Not equal
+  Example: { "category": { "$ne": "electronics" } }
+- $gt: Greater than
+  Example: { "price": { "$gt": 100 } }
+- $gte: Greater than or equal
+  Example: { "price": { "$gte": 100 } }
+- $lt: Less than
+  Example: { "price": { "$lt": 100 } }
+- $lte: Less than or equal
+  Example: { "price": { "$lte": 100 } }
+
+Array Operators:
+- $in: Match any value in array
+  Example: { "category": { "$in": ["electronics", "books"] } }
+- $nin: Does not match any value in array
+  Example: { "category": { "$nin": ["electronics", "books"] } }
+
+Logical Operators:
+- $and: Logical AND
+  Example: { "$and": [{ "price": { "$gt": 100 } }, { "category": "electronics" }] }
+- $or: Logical OR
+  Example: { "$or": [{ "price": { "$lt": 50 } }, { "category": "books" }] }
+
+Restrictions:
+- Regex patterns are not supported
+- Element operators are not supported
+- Only $and and $or logical operators are supported
+- Nested fields are supported using dot notation
+- Multiple conditions on the same field are supported with both implicit and explicit $and
+- Empty arrays in $in/$nin will return no results
+- If multiple top-level fields exist, they're wrapped in $and
+- Only logical operators ($and, $or) can be used at the top level
+- All other operators must be used within a field condition
+  Valid: { "field": { "$gt": 100 } }
+  Valid: { "$and": [...] }
+  Invalid: { "$gt": 100 }
+  Invalid: { "$in": [...] }
+- Logical operators must contain field conditions, not direct operators
+  Valid: { "$and": [{ "field": { "$gt": 100 } }] }
+  Invalid: { "$and": [{ "$gt": 100 }] }
+- Logical operators ($and, $or):
+  - Can only be used at top level or nested within other logical operators
+  - Can not be used on a field level, or be nested inside a field
+  - Can not be used inside an operator
+  - Valid: { "$and": [{ "field": { "$gt": 100 } }] }
+  - Valid: { "$or": [{ "$and": [{ "field": { "$gt": 100 } }] }] }
+  - Invalid: { "field": { "$and": [{ "$gt": 100 }] } }
+  - Invalid: { "field": { "$or": [{ "$gt": 100 }] } }
+  - Invalid: { "field": { "$gt": { "$and": [{...}] } } }
+
+Example Complex Query:
+{
+  "$and": [
+    { "category": { "$in": ["electronics", "computers"] } },
+    { "price": { "$gte": 100, "$lte": 1000 } },
+    { "$or": [
+      { "inStock": true },
+      { "preorder": true }
+    ]}
+  ]
+}`;