@wiscale/velesdb-sdk 1.9.1 → 1.9.2

package/README.md

@@ -2,9 +2,17 @@
 
 Official TypeScript SDK for [VelesDB](https://github.com/cyberlife-coder/VelesDB) -- the local-first vector database for AI and RAG. Sub-millisecond semantic search in Browser and Node.js.
 
-**v1.9.1** | Node.js >= 18 | Browser (WASM) | MIT License
+**v1.9.2** | Node.js >= 18 | Browser (WASM) | MIT License
 
-## What's New in v1.9.1
+## What's New in v1.9.2
+
+- **SearchQuality type** -- new `SearchQuality` type and `quality` field in `SearchOptions` for per-query recall/latency control (`fast`, `balanced`, `accurate`, `perfect`, `custom:N`, `adaptive:min:max`)
+- **StorageMode in HnswParams** -- `storageMode` field in HNSW configuration
+- **Relative score fusion** -- `'relative_score'` fusion strategy in `MultiQuerySearchOptions`
+- **DistanceMetric "ip" alias** -- `"ip"` accepted as an alias for `"dot"` (inner product)
+- **StorageMode aliases** -- `"f32"`, `"int8"`, `"bit"` accepted as aliases for `"full"`, `"sq8"`, `"binary"`
+
+### Previous (v1.9.1)
 
 - **Agent Memory API** -- semantic, episodic, and procedural memory for AI agents (REST only)
 - **Graph collections** -- dedicated `createGraphCollection()` for knowledge graphs (REST only)
@@ -122,8 +130,8 @@ Create a vector collection.
 | Option | Type | Default | Description |
 |--------|------|---------|-------------|
 | `dimension` | `number` | Required | Vector dimension |
-| `metric` | `'cosine' \| 'euclidean' \| 'dot' \| 'hamming' \| 'jaccard'` | `'cosine'` | Distance metric |
-| `storageMode` | `'full' \| 'sq8' \| 'binary'` | `'full'` | Quantization mode |
+| `metric` | `'cosine' \| 'euclidean' \| 'dot' \| 'hamming' \| 'jaccard'` | `'cosine'` | Distance metric (aliases: `'ip'`/`'inner'`/`'dotproduct'` for dot) |
+| `storageMode` | `'full' \| 'sq8' \| 'binary'` | `'full'` | Quantization mode (aliases: `'f32'` for full, `'int8'` for sq8, `'bit'` for binary) |
 | `hnsw` | `{ m?: number, efConstruction?: number }` | - | HNSW index tuning |
 | `description` | `string` | - | Optional description |
 
@@ -234,6 +242,7 @@ Vector similarity search.
 | `filter` | `object` | - | Payload filter expression |
 | `includeVectors` | `boolean` | `false` | Include vectors in results |
 | `sparseVector` | `Record<number, number>` | - | Sparse vector for hybrid sparse+dense search |
+| `quality` | `SearchQuality` | - | Search quality mode (e.g., `'fast'`, `'balanced'`, `'custom:256'`, `'adaptive:32:512'`) |
 
 ```typescript
 const results = await db.search('docs', queryVector, {
@@ -689,6 +698,7 @@ import {
   type CollectionConfig,
   type VectorDocument,
   type SearchOptions,
+  type SearchQuality,
   type SearchResult,
   type SparseVector,
   type MultiQuerySearchOptions,

package/dist/index.d.mts

@@ -6,6 +6,8 @@
 type DistanceMetric = 'cosine' | 'euclidean' | 'dot' | 'hamming' | 'jaccard';
 /** Storage mode for vector quantization */
 type StorageMode = 'full' | 'sq8' | 'binary' | 'pq' | 'rabitq';
+/** Search quality preset controlling recall vs speed tradeoff. */
+type SearchQuality = 'fast' | 'balanced' | 'accurate' | 'perfect' | 'autotune' | `custom:${number}` | `adaptive:${number}:${number}`;
 /** Backend type for VelesDB connection */
 type BackendType = 'wasm' | 'rest';
 /** Numeric point ID required by velesdb-server REST API (`u64`). */
@@ -87,6 +89,8 @@ interface SearchOptions {
     includeVectors?: boolean;
     /** Optional sparse vector for hybrid sparse+dense search */
     sparseVector?: SparseVector;
+    /** Search quality preset (default: 'balanced'). */
+    quality?: SearchQuality;
 }
 /** PQ (Product Quantization) training options */
 interface PqTrainOptions {
@@ -98,7 +102,7 @@ interface PqTrainOptions {
     opq?: boolean;
 }
 /** Fusion strategy for multi-query search */
-type FusionStrategy = 'rrf' | 'average' | 'maximum' | 'weighted';
+type FusionStrategy = 'rrf' | 'average' | 'maximum' | 'weighted' | 'relative_score';
 /** Multi-query search options */
 interface MultiQuerySearchOptions {
     /** Number of results to return (default: 10) */
@@ -1324,4 +1328,4 @@ declare class VelesQLBuilder {
  */
 declare function velesql(): VelesQLBuilder;
 
-export { type AddEdgeRequest, AgentMemoryClient, type AgentMemoryConfig, type AggregationQueryResponse, type BackendType, BackpressureError, type Collection, type CollectionConfig, type CollectionConfigResponse, type CollectionSanityChecks, type CollectionSanityDiagnostics, type CollectionSanityResponse, type CollectionStatsResponse, type CollectionType, ConnectionError, type CreateIndexOptions, type DegreeResponse, type DistanceMetric, type EdgesResponse, type EpisodicEvent, type ExplainCost, type ExplainFeatures, type ExplainPlanStep, type ExplainResponse, type FusionOptions, type FusionStrategy, type GetEdgesOptions, type GraphCollectionConfig, type GraphEdge, type GraphSchemaMode, type HnswParams, type IVelesDBBackend, type IndexInfo, type IndexType, type MultiQuerySearchOptions, type NearVectorOptions, NotFoundError, type PqTrainOptions, type ProceduralPattern, type QueryApiResponse, type QueryOptions, type QueryResponse, type QueryResult, type QueryStats, type RelDirection, type RelOptions, RestBackend, type RestPointId, type SearchOptions, type SearchResult, type SemanticEntry, type SparseVector, type StorageMode, type TraversalResultItem, type TraversalStats, type TraverseRequest, type TraverseResponse, ValidationError, type VectorDocument, VelesDB, type VelesDBConfig, VelesDBError, VelesQLBuilder, WasmBackend, velesql };
+export { type AddEdgeRequest, AgentMemoryClient, type AgentMemoryConfig, type AggregationQueryResponse, type BackendType, BackpressureError, type Collection, type CollectionConfig, type CollectionConfigResponse, type CollectionSanityChecks, type CollectionSanityDiagnostics, type CollectionSanityResponse, type CollectionStatsResponse, type CollectionType, ConnectionError, type CreateIndexOptions, type DegreeResponse, type DistanceMetric, type EdgesResponse, type EpisodicEvent, type ExplainCost, type ExplainFeatures, type ExplainPlanStep, type ExplainResponse, type FusionOptions, type FusionStrategy, type GetEdgesOptions, type GraphCollectionConfig, type GraphEdge, type GraphSchemaMode, type HnswParams, type IVelesDBBackend, type IndexInfo, type IndexType, type MultiQuerySearchOptions, type NearVectorOptions, NotFoundError, type PqTrainOptions, type ProceduralPattern, type QueryApiResponse, type QueryOptions, type QueryResponse, type QueryResult, type QueryStats, type RelDirection, type RelOptions, RestBackend, type RestPointId, type SearchOptions, type SearchQuality, type SearchResult, type SemanticEntry, type SparseVector, type StorageMode, type TraversalResultItem, type TraversalStats, type TraverseRequest, type TraverseResponse, ValidationError, type VectorDocument, VelesDB, type VelesDBConfig, VelesDBError, VelesQLBuilder, WasmBackend, velesql };

package/dist/index.d.ts

@@ -6,6 +6,8 @@
 type DistanceMetric = 'cosine' | 'euclidean' | 'dot' | 'hamming' | 'jaccard';
 /** Storage mode for vector quantization */
 type StorageMode = 'full' | 'sq8' | 'binary' | 'pq' | 'rabitq';
+/** Search quality preset controlling recall vs speed tradeoff. */
+type SearchQuality = 'fast' | 'balanced' | 'accurate' | 'perfect' | 'autotune' | `custom:${number}` | `adaptive:${number}:${number}`;
 /** Backend type for VelesDB connection */
 type BackendType = 'wasm' | 'rest';
 /** Numeric point ID required by velesdb-server REST API (`u64`). */
@@ -87,6 +89,8 @@ interface SearchOptions {
     includeVectors?: boolean;
     /** Optional sparse vector for hybrid sparse+dense search */
     sparseVector?: SparseVector;
+    /** Search quality preset (default: 'balanced'). */
+    quality?: SearchQuality;
 }
 /** PQ (Product Quantization) training options */
 interface PqTrainOptions {
@@ -98,7 +102,7 @@ interface PqTrainOptions {
     opq?: boolean;
 }
 /** Fusion strategy for multi-query search */
-type FusionStrategy = 'rrf' | 'average' | 'maximum' | 'weighted';
+type FusionStrategy = 'rrf' | 'average' | 'maximum' | 'weighted' | 'relative_score';
 /** Multi-query search options */
 interface MultiQuerySearchOptions {
     /** Number of results to return (default: 10) */
@@ -1324,4 +1328,4 @@ declare class VelesQLBuilder {
  */
 declare function velesql(): VelesQLBuilder;
 
-export { type AddEdgeRequest, AgentMemoryClient, type AgentMemoryConfig, type AggregationQueryResponse, type BackendType, BackpressureError, type Collection, type CollectionConfig, type CollectionConfigResponse, type CollectionSanityChecks, type CollectionSanityDiagnostics, type CollectionSanityResponse, type CollectionStatsResponse, type CollectionType, ConnectionError, type CreateIndexOptions, type DegreeResponse, type DistanceMetric, type EdgesResponse, type EpisodicEvent, type ExplainCost, type ExplainFeatures, type ExplainPlanStep, type ExplainResponse, type FusionOptions, type FusionStrategy, type GetEdgesOptions, type GraphCollectionConfig, type GraphEdge, type GraphSchemaMode, type HnswParams, type IVelesDBBackend, type IndexInfo, type IndexType, type MultiQuerySearchOptions, type NearVectorOptions, NotFoundError, type PqTrainOptions, type ProceduralPattern, type QueryApiResponse, type QueryOptions, type QueryResponse, type QueryResult, type QueryStats, type RelDirection, type RelOptions, RestBackend, type RestPointId, type SearchOptions, type SearchResult, type SemanticEntry, type SparseVector, type StorageMode, type TraversalResultItem, type TraversalStats, type TraverseRequest, type TraverseResponse, ValidationError, type VectorDocument, VelesDB, type VelesDBConfig, VelesDBError, VelesQLBuilder, WasmBackend, velesql };
+export { type AddEdgeRequest, AgentMemoryClient, type AgentMemoryConfig, type AggregationQueryResponse, type BackendType, BackpressureError, type Collection, type CollectionConfig, type CollectionConfigResponse, type CollectionSanityChecks, type CollectionSanityDiagnostics, type CollectionSanityResponse, type CollectionStatsResponse, type CollectionType, ConnectionError, type CreateIndexOptions, type DegreeResponse, type DistanceMetric, type EdgesResponse, type EpisodicEvent, type ExplainCost, type ExplainFeatures, type ExplainPlanStep, type ExplainResponse, type FusionOptions, type FusionStrategy, type GetEdgesOptions, type GraphCollectionConfig, type GraphEdge, type GraphSchemaMode, type HnswParams, type IVelesDBBackend, type IndexInfo, type IndexType, type MultiQuerySearchOptions, type NearVectorOptions, NotFoundError, type PqTrainOptions, type ProceduralPattern, type QueryApiResponse, type QueryOptions, type QueryResponse, type QueryResult, type QueryStats, type RelDirection, type RelOptions, RestBackend, type RestPointId, type SearchOptions, type SearchQuality, type SearchResult, type SemanticEntry, type SparseVector, type StorageMode, type TraversalResultItem, type TraversalStats, type TraverseRequest, type TraverseResponse, ValidationError, type VectorDocument, VelesDB, type VelesDBConfig, VelesDBError, VelesQLBuilder, WasmBackend, velesql };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@wiscale/velesdb-sdk",
-  "version": "1.9.1",
+  "version": "1.9.2",
   "description": "VelesDB TypeScript SDK: The Local Vector Database for AI & RAG. Microsecond semantic search in Browser & Node.js.",
   "main": "dist/index.js",
   "module": "dist/index.mjs",