@lancedb/lancedb 0.14.1-beta.1 → 0.14.1-beta.2

package/dist/indices.d.ts

@@ -29,6 +29,15 @@ export interface IvfPqOptions {
      * will likely result in poor performance.
      */
     numSubVectors?: number;
+    /**
+     * Number of bits per sub-vector.
+     *
+     * This value controls how much each subvector is compressed.  The more bits the more
+     * accurate the index will be but the slower search.  The default is 8 bits.
+     *
+     * The number of bits must be 4 or 8.
+     */
+    numBits?: number;
     /**
      * Distance type to use to build the index.
      *

package/dist/native.d.ts

@@ -257,7 +257,7 @@ export class Connection {
   dropTable(name: string): Promise<void>
 }
 export class Index {
-  static ivfPq(distanceType?: string | undefined | null, numPartitions?: number | undefined | null, numSubVectors?: number | undefined | null, maxIterations?: number | undefined | null, sampleRate?: number | undefined | null): Index
+  static ivfPq(distanceType?: string | undefined | null, numPartitions?: number | undefined | null, numSubVectors?: number | undefined | null, numBits?: number | undefined | null, maxIterations?: number | undefined | null, sampleRate?: number | undefined | null): Index
   static btree(): Index
   static bitmap(): Index
   static labelList(): Index

package/package.json

@@ -11,7 +11,7 @@
     "ann"
   ],
   "private": false,
-  "version": "0.14.1-beta.1",
+  "version": "0.14.1-beta.2",
   "main": "dist/index.js",
   "exports": {
     ".": "./dist/index.js",
@@ -48,11 +48,10 @@
     "@types/jest": "^29.1.2",
     "@types/node": "^22.7.4",
     "@types/tmp": "^0.2.6",
-    "apache-arrow-13": "npm:apache-arrow@13.0.0",
-    "apache-arrow-14": "npm:apache-arrow@14.0.0",
     "apache-arrow-15": "npm:apache-arrow@15.0.0",
     "apache-arrow-16": "npm:apache-arrow@16.0.0",
     "apache-arrow-17": "npm:apache-arrow@17.0.0",
+    "apache-arrow-18": "npm:apache-arrow@18.0.0",
     "eslint": "^8.57.0",
     "jest": "^29.7.0",
     "shx": "^0.3.4",
@@ -86,6 +85,7 @@
     "build-release": "npm run build:release && tsc -b && shx cp lancedb/native.d.ts dist/native.d.ts",
     "lint-ci": "biome ci .",
     "docs": "typedoc --plugin typedoc-plugin-markdown --out ../docs/src/js lancedb/index.ts",
+    "postdocs": "node typedoc_post_process.js",
     "lint": "biome check . && biome format .",
     "lint-fix": "biome check --write . && biome format --write .",
     "prepublishOnly": "napi prepublish -t npm",
@@ -98,16 +98,16 @@
     "reflect-metadata": "^0.2.2"
   },
   "optionalDependencies": {
-    "@lancedb/lancedb-darwin-x64": "0.14.1-beta.1",
-    "@lancedb/lancedb-darwin-arm64": "0.14.1-beta.1",
-    "@lancedb/lancedb-linux-x64-gnu": "0.14.1-beta.1",
-    "@lancedb/lancedb-linux-arm64-gnu": "0.14.1-beta.1",
-    "@lancedb/lancedb-linux-x64-musl": "0.14.1-beta.1",
-    "@lancedb/lancedb-linux-arm64-musl": "0.14.1-beta.1",
-    "@lancedb/lancedb-win32-x64-msvc": "0.14.1-beta.1",
-    "@lancedb/lancedb-win32-arm64-msvc": "0.14.1-beta.1"
+    "@lancedb/lancedb-darwin-x64": "0.14.1-beta.2",
+    "@lancedb/lancedb-darwin-arm64": "0.14.1-beta.2",
+    "@lancedb/lancedb-linux-x64-gnu": "0.14.1-beta.2",
+    "@lancedb/lancedb-linux-arm64-gnu": "0.14.1-beta.2",
+    "@lancedb/lancedb-linux-x64-musl": "0.14.1-beta.2",
+    "@lancedb/lancedb-linux-arm64-musl": "0.14.1-beta.2",
+    "@lancedb/lancedb-win32-x64-msvc": "0.14.1-beta.2",
+    "@lancedb/lancedb-win32-arm64-msvc": "0.14.1-beta.2"
   },
   "peerDependencies": {
-    "apache-arrow": ">=13.0.0 <=17.0.0"
+    "apache-arrow": ">=15.0.0 <=18.1.0"
   }
 }

package/typedoc_post_process.js

@@ -0,0 +1,63 @@
+const fs = require("fs");
+const path = require("path");
+
+// Read all files in the directory
+function processDirectory(directoryPath) {
+  fs.readdir(directoryPath, { withFileTypes: true }, (err, files) => {
+    if (err) {
+      return console.error("Unable to scan directory: " + err);
+    }
+
+    files.forEach((file) => {
+      const filePath = path.join(directoryPath, file.name);
+
+      if (file.isDirectory()) {
+        // Recursively process subdirectory
+        processDirectory(filePath);
+      } else if (file.isFile()) {
+        // Read each file
+        fs.readFile(filePath, "utf8", (err, data) => {
+          if (err) {
+            return console.error("Unable to read file: " + err);
+          }
+
+          // Process the file content
+          const processedData = processContents(data);
+
+          // Write the processed content back to the file
+          fs.writeFile(filePath, processedData, "utf8", (err) => {
+            if (err) {
+              return console.error("Unable to write file: " + err);
+            }
+            console.log(`Processed file: ${filePath}`);
+          });
+        });
+      }
+    });
+  });
+}
+
+function processContents(contents) {
+  // This changes the parameters section to put the parameter description on
+  // the same line as the bullet with the parameter name and type.
+  return contents.replace(/(## Parameters[\s\S]*?)(?=##|$)/g, (match) => {
+    let lines = match
+      .split("\n")
+      .map((line) => line.trim())
+
+      .filter((line) => line !== "")
+      .map((line) => {
+        if (line.startsWith("##")) {
+          return line;
+        } else if (line.startsWith("•")) {
+          return "\n*" + line.substring(1);
+        } else {
+          return "    " + line;
+        }
+      });
+    return lines.join("\n") + "\n\n";
+  });
+}
+
+// Start processing from the root directory
+processDirectory("../docs/src/js");