@ruvector/rvf-node 0.4.1 → 0.4.2

package/index.d.ts

@@ -25,6 +25,8 @@ export interface RvfQueryOptions {
 export interface RvfSearchResult {
   id: number;
   distance: number;
+  /** The vector's committed metadata record; absent when it has none. */
+  metadata?: RvfMetadataEntry[];
 }
 
 export interface RvfIngestResult {
@@ -57,10 +59,17 @@ export interface RvfStatus {
 
 export interface RvfMetadataEntry {
   fieldId: number;
+  /** "u64" | "i64" | "f64" | "string" | "bool" | "null" | "bytes" (hex). */
   valueType: string;
   value: string;
 }
 
+/** One vector's metadata record for `ingestBatchWithMetadata`. */
+export interface RvfVectorMetadata {
+  id: number;
+  fields: RvfMetadataEntry[];
+}
+
 export interface RvfKernelData {
   header: Buffer;
   image: Buffer;
@@ -88,6 +97,16 @@ export class RvfDatabase {
   query(vector: Float32Array, k: number, options?: RvfQueryOptions): RvfSearchResult[];
   /** `query` on the libuv threadpool (read lock; concurrent calls run in parallel). Rejects on error. */
   queryAsync(vector: Float32Array, k: number, options?: RvfQueryOptions): Promise<RvfSearchResult[]>;
+  /** Ingest vectors with per-vector metadata records (durable; returned on hits). */
+  ingestBatchWithMetadata(vectors: Float32Array, ids: number[], records: RvfVectorMetadata[]): RvfIngestResult;
+  /** `ingestBatchWithMetadata` on the libuv threadpool (write lock). */
+  ingestBatchWithMetadataAsync(vectors: Float32Array, ids: number[], records: RvfVectorMetadata[]): Promise<RvfIngestResult>;
+  /** A vector's committed metadata record, or null. */
+  getMetadata(id: number): RvfMetadataEntry[] | null;
+  /** A file-level metadata value, or null. */
+  getFileMetadata(key: string): string | null;
+  /** Durably set a file-level metadata value (`rvf.*` keys are reserved). */
+  setFileMetadata(key: string, value: string): void;
   delete(ids: number[]): RvfDeleteResult;
   /** `delete` on the libuv threadpool (write lock). Rejects on error. */
   deleteAsync(ids: number[]): Promise<RvfDeleteResult>;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ruvector/rvf-node",
-  "version": "0.4.1",
+  "version": "0.4.2",
   "description": "RuVector Format Node.js native bindings",
   "main": "index.js",
   "types": "index.d.ts",