@faiss-node/native 0.1.4 โ 0.1.5
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.
- package/README.md +1 -16
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -5,7 +5,7 @@
|
|
|
5
5
|
[](https://opensource.org/licenses/MIT)
|
|
6
6
|
[](https://anupammaurya6767.github.io/faiss-node-native/)
|
|
7
7
|
|
|
8
|
-
High-performance Node.js native bindings for [Facebook FAISS](https://github.com/facebookresearch/faiss) - the industry-standard vector similarity search library. Built for
|
|
8
|
+
High-performance Node.js native bindings for [Facebook FAISS](https://github.com/facebookresearch/faiss) - the industry-standard vector similarity search library. Built for semantic search, RAG applications, and vector databases.
|
|
9
9
|
|
|
10
10
|
## Features
|
|
11
11
|
|
|
@@ -14,9 +14,7 @@ High-performance Node.js native bindings for [Facebook FAISS](https://github.com
|
|
|
14
14
|
- ๐ฆ **Multiple Index Types** - FLAT_L2, IVF_FLAT, and HNSW with optimized defaults
|
|
15
15
|
- ๐พ **Persistence** - Save/load indexes to disk or serialize to buffers
|
|
16
16
|
- โก **High Performance** - Direct C++ bindings with zero-copy data transfer
|
|
17
|
-
- ๐งช **Well-Tested** - 1000+ comprehensive tests covering edge cases
|
|
18
17
|
- ๐ **TypeScript Support** - Full type definitions included
|
|
19
|
-
- ๐ง **Production-Ready** - Memory-safe, error-handled, and battle-tested
|
|
20
18
|
|
|
21
19
|
## Installation
|
|
22
20
|
|
|
@@ -482,19 +480,6 @@ npm run docs:serve # Serve docs locally at http://localhost:8000
|
|
|
482
480
|
- **Examples**: See `examples/` directory
|
|
483
481
|
- **Contributing**: See [CONTRIBUTING.md](./CONTRIBUTING.md)
|
|
484
482
|
|
|
485
|
-
## Comparison with Other Packages
|
|
486
|
-
|
|
487
|
-
### vs. `faiss-node` (ewfian)
|
|
488
|
-
|
|
489
|
-
| Feature | @faiss-node/native | faiss-node |
|
|
490
|
-
|---------|-------------------|------------|
|
|
491
|
-
| Async Operations | โ
Promise-based | โ Synchronous (blocks event loop) |
|
|
492
|
-
| Thread Safety | โ
Mutex-protected | โ Not thread-safe |
|
|
493
|
-
| API Design | โ
High-level wrapper | โ ๏ธ Low-level FAISS classes |
|
|
494
|
-
| TypeScript | โ
Full support | โ ๏ธ Partial |
|
|
495
|
-
| Testing | โ
1000+ tests | โ ๏ธ Minimal |
|
|
496
|
-
| Production Ready | โ
Yes | โ ๏ธ Early stage |
|
|
497
|
-
|
|
498
483
|
## Troubleshooting
|
|
499
484
|
|
|
500
485
|
### Build Errors
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@faiss-node/native",
|
|
3
|
-
"version": "0.1.
|
|
3
|
+
"version": "0.1.5",
|
|
4
4
|
"description": "High-performance Node.js native bindings for Facebook FAISS - the fastest vector similarity search library. Supports FLAT_L2, IVF_FLAT, and HNSW index types with async operations, persistence, and batch search.",
|
|
5
5
|
"main": "src/js/index.js",
|
|
6
6
|
"types": "src/js/types.d.ts",
|