@instant.dev/vectors 0.1.0 → 0.1.2

package/.travis.yml

@@ -0,0 +1,5 @@
+dist: jammy
+language: node_js
+node_js:
+  - "20.6.1"
+env: NODE_ENV=test

package/README.md

@@ -12,9 +12,9 @@ However, this API only allows for a maximum of 8,191 tokens per request:
 about 32,764 characters.
 
 **Solution:** `@instant.dev/vectors` provides a simple `VectorManager` utility that performs
-automatic, efficient batch creation of vectors via APIs. It will automatically collect
+automatic, efficient batch creation of vectors. It will automatically collect
 vector creation requests over a 100ms (configurable) timeframe and batch them to minimize
-vector creation requests.
+web requests.
 
 It is most useful in web server contexts where multiple user requests may be
 creating vectors at the same time. If you rely on the same `VectorManager` instance
@@ -55,9 +55,9 @@ const Vectors = new VectorManager();
 
 ## Usage
 
-Once you've imported and instantiated the package, you can use it like so.
+Once you've imported and instantiated the package, it's easy to use.
 
-Set a batch engine:
+### Set a batch engine
 
 ```javascript
 // values will automatically be batched appropriately
@@ -70,13 +70,15 @@ Vectors.setEngine(async (values) => {
 });
 ```
 
-Create a single vector:
+### Create a vector
 
 ```javascript
 let vector = await Vectors.create(`Something to vectorize!`);
 ```
 
-Create multiple vectors, will automatically batch:
+### Create multiple vectors
+
+Manually manage vector creation:
 
 ```javascript
 const myStrings = [
@@ -89,7 +91,7 @@ const myStrings = [
 let vectors = await Promise.all(myStrings.map(str => Vectors.create(str)));
 ```
 
-Create multiple vectors with `batchCreate` utility:
+Or create multiple vectors easily with the `batchCreate` utility:
 
 ```javascript
 const myStrings = [
@@ -102,7 +104,21 @@ const myStrings = [
 let vectors = await Vectors.batchCreate(myStrings);
 ```
 
-# Acknowledgements
+## Configuration
+
+You can configure the following parameters:
+
+```javascript
+const Vectors = new VectorManager();
+
+// these are the defaults
+Vectors.maximumBatchSize = 7168 * 4; // maximum size of a batch - for OpenAI, 4 tokens per word, estimated
+Vectors.maximumParallelRequests = 10; // 10 web requests simultaneously max
+Vectors.fastQueueTime = 10; // time to wait if no other entries are added
+Vectors.waitQueueTime = 100; // time to wait to collect entries if 1+ entries are added
+```
+
+## Acknowledgements
 
 Special thank you to [Scott Gamble](https://x.com/threesided) who helps run all
 of the front-of-house work for instant.dev 💜!

package/core/vector_manager.js

@@ -83,18 +83,29 @@ class VectorManager {
     let i = 0;
     while (batches.length) {
       const parallelBatches = batches.splice(0, this.maximumParallelRequests);
-      const parallelVectors = await Promise.all(parallelBatches.map(strValues => this.vectorizeValues(strValues)));
-      parallelVectors.forEach((vectors, j) => {
-        vectors = Array.isArray(vectors)
-          ? vectors
-          : [];
-        parallelBatches[j].forEach((str, k) => {
-          if (vectors[k]) {
-            this._results.set(queue[i++], vectors[k]);
-          } else {
-            this._results.set(queue[i++], -1);
-          }
-        });
+      const parallelVectors = await Promise.allSettled(parallelBatches.map(strValues => this.vectorizeValues(strValues)));
+      parallelVectors.forEach((result, j) => {
+        if (result.status === 'rejected') {
+          parallelBatches[j].forEach((str, k) => {
+            let reason = result.reason;
+            if (!(reason instanceof Error)) {
+              reason = new Error(reason);
+            }
+            this._results.set(queue[i++], reason);
+          });
+        } else {
+          let vectors = result.value;
+          vectors = Array.isArray(vectors)
+            ? vectors
+            : [];
+          parallelBatches[j].forEach((str, k) => {
+            if (vectors[k]) {
+              this._results.set(queue[i++], vectors[k]);
+            } else {
+              this._results.set(queue[i++], -1);
+            }
+          });
+        }
       });
     }
     return true;
@@ -165,7 +176,9 @@ class VectorManager {
       await this.__sleep__(10);
     }
     this._results.delete(item);
-    if (!Array.isArray(result)) {
+    if (result instanceof Error) {
+      throw result;
+    } else if (!Array.isArray(result)) {
       throw new Error(
         `Could not vectorize: vector engine did not return a valid vector for input "${value}"`
       );

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@instant.dev/vectors",
-  "version": "0.1.0",
+  "version": "0.1.2",
   "description": "Utility for batch creating vectors via API",
   "main": "index.js",
   "scripts": {

package/test/tests/vectors.js

@@ -50,6 +50,27 @@ module.exports = (InstantORM, Databases) => {
 
     });
 
+    it('Should throw error when vector engine throws error', async () => {
+
+      const testPhrase = `I am extremely happy`;
+
+      Vectors.setEngine(async (values) => {
+        throw new Error(`Not good!`);
+      });
+      
+      let vector;
+
+      try {
+        vector = await Vectors.create(testPhrase);
+      } catch (e) {
+        error = e;
+      }
+
+      expect(error).to.exist;
+      expect(error.message).to.equal('Not good!');
+
+    });
+
     it('Should succeed at vectorizing when vector engine is set properly', async () => {
 
       const testPhrase = `I am extremely happy`;