[ENH] add regeneration script for js library

Author: jairad26

clients/js/genapi.sh

@@ -1,8 +1,12 @@
 #!/usr/bin/env sh
 set -e
 
-curl -s http://localhost:8000/openapi.json | jq > openapi.json
+# Run the transformation script instead of copying the file
+echo "Fetching and transforming OpenAPI specification..."
+python3 transform-openapi.py
 
+# Run the OpenAPI generator
+echo "Running OpenAPI generator..."
 openapi-generator-plus -c config.yml
 
 if [[ "$OSTYPE" == "darwin"* ]]; then
@@ -16,4 +20,4 @@ echo "import 'isomorphic-fetch';" > temp.txt
 cat packages/chromadb-core/src/generated/runtime.ts >> temp.txt
 mv temp.txt packages/chromadb-core/src/generated/runtime.ts
 
-rm openapi.json
+rm openapi.json

clients/js/packages/chromadb-core/src/AdminClient.ts

@@ -150,7 +150,7 @@ export class AdminClient {
    * ```
    */
   public async createTenant({ name }: { name: string }): Promise<Tenant> {
-    await this.api.createTenantV2({ name }, this.api.options);
+    await this.api.createTenant({ name }, this.api.options);
 
     return { name };
   }
@@ -172,7 +172,7 @@ export class AdminClient {
    * ```
    */
   public async getTenant({ name }: { name: string }): Promise<Tenant> {
-    const getTenant = (await this.api.getTenantV2(
+    const getTenant = (await this.api.getTenant(
       name,
       this.api.options,
     )) as Tenant;
@@ -205,7 +205,7 @@ export class AdminClient {
     name: string;
     tenantName: string;
   }): Promise<{ name: string }> {
-    await this.api.createDatabaseV2(tenantName, { name }, this.api.options);
+    await this.api.createDatabase(tenantName, { name }, this.api.options);
 
     return { name };
   }
@@ -235,9 +235,9 @@ export class AdminClient {
     name: string;
     tenantName: string;
   }): Promise<Database> {
-    const result = (await this.api.getDatabaseV2(
-      name,
+    const result = (await this.api.getDatabase(
       tenantName,
+      name,
       this.api.options,
     )) as Database;
 
@@ -261,7 +261,7 @@ export class AdminClient {
     name: string;
     tenantName: string;
   }): Promise<void> {
-    await this.api.deleteDatabaseV2(name, tenantName, this.api.options);
+    await this.api.deleteDatabase(tenantName, name, this.api.options);
     return;
   }
 
@@ -284,7 +284,7 @@ export class AdminClient {
     offset?: number;
     tenantName: string;
   }): Promise<Database[]> {
-    const response = await this.api.listDatabasesV2(
+    const response = await this.api.listDatabases(
       tenantName,
       limit,
       offset,

clients/js/packages/chromadb-core/src/ChromaClient.ts

@@ -126,7 +126,7 @@ export class ChromaClient {
    *
    */
   async getUserIdentity(): Promise<void> {
-    const user_identity = (await this.api.getUserIdentityV2(
+    const user_identity = (await this.api.getUserIdentity(
       this.api.options,
     )) as UserIdentity;
     const user_tenant = user_identity.tenant;
@@ -166,7 +166,7 @@ export class ChromaClient {
    */
   async reset(): Promise<boolean> {
     await this.init();
-    return await this.api.resetV2(this.api.options);
+    return await this.api.reset(this.api.options);
   }
 
   /**
@@ -180,7 +180,7 @@ export class ChromaClient {
    * ```
    */
   async version(): Promise<string> {
-    return await this.api.versionV2(this.api.options);
+    return await this.api.version(this.api.options);
   }
 
   /**
@@ -194,7 +194,8 @@ export class ChromaClient {
    * ```
    */
   async heartbeat(): Promise<number> {
-    const response = await this.api.heartbeatV2(this.api.options);
+    const response = await this.api.heartbeat(this.api.options);
+    console.log("[Heartbeat]", response);
     return response["nanosecond heartbeat"];
   }
 
@@ -226,22 +227,22 @@ export class ChromaClient {
     embeddingFunction = new DefaultEmbeddingFunction(),
   }: CreateCollectionParams): Promise<Collection> {
     await this.init();
-    const newCollection = (await this.api.createCollectionV2(
+    const newCollection = await this.api.createCollection(
       this.tenant,
       this.database,
       {
         name,
         // @ts-ignore: we need to generate the client libraries again
         configuration: null, //TODO: Configuration type in JavaScript
-        metadata,
+        metadata: metadata as any,
       },
       this.api.options,
-    )) as CollectionParams;
+    );
 
     return wrapCollection(this, {
       name: newCollection.name,
       id: newCollection.id,
-      metadata: newCollection.metadata,
+      metadata: newCollection.metadata as CollectionMetadata | undefined,
       embeddingFunction,
     });
   }
@@ -273,23 +274,23 @@ export class ChromaClient {
     embeddingFunction = new DefaultEmbeddingFunction(),
   }: GetOrCreateCollectionParams): Promise<Collection> {
     await this.init();
-    const newCollection = (await this.api.createCollectionV2(
+    const newCollection = await this.api.createCollection(
       this.tenant,
       this.database,
       {
         name,
         // @ts-ignore: we need to generate the client libraries again
         configuration: null, //TODO: Configuration type in JavaScript
-        metadata,
+        metadata: metadata as any,
         get_or_create: true,
       },
       this.api.options,
-    )) as CollectionParams;
+    );
 
     return wrapCollection(this, {
       name: newCollection.name,
       id: newCollection.id,
-      metadata: newCollection.metadata,
+      metadata: newCollection.metadata as CollectionMetadata | undefined,
       embeddingFunction,
     });
   }
@@ -315,7 +316,7 @@ export class ChromaClient {
   > {
     await this.init();
 
-    const response = (await this.api.listCollectionsV2(
+    const response = (await this.api.listCollections(
       this.tenant,
       this.database,
       limit,
@@ -352,7 +353,7 @@ export class ChromaClient {
     }[]
   > {
     await this.init();
-    const results = (await this.api.listCollectionsV2(
+    const results = (await this.api.listCollections(
       this.tenant,
       this.database,
       limit,
@@ -376,7 +377,7 @@ export class ChromaClient {
    */
   async countCollections(): Promise<number> {
     await this.init();
-    const response = (await this.api.countCollectionsV2(
+    const response = (await this.api.countCollections(
       this.tenant,
       this.database,
       this.api.options,
@@ -405,17 +406,17 @@ export class ChromaClient {
     embeddingFunction,
   }: GetCollectionParams): Promise<Collection> {
     await this.init();
-    const response = (await this.api.getCollectionV2(
+    const response = await this.api.getCollection(
       this.tenant,
       this.database,
       name,
       this.api.options,
-    )) as CollectionParams;
+    );
 
     return wrapCollection(this, {
       id: response.id,
       name: response.name,
-      metadata: response.metadata,
+      metadata: response.metadata as CollectionMetadata | undefined,
       embeddingFunction:
         embeddingFunction !== undefined
           ? embeddingFunction
@@ -440,10 +441,10 @@ export class ChromaClient {
   async deleteCollection({ name }: DeleteCollectionParams): Promise<void> {
     await this.init();
 
-    await this.api.deleteCollectionV2(
-      name,
+    await this.api.deleteCollection(
       this.tenant,
       this.database,
+      name,
       this.api.options,
     );
   }

clients/js/packages/chromadb-core/src/Collection.ts

@@ -70,15 +70,15 @@ export class Collection {
   async add(params: AddRecordsParams): Promise<void> {
     await this.client.init();
 
-    await this.client.api.addV2(
+    await this.client.api.collectionAdd(
       this.client.tenant,
       this.client.database,
       this.id,
       // TODO: For some reason the auto generated code requires metadata to be defined here.
       (await prepareRecordRequest(
         params,
         this.embeddingFunction,
-      )) as GeneratedApi.AddV2Request,
+      )) as GeneratedApi.AddCollectionRecordsPayload,
       this.client.api.options,
     );
   }
@@ -105,15 +105,15 @@ export class Collection {
   async upsert(params: UpsertRecordsParams): Promise<void> {
     await this.client.init();
 
-    await this.client.api.upsertV2(
+    await this.client.api.collectionUpsert(
       this.client.tenant,
       this.client.database,
       this.id,
       // TODO: For some reason the auto generated code requires metadata to be defined here.
       (await prepareRecordRequest(
         params,
         this.embeddingFunction,
-      )) as GeneratedApi.AddV2Request,
+      )) as GeneratedApi.UpsertCollectionRecordsPayload,
       this.client.api.options,
     );
   }
@@ -129,7 +129,7 @@ export class Collection {
    */
   async count(): Promise<number> {
     await this.client.init();
-    return (await this.client.api.countV2(
+    return (await this.client.api.collectionCount(
       this.client.tenant,
       this.client.database,
       this.id,
@@ -172,20 +172,20 @@ export class Collection {
 
     const idsArray = ids ? toArray(ids) : undefined;
 
-    const resp = (await this.client.api.getV2(
-      this.id,
+    const resp = (await this.client.api.collectionGet(
       this.client.tenant,
       this.client.database,
+      this.id,
       {
         ids: idsArray,
         where,
         limit,
         offset,
-        include,
+        include: include as unknown as GeneratedApi.Include[] | undefined,
         where_document: whereDocument,
       },
       this.client.api.options,
-    )) as MultiGetResponse;
+    )) as unknown as GetResponse;
 
     return resp;
   }
@@ -212,7 +212,7 @@ export class Collection {
   async update(params: UpdateRecordsParams): Promise<void> {
     await this.client.init();
 
-    await this.client.api.updateV2(
+    await this.client.api.collectionUpdate(
       this.client.tenant,
       this.client.database,
       this.id,
@@ -264,7 +264,7 @@ export class Collection {
   }: QueryRecordsParams): Promise<MultiQueryResponse> {
     await this.client.init();
 
-    let embeddings: unknown[] = [];
+    let embeddings: number[][] = [];
 
     // If queryEmbeddings is provided, use it
     if (queryEmbeddings) {
@@ -281,19 +281,21 @@ export class Collection {
       );
     }
 
-    const resp = (await this.client.api.getNearestNeighborsV2(
+    const resp = (await this.client.api.collectionQuery(
       this.client.tenant,
       this.client.database,
       this.id,
+      nResults,
+      undefined,
       {
         query_embeddings: embeddings,
         n_results: nResults,
         where,
         where_document: whereDocument,
-        include,
+        include: include as unknown as GeneratedApi.Include[] | undefined,
       },
       this.client.api.options,
-    )) as MultiQueryResponse;
+    )) as unknown as MultiQueryResponse;
 
     return resp;
   }
@@ -322,13 +324,13 @@ export class Collection {
   }): Promise<CollectionParams> {
     await this.client.init();
 
-    const resp = (await this.client.api.updateCollectionV2(
+    const resp = (await this.client.api.updateCollection(
       this.client.tenant,
       this.client.database,
       this.id,
       {
         new_name: name,
-        new_metadata: metadata,
+        new_metadata: metadata as any,
       },
       this.client.api.options,
     )) as CollectionParams;
@@ -360,15 +362,15 @@ export class Collection {
    */
   async peek({ limit = 10 }: PeekParams = {}): Promise<MultiGetResponse> {
     await this.client.init();
-    return (await this.client.api.getV2(
-      this.id,
+    return (await this.client.api.collectionGet(
       this.client.tenant,
       this.client.database,
+      this.id,
       {
         limit,
       },
       this.client.api.options,
-    )) as MultiGetResponse;
+    )) as unknown as MultiGetResponse;
   }
 
   /**
@@ -398,10 +400,10 @@ export class Collection {
 
     const idsArray = ids ? toArray(ids) : undefined;
 
-    await this.client.api.deleteV2(
-      this.id,
+    await this.client.api.collectionDelete(
       this.client.tenant,
       this.client.database,
+      this.id,
       {
         ids: idsArray,
         where: where,