Skip to content

Commit 2535dbf

Browse files
committed
update README.md
1 parent cec9239 commit 2535dbf

File tree

1 file changed

+10
-10
lines changed

1 file changed

+10
-10
lines changed

README.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -77,7 +77,7 @@ import io.endee.client.types.SpaceType;
7777

7878
CreateIndexOptions options = CreateIndexOptions.builder("my_vectors", 384)
7979
.spaceType(SpaceType.COSINE)
80-
.precision(Precision.INT8D)
80+
.precision(Precision.INT8)
8181
.build();
8282

8383
client.createIndex(options);
@@ -92,7 +92,7 @@ client.createIndex(options);
9292
| `spaceType` | Distance metric - `COSINE`, `L2`, or `IP` (inner product) | `COSINE` |
9393
| `m` | Graph connectivity - higher values increase recall but use more memory | 16 |
9494
| `efCon` | Construction-time parameter - higher values improve index quality | 128 |
95-
| `precision` | Quantization precision | `INT8D` |
95+
| `precision` | Quantization precision | `INT8` |
9696

9797
### Create a Hybrid Index
9898

@@ -102,7 +102,7 @@ Hybrid indexes combine dense vector search with sparse vector search. Add the `s
102102
CreateIndexOptions options = CreateIndexOptions.builder("hybrid_index", 384)
103103
.sparseDimension(30000) // Sparse vector dimension (vocabulary size)
104104
.spaceType(SpaceType.COSINE)
105-
.precision(Precision.INT8D)
105+
.precision(Precision.INT8)
106106
.build();
107107

108108
client.createIndex(options);
@@ -365,7 +365,7 @@ IndexDescription info = index.describe();
365365
System.out.println(info);
366366
// IndexDescription{name='my_index', spaceType=COSINE, dimension=384,
367367
// sparseDimension=0, isHybrid=false, count=1000,
368-
// precision=INT8D, m=16}
368+
// precision=INT8, m=16}
369369
```
370370

371371
### Check if Index is Hybrid
@@ -382,8 +382,8 @@ Endee supports different quantization precision levels:
382382
import io.endee.client.types.Precision;
383383

384384
Precision.BINARY // Binary quantization (1-bit) - smallest storage, fastest search
385-
Precision.INT8D // 8-bit integer quantization (default) - balanced performance
386-
Precision.INT16D // 16-bit integer quantization - higher precision
385+
Precision.INT8 // 8-bit integer quantization (default) - balanced performance
386+
Precision.INT16 // 16-bit integer quantization - higher precision
387387
Precision.FLOAT16 // 16-bit floating point - good balance
388388
Precision.FLOAT32 // 32-bit floating point - highest precision
389389
```
@@ -393,8 +393,8 @@ Precision.FLOAT32 // 32-bit floating point - highest precision
393393
| Precision | Use Case |
394394
| --------- | ------------------------------------------------------------------------- |
395395
| `BINARY` | Very large datasets where speed and storage are critical |
396-
| `INT8D` | Recommended for most use cases - good balance of accuracy and performance |
397-
| `INT16D` | Better accuracy than INT8D but less storage than FLOAT32 |
396+
| `INT8` | Recommended for most use cases - good balance of accuracy and performance |
397+
| `INT16` | Better accuracy than INT8 but less storage than FLOAT32 |
398398
| `FLOAT16` | Good compromise between precision and storage for embeddings |
399399
| `FLOAT32` | Maximum precision when storage is not a concern |
400400

@@ -460,7 +460,7 @@ public class EndeeExample {
460460
// Create a dense index
461461
CreateIndexOptions createOptions = CreateIndexOptions.builder("documents", 384)
462462
.spaceType(SpaceType.COSINE)
463-
.precision(Precision.INT8D)
463+
.precision(Precision.INT8)
464464
.build();
465465

466466
client.createIndex(createOptions);
@@ -540,7 +540,7 @@ CreateIndexOptions.builder(String name, int dimension)
540540
.spaceType(SpaceType) // Default: COSINE
541541
.m(int) // Default: 16
542542
.efCon(int) // Default: 128
543-
.precision(Precision) // Default: INT8D
543+
.precision(Precision) // Default: INT8
544544
.sparseDimension(Integer) // Optional, for hybrid indexes
545545
.build()
546546
```

0 commit comments

Comments
 (0)