endee 1.1.1 → 1.1.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.
- package/README.md +8 -8
- package/dist/endee.class.js +1 -1
- package/dist/index.class.js +1 -1
- package/dist/types/index.d.ts +2 -2
- package/dist/types/index.d.ts.map +1 -1
- package/dist/types/index.js +2 -2
- package/dist/types/index.js.map +1 -1
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -62,7 +62,7 @@ await client.createIndex({
|
|
|
62
62
|
name: 'my_vectors',
|
|
63
63
|
dimension: 384,
|
|
64
64
|
spaceType: 'cosine',
|
|
65
|
-
precision: Precision.
|
|
65
|
+
precision: Precision.INT16,
|
|
66
66
|
});
|
|
67
67
|
```
|
|
68
68
|
|
|
@@ -75,7 +75,7 @@ await client.createIndex({
|
|
|
75
75
|
| `spaceType` | Distance metric - `"cosine"`, `"l2"`, or `"ip"` (inner product) |
|
|
76
76
|
| `M` | Graph connectivity - higher values increase recall but use more memory (default: 16) |
|
|
77
77
|
| `efCon` | Construction-time parameter - higher values improve index quality (default: 128) |
|
|
78
|
-
| `precision` | Quantization precision (default: `Precision.
|
|
78
|
+
| `precision` | Quantization precision (default: `Precision.INT16`) |
|
|
79
79
|
|
|
80
80
|
### Create a Hybrid Index
|
|
81
81
|
|
|
@@ -87,7 +87,7 @@ await client.createIndex({
|
|
|
87
87
|
dimension: 384, // Dense vector dimension
|
|
88
88
|
sparseDimension: 30000, // Sparse vector dimension (vocabulary size)
|
|
89
89
|
spaceType: 'cosine',
|
|
90
|
-
precision: Precision.
|
|
90
|
+
precision: Precision.INT16,
|
|
91
91
|
});
|
|
92
92
|
```
|
|
93
93
|
|
|
@@ -371,8 +371,8 @@ Endee supports different quantization precision levels:
|
|
|
371
371
|
import { Precision } from 'endee';
|
|
372
372
|
|
|
373
373
|
Precision.BINARY; // Binary quantization (1-bit) - smallest storage, fastest search
|
|
374
|
-
Precision.
|
|
375
|
-
Precision.
|
|
374
|
+
Precision.INT8; // 8-bit integer quantization - balanced performance
|
|
375
|
+
Precision.INT16; // 16-bit integer quantization (default) - higher precision
|
|
376
376
|
Precision.FLOAT16; // 16-bit floating point - good balance
|
|
377
377
|
Precision.FLOAT32; // 32-bit floating point - highest precision
|
|
378
378
|
```
|
|
@@ -380,8 +380,8 @@ Precision.FLOAT32; // 32-bit floating point - highest precision
|
|
|
380
380
|
**Choosing Precision:**
|
|
381
381
|
|
|
382
382
|
- `BINARY`: Best for very large datasets where speed and storage are critical
|
|
383
|
-
- `
|
|
384
|
-
- `
|
|
383
|
+
- `INT8` : Recommended for most use cases - good balance of accuracy and performance
|
|
384
|
+
- `INT16` (default) : When you need better accuracy than INT8 but less storage than FLOAT32
|
|
385
385
|
- `FLOAT16`: Good compromise between precision and storage for embeddings
|
|
386
386
|
- `FLOAT32`: When you need maximum precision and storage is not a concern
|
|
387
387
|
|
|
@@ -398,7 +398,7 @@ await client.createIndex({
|
|
|
398
398
|
name: 'documents',
|
|
399
399
|
dimension: 384,
|
|
400
400
|
spaceType: 'cosine',
|
|
401
|
-
precision: Precision.
|
|
401
|
+
precision: Precision.INT16,
|
|
402
402
|
});
|
|
403
403
|
|
|
404
404
|
// Get the index
|
package/dist/endee.class.js
CHANGED
|
@@ -27,7 +27,7 @@ export class Endee {
|
|
|
27
27
|
return url;
|
|
28
28
|
}
|
|
29
29
|
async createIndex(options) {
|
|
30
|
-
const { name, dimension, spaceType = 'cosine', M = 16, efCon = 128, precision = Precision.
|
|
30
|
+
const { name, dimension, spaceType = 'cosine', M = 16, efCon = 128, precision = Precision.INT16, version = null, sparseDimension = null, } = options;
|
|
31
31
|
if (!isValidIndexName(name)) {
|
|
32
32
|
throw new Error('Invalid index name. Index name must be alphanumeric and can contain underscores and less than 48 characters');
|
|
33
33
|
}
|
package/dist/index.class.js
CHANGED
|
@@ -23,7 +23,7 @@ export class Index {
|
|
|
23
23
|
this.count = params.total_elements || 0;
|
|
24
24
|
this.spaceType = params.spaceType || 'cosine';
|
|
25
25
|
this.dimension = params.dimension || 0;
|
|
26
|
-
this.precision = params.precision || Precision.
|
|
26
|
+
this.precision = params.precision || Precision.INT16;
|
|
27
27
|
this.M = params.M || 16;
|
|
28
28
|
this.sparseDimension = params.sparseDimension || 0;
|
|
29
29
|
}
|
package/dist/types/index.d.ts
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/types/index.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,MAAM,MAAM,SAAS,GAAG,QAAQ,GAAG,IAAI,GAAG,IAAI,CAAC;AAE/C,oBAAY,SAAS;IACnB,MAAM,WAAW;IACjB,KAAK,UAAU;IACf,
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/types/index.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,MAAM,MAAM,SAAS,GAAG,QAAQ,GAAG,IAAI,GAAG,IAAI,CAAC;AAE/C,oBAAY,SAAS;IACnB,MAAM,WAAW;IACjB,IAAI,SAAS;IACb,KAAK,UAAU;IACf,OAAO,YAAY;IACnB,OAAO,YAAY;CACpB;AAED,MAAM,WAAW,kBAAkB;IACjC,IAAI,EAAE,MAAM,CAAC;IACb,SAAS,EAAE,MAAM,CAAC;IAClB,SAAS,CAAC,EAAE,SAAS,CAAC;IACtB,CAAC,CAAC,EAAE,MAAM,CAAC;IACX,SAAS,CAAC,EAAE,SAAS,CAAC;IACtB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,eAAe,CAAC,EAAE,MAAM,CAAC;CAC1B;AAED,MAAM,WAAW,UAAU;IACzB,EAAE,EAAE,MAAM,CAAC;IACX,MAAM,EAAE,MAAM,EAAE,CAAC;IACjB,aAAa,CAAC,EAAE,MAAM,EAAE,CAAC;IACzB,YAAY,CAAC,EAAE,MAAM,EAAE,CAAC;IACxB,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAC/B,MAAM,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;CAClC;AAED,MAAM,WAAW,YAAY;IAC3B,MAAM,CAAC,EAAE,MAAM,EAAE,CAAC;IAClB,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC,GAAG,IAAI,CAAC;IAC/C,EAAE,CAAC,EAAE,MAAM,CAAC;IACZ,cAAc,CAAC,EAAE,OAAO,CAAC;IACzB,aAAa,CAAC,EAAE,MAAM,EAAE,CAAC;IACzB,YAAY,CAAC,EAAE,MAAM,EAAE,CAAC;IACxB,6BAA6B,CAAC,EAAE,MAAM,CAAC;IACvC,qBAAqB,CAAC,EAAE,MAAM,CAAC;CAChC;AAED,MAAM,WAAW,WAAW;IAC1B,EAAE,EAAE,MAAM,CAAC;IACX,UAAU,EAAE,MAAM,CAAC;IACnB,QAAQ,EAAE,MAAM,CAAC;IACjB,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAC/B,MAAM,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IACjC,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,MAAM,CAAC,EAAE,MAAM,EAAE,CAAC;CACnB;AAED,MAAM,WAAW,SAAS;IACxB,IAAI,EAAE,MAAM,CAAC;IACb,SAAS,EAAE,SAAS,CAAC;IACrB,SAAS,EAAE,MAAM,CAAC;IAClB,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,SAAS,EAAE,SAAS,CAAC;IACrB,CAAC,CAAC,EAAE,MAAM,CAAC;IACX,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,eAAe,CAAC,EAAE,MAAM,CAAC;CAC1B;AAED,MAAM,WAAW,gBAAgB;IAC/B,IAAI,EAAE,MAAM,CAAC;IACb,SAAS,EAAE,SAAS,CAAC;IACrB,SAAS,EAAE,MAAM,CAAC;IAClB,QAAQ,EAAE,OAAO,CAAC;IAClB,KAAK,EAAE,MAAM,CAAC;IACd,SAAS,EAAE,SAAS,CAAC;IACrB,CAAC,EAAE,MAAM,CAAC;IACV,eAAe,CAAC,EAAE,MAAM,CAAC;CAC1B;AAED,MAAM,WAAW,UAAU;IACzB,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAC9B,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAChC,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,EAAE,MAAM,EAAE,CAAC;CAClB"}
|
package/dist/types/index.js
CHANGED
|
@@ -4,8 +4,8 @@
|
|
|
4
4
|
export var Precision;
|
|
5
5
|
(function (Precision) {
|
|
6
6
|
Precision["BINARY"] = "binary";
|
|
7
|
-
Precision["
|
|
8
|
-
Precision["
|
|
7
|
+
Precision["INT8"] = "int8";
|
|
8
|
+
Precision["INT16"] = "int16";
|
|
9
9
|
Precision["FLOAT16"] = "float16";
|
|
10
10
|
Precision["FLOAT32"] = "float32";
|
|
11
11
|
})(Precision || (Precision = {}));
|
package/dist/types/index.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/types/index.ts"],"names":[],"mappings":"AAAA;;GAEG;AAIH,MAAM,CAAN,IAAY,SAMX;AAND,WAAY,SAAS;IACnB,8BAAiB,CAAA;IACjB,
|
|
1
|
+
{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/types/index.ts"],"names":[],"mappings":"AAAA;;GAEG;AAIH,MAAM,CAAN,IAAY,SAMX;AAND,WAAY,SAAS;IACnB,8BAAiB,CAAA;IACjB,0BAAa,CAAA;IACb,4BAAe,CAAA;IACf,gCAAmB,CAAA;IACnB,gCAAmB,CAAA;AACrB,CAAC,EANW,SAAS,KAAT,SAAS,QAMpB"}
|