@sprucelabs/chroma-data-store 0.2.3 → 0.3.1

package/README.md

@@ -1,9 +1,34 @@
-# Running Chroma
+# Chroma Data Store
+
+Give your skill the ability to store and retrieve data from a Chroma database.
+
+## Running Chroma
 
 1. Clone this rep
 2. Run `yarn start.chroma.docker`
 
+## Setting an embedding model
+
+By default , the ChromaDabatase class will use llama3.2 hosted through Ollama to generate embeddings
+
+### Installing Ollama
+
+1. Visit https://ollama.com
+2. Click "Download"
+3. Select your OS
+
+### Installing Llama3.2
+
+Llama 3.2 is the newest version of Llama (as of this writing) that supports embeddings.
+
+1. Inside of terminal, run `ollama run llama3.2`
+2. You should be able to visit http://localhost:11434/api/embeddings and get a 404 response (this is because the route only accepts POST requests)
+
+## Improving embeddings with `nomic-embed-text`
+
+We have seen significantly better search performance when using `nomic-embed-text` to generate embeddings.
+
 
-# Connecting to Chroma
+## Connecting to Chroma
 
-Use the connection string: `chromadb://localhost:8000`
+Use the connection string: `chromadb://localhost:8000` is your skill.

package/build/ChromaDatabase.d.ts

@@ -1,6 +1,8 @@
 import { CreateOptions, Database, DatabaseInternalOptions, Index, IndexWithFilter, QueryOptions } from '@sprucelabs/data-stores';
+import { OllamaEmbeddingFunction } from 'chromadb';
 export default class ChromaDatabase implements Database {
     static Class?: new (connectionString: string) => Database;
+    static EmbeddingFunction: typeof OllamaEmbeddingFunction;
     private static embeddingFields?;
     private connectionString;
     private client;

package/build/ChromaDatabase.js

@@ -13,8 +13,8 @@ class ChromaDatabase {
         this._isConnected = false;
         this.collections = {};
         (0, schema_1.assertOptions)({ connectionString }, ['connectionString']);
-        this.embeddings = new chromadb_1.OllamaEmbeddingFunction({
-            model: 'llama3.2',
+        this.embeddings = new ChromaDatabase.EmbeddingFunction({
+            model: process.env.CHROMA_EMBEDDING_MODEL ?? 'llama3.2',
             url: 'http://localhost:11434/api/embeddings',
         });
         if (!connectionString.startsWith('chroma://')) {
@@ -394,4 +394,5 @@ class ChromaDatabase {
         });
     }
 }
+ChromaDatabase.EmbeddingFunction = chromadb_1.OllamaEmbeddingFunction;
 exports.default = ChromaDatabase;

package/build/esm/ChromaDatabase.d.ts

@@ -1,6 +1,8 @@
 import { CreateOptions, Database, DatabaseInternalOptions, Index, IndexWithFilter, QueryOptions } from '@sprucelabs/data-stores';
+import { OllamaEmbeddingFunction } from 'chromadb';
 export default class ChromaDatabase implements Database {
     static Class?: new (connectionString: string) => Database;
+    static EmbeddingFunction: typeof OllamaEmbeddingFunction;
     private static embeddingFields?;
     private connectionString;
     private client;

package/build/esm/ChromaDatabase.js

@@ -23,13 +23,14 @@ import { assertOptions, flattenValues, expandValues } from '@sprucelabs/schema';
 import { NULL_PLACEHOLDER } from '@sprucelabs/test-utils';
 import { ChromaClient, OllamaEmbeddingFunction, } from 'chromadb';
 import SpruceError from './errors/SpruceError.js';
-export default class ChromaDatabase {
+class ChromaDatabase {
     constructor(connectionString) {
+        var _a;
         this._isConnected = false;
         this.collections = {};
         assertOptions({ connectionString }, ['connectionString']);
-        this.embeddings = new OllamaEmbeddingFunction({
-            model: 'llama3.2',
+        this.embeddings = new ChromaDatabase.EmbeddingFunction({
+            model: (_a = process.env.CHROMA_EMBEDDING_MODEL) !== null && _a !== void 0 ? _a : 'llama3.2',
             url: 'http://localhost:11434/api/embeddings',
         });
         if (!connectionString.startsWith('chroma://')) {
@@ -456,3 +457,5 @@ export default class ChromaDatabase {
         });
     }
 }
+ChromaDatabase.EmbeddingFunction = OllamaEmbeddingFunction;
+export default ChromaDatabase;

package/package.json

@@ -13,7 +13,7 @@
     "sprucebot",
     "sprucelabs"
   ],
-  "version": "0.2.3",
+  "version": "0.3.1",
   "scripts": {
     "build.ci": "yarn run build.tsc && yarn run build.resolve-paths && yarn run lint",
     "build.copy-files": "mkdir -p build && rsync -avzq --exclude='*.ts' ./src/ ./build/",
@@ -43,15 +43,15 @@
     "generate.embeddings": "./support/generate_embeddings.sh"
   },
   "devDependencies": {
-    "@sprucelabs/esm-postbuild": "^6.0.540",
-    "@sprucelabs/jest-json-reporter": "^8.0.567",
-    "@sprucelabs/resolve-path-aliases": "^2.0.527",
+    "@sprucelabs/esm-postbuild": "^6.0.541",
+    "@sprucelabs/jest-json-reporter": "^8.0.568",
+    "@sprucelabs/resolve-path-aliases": "^2.0.528",
     "@sprucelabs/semantic-release": "^5.0.2",
-    "@sprucelabs/test": "^9.0.67",
-    "@sprucelabs/test-utils": "^5.1.546",
-    "@types/node": "^22.10.7",
+    "@sprucelabs/test": "^9.0.68",
+    "@sprucelabs/test-utils": "^5.1.547",
+    "@types/node": "^22.12.0",
     "chokidar-cli": "^3.0.0",
-    "eslint": "^9.18.0",
+    "eslint": "^9.19.0",
     "eslint-config-spruce": "^11.2.26",
     "jest": "^29.7.0",
     "jest-circus": "^29.7.0",
@@ -83,12 +83,12 @@
     }
   },
   "dependencies": {
-    "@sprucelabs/data-stores": "^28.5.25",
-    "@sprucelabs/error": "^6.0.566",
+    "@sprucelabs/data-stores": "^28.5.28",
+    "@sprucelabs/error": "^6.0.567",
     "@sprucelabs/schema": "^31.0.19",
-    "@sprucelabs/spruce-core-schemas": "^40.1.605",
-    "@sprucelabs/spruce-skill-utils": "^31.2.18",
-    "chromadb": "^1.10.3",
+    "@sprucelabs/spruce-core-schemas": "^40.1.606",
+    "@sprucelabs/spruce-skill-utils": "^31.2.20",
+    "chromadb": "^1.10.4",
     "chromadb-default-embed": "^2.13.2"
   }
 }