@mastra/chroma 0.0.0-storage-20250225005900 → 0.0.0-vnextWorkflows-20250417075051

package/src/vector/index.ts

@@ -1,9 +1,32 @@
-import { type Filter } from '@mastra/core/filter';
-import { MastraVector, type QueryResult, type IndexStats } from '@mastra/core/vector';
+import { MastraVector } from '@mastra/core/vector';
+import type {
+  QueryResult,
+  IndexStats,
+  CreateIndexParams,
+  UpsertVectorParams,
+  QueryVectorParams,
+  ParamsToArgs,
+  QueryVectorArgs,
+  UpsertVectorArgs,
+} from '@mastra/core/vector';
+
+import type { VectorFilter } from '@mastra/core/vector/filter';
 import { ChromaClient } from 'chromadb';
-
+import type { UpdateRecordsParams, Collection } from 'chromadb';
 import { ChromaFilterTranslator } from './filter';
 
+interface ChromaUpsertVectorParams extends UpsertVectorParams {
+  documents?: string[];
+}
+
+type ChromaUpsertArgs = [...UpsertVectorArgs, string[]?];
+
+interface ChromaQueryVectorParams extends QueryVectorParams {
+  documentFilter?: VectorFilter;
+}
+
+type ChromaQueryArgs = [...QueryVectorArgs, VectorFilter?];
+
 export class ChromaVector extends MastraVector {
   private client: ChromaClient;
   private collections: Map<string, any>;
@@ -26,11 +49,11 @@ export class ChromaVector extends MastraVector {
     this.collections = new Map();
   }
 
-  private async getCollection(indexName: string, throwIfNotExists: boolean = true) {
+  async getCollection(indexName: string, throwIfNotExists: boolean = true) {
     try {
       const collection = await this.client.getCollection({ name: indexName, embeddingFunction: undefined as any });
       this.collections.set(indexName, collection);
-    } catch (error) {
+    } catch {
       if (throwIfNotExists) {
         throw new Error(`Index ${indexName} does not exist`);
       }
@@ -49,12 +72,11 @@ export class ChromaVector extends MastraVector {
     }
   }
 
-  async upsert(
-    indexName: string,
-    vectors: number[][],
-    metadata?: Record<string, any>[],
-    ids?: string[],
-  ): Promise<string[]> {
+  async upsert(...args: ParamsToArgs<ChromaUpsertVectorParams> | ChromaUpsertArgs): Promise<string[]> {
+    const params = this.normalizeArgs<ChromaUpsertVectorParams, ChromaUpsertArgs>('upsert', args, ['documents']);
+
+    const { indexName, vectors, metadata, ids, documents } = params;
+
     const collection = await this.getCollection(indexName);
 
     // Get index stats to check dimension
@@ -73,50 +95,60 @@ export class ChromaVector extends MastraVector {
       ids: generatedIds,
       embeddings: vectors,
       metadatas: normalizedMetadata,
+      documents: documents,
     });
 
     return generatedIds;
   }
 
-  async createIndex(
-    indexName: string,
-    dimension: number,
-    metric: 'cosine' | 'euclidean' | 'dotproduct' = 'cosine',
-  ): Promise<void> {
+  private HnswSpaceMap = {
+    cosine: 'cosine',
+    euclidean: 'l2',
+    dotproduct: 'ip',
+    l2: 'euclidean',
+    ip: 'dotproduct',
+  };
+
+  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) {
       throw new Error('Dimension must be a positive integer');
     }
+    const hnswSpace = this.HnswSpaceMap[metric];
+    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,
-        metric,
+        'hnsw:space': this.HnswSpaceMap[metric],
       },
     });
   }
 
-  transformFilter(filter?: Filter) {
-    const chromaFilter = new ChromaFilterTranslator();
-    const translatedFilter = chromaFilter.translate(filter);
-    return translatedFilter;
+  transformFilter(filter?: VectorFilter) {
+    const translator = new ChromaFilterTranslator();
+    return translator.translate(filter);
   }
-  async query(
-    indexName: string,
-    queryVector: number[],
-    topK: number = 10,
-    filter?: Filter,
-    includeVector: boolean = false,
-  ): Promise<QueryResult[]> {
+  async query(...args: ParamsToArgs<ChromaQueryVectorParams> | ChromaQueryArgs): Promise<QueryResult[]> {
+    const params = this.normalizeArgs<ChromaQueryVectorParams, ChromaQueryArgs>('query', args, ['documentFilter']);
+
+    const { indexName, queryVector, topK = 10, filter, includeVector = false, documentFilter } = params;
+
     const collection = await this.getCollection(indexName, true);
 
     const defaultInclude = ['documents', 'metadatas', 'distances'];
 
     const translatedFilter = this.transformFilter(filter);
-
     const results = await collection.query({
       queryEmbeddings: [queryVector],
       nResults: topK,
       where: translatedFilter,
+      whereDocument: documentFilter,
       include: includeVector ? [...defaultInclude, 'embeddings'] : defaultInclude,
     });
 
@@ -125,6 +157,7 @@ export class ChromaVector extends MastraVector {
       id,
       score: results.distances?.[0]?.[index] || 0,
       metadata: results.metadatas?.[0]?.[index] || {},
+      document: results.documents?.[0]?.[index],
       ...(includeVector && { vector: results.embeddings?.[0]?.[index] || [] }),
     }));
   }
@@ -139,10 +172,12 @@ export class ChromaVector extends MastraVector {
     const count = await collection.count();
     const metadata = collection.metadata;
 
+    const hnswSpace = metadata?.['hnsw:space'] as 'cosine' | 'l2' | 'ip';
+
     return {
       dimension: metadata?.dimension || 0,
       count,
-      metric: metadata?.metric as 'cosine' | 'euclidean' | 'dotproduct',
+      metric: this.HnswSpaceMap[hnswSpace] as 'cosine' | 'euclidean' | 'dotproduct',
     };
   }
 
@@ -150,4 +185,37 @@ export class ChromaVector extends MastraVector {
     await this.client.deleteCollection({ name: indexName });
     this.collections.delete(indexName);
   }
+
+  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');
+    }
+
+    const collection: Collection = await this.getCollection(indexName, true);
+
+    const updateOptions: UpdateRecordsParams = { ids: [id] };
+
+    if (update?.vector) {
+      updateOptions.embeddings = [update.vector];
+    }
+
+    if (update?.metadata) {
+      updateOptions.metadatas = [update.metadata];
+    }
+
+    return await collection.update(updateOptions);
+  }
+
+  async deleteIndexById(indexName: string, id: string): Promise<void> {
+    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}`);
+    }
+  }
 }

package/.turbo/turbo-build.log

@@ -1,19 +0,0 @@
-
-
-> @mastra/chroma@0.1.5-alpha.0 build /Users/ward/projects/mastra/mastra/stores/chroma
-> tsup src/index.ts --format esm --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 1648ms
-DTS Build start
-CLI Target: es2022
-Analysis will use the bundled TypeScript version 5.7.3
-Writing package typings: /Users/ward/projects/mastra/mastra/stores/chroma/dist/_tsup-dts-rollup.d.ts
-DTS ⚡️ Build success in 1410ms
-CLI Cleaning output folder
-ESM Build start
-ESM dist/index.js 6.49 KB
-ESM ⚡️ Build success in 157ms

package/LICENSE

@@ -1,44 +0,0 @@
-Elastic License 2.0 (ELv2)
-
-**Acceptance**
-By using the software, you agree to all of the terms and conditions below.
-
-**Copyright License**
-The licensor grants you a non-exclusive, royalty-free, worldwide, non-sublicensable, non-transferable license to use, copy, distribute, make available, and prepare derivative works of the software, in each case subject to the limitations and conditions below
-
-**Limitations**
-You may not provide the software to third parties as a hosted or managed service, where the service provides users with access to any substantial set of the features or functionality of the software.
-
-You may not move, change, disable, or circumvent the license key functionality in the software, and you may not remove or obscure any functionality in the software that is protected by the license key.
-
-You may not alter, remove, or obscure any licensing, copyright, or other notices of the licensor in the software. Any use of the licensor’s trademarks is subject to applicable law.
-
-**Patents**
-The licensor grants you a license, under any patent claims the licensor can license, or becomes able to license, to make, have made, use, sell, offer for sale, import and have imported the software, in each case subject to the limitations and conditions in this license. This license does not cover any patent claims that you cause to be infringed by modifications or additions to the software. If you or your company make any written claim that the software infringes or contributes to infringement of any patent, your patent license for the software granted under these terms ends immediately. If your company makes such a claim, your patent license ends immediately for work on behalf of your company.
-
-**Notices**
-You must ensure that anyone who gets a copy of any part of the software from you also gets a copy of these terms.
-
-If you modify the software, you must include in any modified copies of the software prominent notices stating that you have modified the software.
-
-**No Other Rights**
-These terms do not imply any licenses other than those expressly granted in these terms.
-
-**Termination**
-If you use the software in violation of these terms, such use is not licensed, and your licenses will automatically terminate. If the licensor provides you with a notice of your violation, and you cease all violation of this license no later than 30 days after you receive that notice, your licenses will be reinstated retroactively. However, if you violate these terms after such reinstatement, any additional violation of these terms will cause your licenses to terminate automatically and permanently.
-
-**No Liability**
-As far as the law allows, the software comes as is, without any warranty or condition, and the licensor will not be liable to you for any damages arising out of these terms or the use or nature of the software, under any kind of legal claim.
-
-**Definitions**
-The _licensor_ is the entity offering these terms, and the _software_ is the software the licensor makes available under these terms, including any portion of it.
-
-_you_ refers to the individual or entity agreeing to these terms.
-
-_your company_ is any legal entity, sole proprietorship, or other kind of organization that you work for, plus all organizations that have control over, are under the control of, or are under common control with that organization. _control_ means ownership of substantially all the assets of an entity, or the power to direct its management and policies by vote, contract, or otherwise. Control can be direct or indirect.
-
-_your licenses_ are all the licenses granted to you for the software under these terms.
-
-_use_ means anything you do with the software requiring one of your licenses.
-
-_trademark_ means trademarks, service marks, and similar rights.