chromadb 3.0.10 → 3.0.11

package/README.md

@@ -11,15 +11,28 @@ This package gives you a JS/TS interface to talk to a backend Chroma DB over RES
 - [💡 Colab Example](https://colab.research.google.com/drive/1QEzFyqnoFxq7LUGyP1vzR4iLt9PpCDXv?usp=sharing)
 - [🏠 Homepage](https://www.trychroma.com/)
 
+## Chroma Cloud
+
+Our hosted service, Chroma Cloud, powers serverless vector and full-text search. It's extremely fast, cost-effective, scalable and painless. Create a DB and try it out in under 30 seconds with $5 of free credits.
+
+[Get started with Chroma Cloud](https://trychroma.com/signup)
+
 ## Getting started
 
-Chroma needs to be running in order for this client to talk to it. Please see the [🧪 Usage Guide](https://docs.trychroma.com/guides) to learn how to quickly stand this up.
+First, start a Chroma server using the Chroma CLI:
+
+```bash
+chroma run
+```
+
+See more examples on our [docs](https://docs.trychroma.com/docs/overview/getting-started)
 
 ## Small example
 
 ```js
 import { ChromaClient } from "chromadb";
-const chroma = new ChromaClient({ path: "http://localhost:8000" });
+
+const chroma = new ChromaClient();
 const collection = await chroma.createCollection({ name: "test-from-js" });
 for (let i = 0; i < 20; i++) {
   await collection.add({

package/dist/chromadb.d.ts

@@ -8,9 +8,9 @@ type Database = {
     tenant: string;
 };
 type EmbeddingFunctionConfiguration = {
-    type: "legacy";
+    type: 'legacy';
 } | (EmbeddingFunctionNewConfiguration & {
-    type: "known";
+    type: 'known';
 });
 type EmbeddingFunctionNewConfiguration = {
     config: unknown;
@@ -29,8 +29,8 @@ type HnswConfiguration = {
     space?: null | HnswSpace;
     sync_threshold?: number | null;
 };
-type HnswSpace = "l2" | "cosine" | "ip";
-type Include = "distances" | "documents" | "embeddings" | "metadatas" | "uris";
+type HnswSpace = 'l2' | 'cosine' | 'ip';
+type Include = 'distances' | 'documents' | 'embeddings' | 'metadatas' | 'uris';
 type SpannConfiguration = {
     ef_construction?: number | null;
     ef_search?: number | null;
@@ -95,6 +95,12 @@ interface RecordSet extends BaseRecordSet {
     /** Array of unique record identifiers */
     ids: string[];
 }
+interface PreparedRecordSet extends Omit<RecordSet, "embeddings"> {
+    embeddings?: number[][] | string[];
+}
+interface PreparedInsertRecordSet extends PreparedRecordSet {
+    embeddings: number[][] | string[];
+}
 declare const recordSetFields: string[];
 /**
  * Record set for query operations with required embeddings.
@@ -928,4 +934,4 @@ declare class ChromaRateLimitError extends Error {
 }
 declare function createErrorByType(type: string, message: string): InvalidCollectionError | InvalidArgumentError | undefined;
 
-export { AdminClient, type AdminClientArgs, AdminCloudClient, type BaseRecordSet, ChromaClient, type ChromaClientArgs, ChromaClientError, ChromaConnectionError, ChromaError, ChromaForbiddenError, ChromaNotFoundError, ChromaQuotaExceededError, ChromaRateLimitError, ChromaServerError, ChromaUnauthorizedError, ChromaUniqueError, ChromaValueError, CloudClient, type Collection, type CollectionConfiguration, type CollectionMetadata, type CreateCollectionConfiguration, type EmbeddingFunction, type EmbeddingFunctionClass, type EmbeddingFunctionSpace, GetResult, type HNSWConfiguration, IncludeEnum, InvalidArgumentError, InvalidCollectionError, type ListDatabasesArgs, type Metadata, type QueryRecordSet, QueryResult, type QueryRowResult, type RecordSet, type UpdateCollectionConfiguration, type UpdateHNSWConfiguration, type UpdateSPANNConfiguration, type UserIdentity, type Where, type WhereDocument, baseRecordSetFields, createErrorByType, getDefaultEFConfig, getEmbeddingFunction, knownEmbeddingFunctions, processCreateCollectionConfig, processUpdateCollectionConfig, recordSetFields, registerEmbeddingFunction, serializeEmbeddingFunction, withChroma };
+export { AdminClient, type AdminClientArgs, AdminCloudClient, type BaseRecordSet, ChromaClient, type ChromaClientArgs, ChromaClientError, ChromaConnectionError, ChromaError, ChromaForbiddenError, ChromaNotFoundError, ChromaQuotaExceededError, ChromaRateLimitError, ChromaServerError, ChromaUnauthorizedError, ChromaUniqueError, ChromaValueError, CloudClient, type Collection, type CollectionConfiguration, type CollectionMetadata, type CreateCollectionConfiguration, type EmbeddingFunction, type EmbeddingFunctionClass, type EmbeddingFunctionSpace, GetResult, type HNSWConfiguration, IncludeEnum, InvalidArgumentError, InvalidCollectionError, type ListDatabasesArgs, type Metadata, type PreparedInsertRecordSet, type PreparedRecordSet, type QueryRecordSet, QueryResult, type QueryRowResult, type RecordSet, type UpdateCollectionConfiguration, type UpdateHNSWConfiguration, type UpdateSPANNConfiguration, type UserIdentity, type Where, type WhereDocument, baseRecordSetFields, createErrorByType, getDefaultEFConfig, getEmbeddingFunction, knownEmbeddingFunctions, processCreateCollectionConfig, processUpdateCollectionConfig, recordSetFields, registerEmbeddingFunction, serializeEmbeddingFunction, withChroma };

package/dist/chromadb.legacy-esm.js

@@ -355,12 +355,10 @@ var J = (t = {}) => {
 };
 
 // src/api/client.gen.ts
-var client = J(
-  w({
-    baseUrl: "http://localhost:8000",
-    throwOnError: true
-  })
-);
+var client = J(w({
+  baseUrl: "http://localhost:8000",
+  throwOnError: true
+}));
 
 // src/api/sdk.gen.ts
 var DefaultService = class {
@@ -1110,10 +1108,7 @@ var packEmbedding = (embedding) => {
   }
   return buffer;
 };
-var optionalEmbeddingsToBase64Bytes = (embeddings) => {
-  if (!embeddings) {
-    return void 0;
-  }
+var embeddingsToBase64Bytes = (embeddings) => {
   return embeddings.map((embedding) => {
     const buffer = packEmbedding(embedding);
     const uint8Array = new Uint8Array(buffer);
@@ -1334,9 +1329,9 @@ var CollectionImpl = class _CollectionImpl {
   }
   async prepareRecords({
     recordSet,
-    maxBatchSize,
     update = false
   }) {
+    const maxBatchSize = await this.chromaClient.getMaxBatchSize();
     validateRecordSetLengthConsistency(recordSet);
     validateIDs(recordSet.ids);
     validateBaseRecordSet({ recordSet, update });
@@ -1344,6 +1339,14 @@ var CollectionImpl = class _CollectionImpl {
     if (!recordSet.embeddings && recordSet.documents) {
       recordSet.embeddings = await this.embed(recordSet.documents);
     }
+    const preparedRecordSet = { ...recordSet };
+    const base64Supported = await this.chromaClient.supportsBase64Encoding();
+    if (base64Supported && recordSet.embeddings) {
+      preparedRecordSet.embeddings = embeddingsToBase64Bytes(
+        recordSet.embeddings
+      );
+    }
+    return preparedRecordSet;
   }
   validateGet(include, ids, where, whereDocument) {
     validateInclude({ include, exclude: ["distances"] });
@@ -1400,19 +1403,16 @@ var CollectionImpl = class _CollectionImpl {
       metadatas,
       uris
     };
-    const maxBatchSize = await this.chromaClient.getMaxBatchSize();
-    await this.prepareRecords({ recordSet, maxBatchSize });
-    const supportsBase64Encoding = await this.chromaClient.supportsBase64Encoding();
-    const embeddingsBase64 = supportsBase64Encoding ? optionalEmbeddingsToBase64Bytes(recordSet.embeddings) : recordSet.embeddings;
+    const preparedRecordSet = await this.prepareRecords({ recordSet });
     await DefaultService.collectionAdd({
       client: this.apiClient,
       path: await this.path(),
       body: {
-        ids: recordSet.ids,
-        embeddings: embeddingsBase64,
-        documents: recordSet.documents,
-        metadatas: recordSet.metadatas,
-        uris: recordSet.uris
+        ids: preparedRecordSet.ids,
+        embeddings: preparedRecordSet.embeddings,
+        documents: preparedRecordSet.documents,
+        metadatas: preparedRecordSet.metadatas,
+        uris: preparedRecordSet.uris
       }
     });
   }
@@ -1561,19 +1561,19 @@ var CollectionImpl = class _CollectionImpl {
       metadatas,
       uris
     };
-    const maxBatchSize = await this.chromaClient.getMaxBatchSize();
-    await this.prepareRecords({ recordSet, maxBatchSize, update: true });
-    const supportsBase64Encoding = await this.chromaClient.supportsBase64Encoding();
-    const embeddingsBase64 = supportsBase64Encoding ? optionalEmbeddingsToBase64Bytes(recordSet.embeddings) : recordSet.embeddings;
+    const preparedRecordSet = await this.prepareRecords({
+      recordSet,
+      update: true
+    });
     await DefaultService.collectionUpdate({
       client: this.apiClient,
       path: await this.path(),
       body: {
-        ids: recordSet.ids,
-        embeddings: embeddingsBase64,
-        metadatas: recordSet.metadatas,
-        uris: recordSet.uris,
-        documents: recordSet.documents
+        ids: preparedRecordSet.ids,
+        embeddings: preparedRecordSet.embeddings,
+        metadatas: preparedRecordSet.metadatas,
+        uris: preparedRecordSet.uris,
+        documents: preparedRecordSet.documents
       }
     });
   }
@@ -1591,19 +1591,18 @@ var CollectionImpl = class _CollectionImpl {
       metadatas,
       uris
     };
-    const maxBatchSize = await this.chromaClient.getMaxBatchSize();
-    await this.prepareRecords({ recordSet, maxBatchSize, update: true });
-    const supportsBase64Encoding = await this.chromaClient.supportsBase64Encoding();
-    const embeddingsBase64 = supportsBase64Encoding ? optionalEmbeddingsToBase64Bytes(recordSet.embeddings) : recordSet.embeddings;
+    const preparedRecordSet = await this.prepareRecords({
+      recordSet
+    });
     await DefaultService.collectionUpsert({
       client: this.apiClient,
       path: await this.path(),
       body: {
-        ids: recordSet.ids,
-        embeddings: embeddingsBase64,
-        metadatas: recordSet.metadatas,
-        uris: recordSet.uris,
-        documents: recordSet.documents
+        ids: preparedRecordSet.ids,
+        embeddings: preparedRecordSet.embeddings,
+        metadatas: preparedRecordSet.metadatas,
+        uris: preparedRecordSet.uris,
+        documents: preparedRecordSet.documents
       }
     });
   }

package/dist/chromadb.mjs

@@ -355,12 +355,10 @@ var J = (t = {}) => {
 };
 
 // src/api/client.gen.ts
-var client = J(
-  w({
-    baseUrl: "http://localhost:8000",
-    throwOnError: true
-  })
-);
+var client = J(w({
+  baseUrl: "http://localhost:8000",
+  throwOnError: true
+}));
 
 // src/api/sdk.gen.ts
 var DefaultService = class {
@@ -1110,10 +1108,7 @@ var packEmbedding = (embedding) => {
   }
   return buffer;
 };
-var optionalEmbeddingsToBase64Bytes = (embeddings) => {
-  if (!embeddings) {
-    return void 0;
-  }
+var embeddingsToBase64Bytes = (embeddings) => {
   return embeddings.map((embedding) => {
     const buffer = packEmbedding(embedding);
     const uint8Array = new Uint8Array(buffer);
@@ -1334,9 +1329,9 @@ var CollectionImpl = class _CollectionImpl {
   }
   async prepareRecords({
     recordSet,
-    maxBatchSize,
     update = false
   }) {
+    const maxBatchSize = await this.chromaClient.getMaxBatchSize();
     validateRecordSetLengthConsistency(recordSet);
     validateIDs(recordSet.ids);
     validateBaseRecordSet({ recordSet, update });
@@ -1344,6 +1339,14 @@ var CollectionImpl = class _CollectionImpl {
     if (!recordSet.embeddings && recordSet.documents) {
       recordSet.embeddings = await this.embed(recordSet.documents);
     }
+    const preparedRecordSet = { ...recordSet };
+    const base64Supported = await this.chromaClient.supportsBase64Encoding();
+    if (base64Supported && recordSet.embeddings) {
+      preparedRecordSet.embeddings = embeddingsToBase64Bytes(
+        recordSet.embeddings
+      );
+    }
+    return preparedRecordSet;
   }
   validateGet(include, ids, where, whereDocument) {
     validateInclude({ include, exclude: ["distances"] });
@@ -1400,19 +1403,16 @@ var CollectionImpl = class _CollectionImpl {
       metadatas,
       uris
     };
-    const maxBatchSize = await this.chromaClient.getMaxBatchSize();
-    await this.prepareRecords({ recordSet, maxBatchSize });
-    const supportsBase64Encoding = await this.chromaClient.supportsBase64Encoding();
-    const embeddingsBase64 = supportsBase64Encoding ? optionalEmbeddingsToBase64Bytes(recordSet.embeddings) : recordSet.embeddings;
+    const preparedRecordSet = await this.prepareRecords({ recordSet });
     await DefaultService.collectionAdd({
       client: this.apiClient,
       path: await this.path(),
       body: {
-        ids: recordSet.ids,
-        embeddings: embeddingsBase64,
-        documents: recordSet.documents,
-        metadatas: recordSet.metadatas,
-        uris: recordSet.uris
+        ids: preparedRecordSet.ids,
+        embeddings: preparedRecordSet.embeddings,
+        documents: preparedRecordSet.documents,
+        metadatas: preparedRecordSet.metadatas,
+        uris: preparedRecordSet.uris
       }
     });
   }
@@ -1561,19 +1561,19 @@ var CollectionImpl = class _CollectionImpl {
       metadatas,
       uris
     };
-    const maxBatchSize = await this.chromaClient.getMaxBatchSize();
-    await this.prepareRecords({ recordSet, maxBatchSize, update: true });
-    const supportsBase64Encoding = await this.chromaClient.supportsBase64Encoding();
-    const embeddingsBase64 = supportsBase64Encoding ? optionalEmbeddingsToBase64Bytes(recordSet.embeddings) : recordSet.embeddings;
+    const preparedRecordSet = await this.prepareRecords({
+      recordSet,
+      update: true
+    });
     await DefaultService.collectionUpdate({
       client: this.apiClient,
       path: await this.path(),
       body: {
-        ids: recordSet.ids,
-        embeddings: embeddingsBase64,
-        metadatas: recordSet.metadatas,
-        uris: recordSet.uris,
-        documents: recordSet.documents
+        ids: preparedRecordSet.ids,
+        embeddings: preparedRecordSet.embeddings,
+        metadatas: preparedRecordSet.metadatas,
+        uris: preparedRecordSet.uris,
+        documents: preparedRecordSet.documents
       }
     });
   }
@@ -1591,19 +1591,18 @@ var CollectionImpl = class _CollectionImpl {
       metadatas,
       uris
     };
-    const maxBatchSize = await this.chromaClient.getMaxBatchSize();
-    await this.prepareRecords({ recordSet, maxBatchSize, update: true });
-    const supportsBase64Encoding = await this.chromaClient.supportsBase64Encoding();
-    const embeddingsBase64 = supportsBase64Encoding ? optionalEmbeddingsToBase64Bytes(recordSet.embeddings) : recordSet.embeddings;
+    const preparedRecordSet = await this.prepareRecords({
+      recordSet
+    });
     await DefaultService.collectionUpsert({
       client: this.apiClient,
       path: await this.path(),
       body: {
-        ids: recordSet.ids,
-        embeddings: embeddingsBase64,
-        metadatas: recordSet.metadatas,
-        uris: recordSet.uris,
-        documents: recordSet.documents
+        ids: preparedRecordSet.ids,
+        embeddings: preparedRecordSet.embeddings,
+        metadatas: preparedRecordSet.metadatas,
+        uris: preparedRecordSet.uris,
+        documents: preparedRecordSet.documents
       }
     });
   }