endee 1.1.0-dev.1 → 1.1.0-dev.3

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/README.md +6 -6
  2. package/package.json +2 -2
package/README.md CHANGED
@@ -202,9 +202,9 @@ Controls when the search strategy switches from **HNSW filtered search** (fast,
202
202
 
203
203
  | Value | Behavior |
204
204
  |-------|----------|
205
- | `1_000` | Prefilter only for very selective filters — minimum value |
206
- | `10_000` | Prefilter only when the filter matches ≤10,000 vectors **(default)** |
207
- | `1_000_000` | Prefilter for almost all filtered searches — maximum value |
205
+ | `1,000` | Prefilter only for very selective filters — minimum value |
206
+ | `10,000` | Prefilter only when the filter matches ≤10,000 vectors **(default)** |
207
+ | `1,000,000` | Prefilter for almost all filtered searches — maximum value |
208
208
 
209
209
  The intuition: when very few vectors match your filter, HNSW may struggle to find enough valid candidates through graph traversal. In that case, scanning the filtered subset directly (prefiltering) is faster and more accurate. Raising the threshold means prefiltering kicks in more often; lowering it favors HNSW graph search.
210
210
 
@@ -214,7 +214,7 @@ const results = await index.query({
214
214
  vector: [/* ... */],
215
215
  topK: 10,
216
216
  filter: [{ category: { $eq: 'rare' } }],
217
- prefilterCardinalityThreshold: 5_000,
217
+ prefilterCardinalityThreshold: 5000,
218
218
  });
219
219
  ```
220
220
 
@@ -243,12 +243,12 @@ const results = await index.query({
243
243
  vector: [/* ... */],
244
244
  topK: 10,
245
245
  filter: [{ category: { $eq: 'rare' } }],
246
- prefilterCardinalityThreshold: 5_000, // switch to brute-force for small match sets
246
+ prefilterCardinalityThreshold: 5000, // switch to brute-force for small match sets
247
247
  filterBoostPercentage: 25, // boost candidates for HNSW filtered search
248
248
  });
249
249
  ```
250
250
 
251
- > **Tip:** Start with the defaults (`prefilterCardinalityThreshold: 10_000`, `filterBoostPercentage: 0`). If filtered queries return fewer results than expected, try increasing `filterBoostPercentage`. If filtered queries are slow on selective filters, try lowering `prefilterCardinalityThreshold`. Valid range for the threshold is `1,000–1,000,000`.
251
+ > **Tip:** Start with the defaults (`prefilterCardinalityThreshold: 10,000`, `filterBoostPercentage: 0`). If filtered queries return fewer results than expected, try increasing `filterBoostPercentage`. If filtered queries are slow on selective filters, try lowering `prefilterCardinalityThreshold`. Valid range for the threshold is `1,000–1,000,000`.
252
252
 
253
253
  ## Hybrid Search
254
254
 
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "endee",
3
- "version": "1.1.0-dev.1",
3
+ "version": "1.1.0-dev.3",
4
4
  "description": "TypeScript client for encrypted vector database with maximum security and speed",
5
5
  "main": "dist/index.js",
6
6
  "types": "dist/index.d.ts",
@@ -42,7 +42,7 @@
42
42
  },
43
43
  "devDependencies": {
44
44
  "@eslint/js": "^9.39.2",
45
- "@types/node": "^24.0.1",
45
+ "@types/node": "^24.10.13",
46
46
  "@typescript-eslint/eslint-plugin": "^8.54.0",
47
47
  "@typescript-eslint/parser": "^8.54.0",
48
48
  "eslint": "^9.39.2",