redis-vl 0.1.0-beta.0

package/dist/query/vector.d.ts

@@ -0,0 +1,199 @@
+import { BaseQuery } from './base.js';
+import { VectorDataType, VectorDistanceMetric } from '../schema/types.js';
+/**
+ * Hybrid policy options for vector search with filters
+ */
+export type HybridPolicy = 'BATCHES' | 'ADHOC_BF';
+/**
+ * USE_SEARCH_HISTORY options for SVS-VAMANA indexes
+ */
+export type UseSearchHistory = 'OFF' | 'ON' | 'AUTO';
+/**
+ * Configuration for VectorQuery
+ */
+export interface VectorQueryConfig {
+    /** Vector to search with */
+    vector: number[];
+    /** Name of the vector field in the index */
+    vectorField: string;
+    /** Number of results to return */
+    numResults?: number;
+    /** Filter expression (e.g., '@category:{electronics}') */
+    filter?: string;
+    /** Fields to return in results */
+    returnFields?: string[];
+    /** Distance metric to use */
+    distanceMetric?: VectorDistanceMetric;
+    /**
+     * Vector datatype to use when serializing the query vector.
+     * Must match the datatype declared on the schema's vector field.
+     * @default 'FLOAT32'
+     */
+    datatype?: VectorDataType | string;
+    /** Pagination offset */
+    offset?: number;
+    /** Pagination limit */
+    limit?: number;
+    /**
+     * Alias for the score field in results
+     * @default 'vector_distance'
+     */
+    scoreAlias?: string;
+    /**
+     * HNSW ef_runtime parameter - controls recall vs speed tradeoff
+     * Higher values provide better recall but slower search
+     * @default undefined (uses index default)
+     */
+    efRuntime?: number;
+    /**
+     * HNSW epsilon parameter - range search approximation factor
+     * Used for range-based vector queries
+     * @default undefined
+     */
+    epsilon?: number;
+    /**
+     * Hybrid policy for combining vector search with filters
+     * - BATCHES: Process filters in batches (better for large result sets)
+     * - ADHOC_BF: Ad-hoc brute force (better for small result sets)
+     * @default undefined
+     */
+    hybridPolicy?: HybridPolicy;
+    /**
+     * Batch size when using BATCHES hybrid policy
+     * Controls memory usage vs performance tradeoff
+     * Only applies when hybridPolicy is "BATCHES"
+     * @default undefined
+     */
+    batchSize?: number;
+    /**
+     * Normalize vector distance to similarity score between 0 and 1
+     *
+     * Redis distance metrics have different ranges:
+     * - COSINE: 0 to 2
+     * - L2: 0 to infinity
+     * - IP: Depends on vector magnitude
+     *
+     * When true, converts distances to similarity scores where:
+     * - 1.0 = perfect match (most similar)
+     * - 0.0 = completely different (least similar)
+     *
+     * Note: IP (Inner Product) cannot be normalized. Use COSINE instead,
+     * which is normalized IP by definition.
+     *
+     * @default false
+     */
+    normalizeDistance?: boolean;
+    /**
+     * SVS-VAMANA search window size parameter
+     *
+     * Controls the size of the search window for SVS-VAMANA KNN searches.
+     * Increasing this value generally yields more accurate but slower search results.
+     *
+     * Only applies when using SVS-VAMANA algorithm indexes.
+     *
+     * @default undefined (uses index default)
+     */
+    searchWindowSize?: number;
+    /**
+     * SVS-VAMANA USE_SEARCH_HISTORY parameter
+     *
+     * For SVS-VAMANA indexes, controls whether to use the search buffer
+     * or entire search history.
+     *
+     * Options:
+     * - OFF: Don't use search history
+     * - ON: Use search history
+     * - AUTO: Automatically decide based on query characteristics
+     *
+     * Only applies when using SVS-VAMANA algorithm indexes.
+     *
+     * @default undefined
+     */
+    useSearchHistory?: UseSearchHistory;
+    /**
+     * SVS-VAMANA SEARCH_BUFFER_CAPACITY parameter
+     *
+     * Tuning parameter for SVS-VAMANA indexes using two-level compression.
+     * Determines the number of vector candidates to collect in the first level
+     * of search before the re-ranking level.
+     *
+     * Higher values may improve recall at the cost of performance.
+     *
+     * Only applies when using SVS-VAMANA algorithm indexes with two-level compression.
+     *
+     * @default undefined
+     */
+    searchBufferCapacity?: number;
+}
+/**
+ * Vector similarity search query using KNN (K-Nearest Neighbors)
+ *
+ * Performs semantic search by finding documents with vectors similar to the query vector.
+ *
+ * @example
+ * ```typescript
+ * import { VectorQuery } from 'redis-vl';
+ *
+ * // Basic vector search
+ * const query = new VectorQuery({
+ *   vector: [0.1, 0.2, 0.3, ...],
+ *   vectorField: 'embedding',
+ *   numResults: 10
+ * });
+ *
+ * const results = await index.search(query);
+ * ```
+ *
+ * @example
+ * ```typescript
+ * // Vector search with metadata filtering
+ * const query = new VectorQuery({
+ *   vector: embedding,
+ *   vectorField: 'embedding',
+ *   filter: '@category:{electronics} @price:[0 1000]',
+ *   numResults: 5,
+ *   returnFields: ['title', 'price']
+ * });
+ *
+ * const results = await index.search(query);
+ * ```
+ */
+export declare class VectorQuery implements BaseQuery {
+    readonly vector: number[];
+    readonly vectorField: string;
+    readonly numResults: number;
+    readonly filter?: string;
+    readonly returnFields?: string[];
+    readonly distanceMetric: VectorDistanceMetric;
+    readonly datatype: VectorDataType;
+    readonly offset?: number;
+    readonly limit?: number;
+    readonly scoreAlias: string;
+    readonly efRuntime?: number;
+    readonly epsilon?: number;
+    readonly hybridPolicy?: HybridPolicy;
+    readonly batchSize?: number;
+    readonly normalizeDistance: boolean;
+    readonly searchWindowSize?: number;
+    readonly useSearchHistory?: UseSearchHistory;
+    readonly searchBufferCapacity?: number;
+    constructor(config: VectorQueryConfig);
+    /**
+     * Build the Redis KNN query string
+     *
+     * Format: (filter)=>[KNN K @vector_field $vector AS score EF_RUNTIME $ef_runtime EPSILON $epsilon]
+     *
+     * @returns Redis FT.SEARCH query string
+     */
+    buildQuery(): string;
+    /**
+     * Build query parameters for Redis FT.SEARCH
+     *
+     * Converts the vector to a binary buffer as expected by Redis.
+     * Includes HNSW and SVS-VAMANA parameters if provided.
+     *
+     * @returns Query parameters object with vector buffer and algorithm params
+     */
+    buildParams(): Record<string, unknown>;
+}
+//# sourceMappingURL=vector.d.ts.map

package/dist/query/vector.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"vector.d.ts","sourceRoot":"","sources":["../../src/query/vector.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,WAAW,CAAC;AACtC,OAAO,EAAE,cAAc,EAAE,oBAAoB,EAAE,MAAM,oBAAoB,CAAC;AAI1E;;GAEG;AACH,MAAM,MAAM,YAAY,GAAG,SAAS,GAAG,UAAU,CAAC;AAElD;;GAEG;AACH,MAAM,MAAM,gBAAgB,GAAG,KAAK,GAAG,IAAI,GAAG,MAAM,CAAC;AAErD;;GAEG;AACH,MAAM,WAAW,iBAAiB;IAC9B,4BAA4B;IAC5B,MAAM,EAAE,MAAM,EAAE,CAAC;IAEjB,4CAA4C;IAC5C,WAAW,EAAE,MAAM,CAAC;IAEpB,kCAAkC;IAClC,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB,0DAA0D;IAC1D,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB,kCAAkC;IAClC,YAAY,CAAC,EAAE,MAAM,EAAE,CAAC;IAExB,6BAA6B;IAC7B,cAAc,CAAC,EAAE,oBAAoB,CAAC;IAEtC;;;;OAIG;IACH,QAAQ,CAAC,EAAE,cAAc,GAAG,MAAM,CAAC;IAEnC,wBAAwB;IACxB,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB,uBAAuB;IACvB,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;;OAGG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;;;OAIG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;;;OAIG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB;;;;;OAKG;IACH,YAAY,CAAC,EAAE,YAAY,CAAC;IAE5B;;;;;OAKG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;;;;;;;;;;;;;;;OAgBG;IACH,iBAAiB,CAAC,EAAE,OAAO,CAAC;IAE5B;;;;;;;;;OASG;IACH,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAE1B;;;;;;;;;;;;;;OAcG;IACH,gBAAgB,CAAC,EAAE,gBAAgB,CAAC;IAEpC;;;;;;;;;;;;OAYG;IACH,oBAAoB,CAAC,EAAE,MAAM,CAAC;CACjC;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAgCG;AACH,qBAAa,WAAY,YAAW,SAAS;IACzC,SAAgB,MAAM,EAAE,MAAM,EAAE,CAAC;IACjC,SAAgB,WAAW,EAAE,MAAM,CAAC;IACpC,SAAgB,UAAU,EAAE,MAAM,CAAC;IACnC,SAAgB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChC,SAAgB,YAAY,CAAC,EAAE,MAAM,EAAE,CAAC;IACxC,SAAgB,cAAc,EAAE,oBAAoB,CAAC;IACrD,SAAgB,QAAQ,EAAE,cAAc,CAAC;IACzC,SAAgB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChC,SAAgB,KAAK,CAAC,EAAE,MAAM,CAAC;IAC/B,SAAgB,UAAU,EAAE,MAAM,CAAC;IACnC,SAAgB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnC,SAAgB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjC,SAAgB,YAAY,CAAC,EAAE,YAAY,CAAC;IAC5C,SAAgB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnC,SAAgB,iBAAiB,EAAE,OAAO,CAAC;IAC3C,SAAgB,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1C,SAAgB,gBAAgB,CAAC,EAAE,gBAAgB,CAAC;IACpD,SAAgB,oBAAoB,CAAC,EAAE,MAAM,CAAC;gBAElC,MAAM,EAAE,iBAAiB;IAuFrC;;;;;;OAMG;IACH,UAAU,IAAI,MAAM;IAmCpB;;;;;;;OAOG;IACH,WAAW,IAAI,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC;CAyBzC"}

package/dist/query/vector.js

@@ -0,0 +1,198 @@
+import { VectorDistanceMetric } from '../schema/types.js';
+import { QueryValidationError, SchemaValidationError } from '../errors.js';
+import { encodeVectorBuffer, normalizeVectorDataType } from '../redis/utils.js';
+/**
+ * Vector similarity search query using KNN (K-Nearest Neighbors)
+ *
+ * Performs semantic search by finding documents with vectors similar to the query vector.
+ *
+ * @example
+ * ```typescript
+ * import { VectorQuery } from 'redis-vl';
+ *
+ * // Basic vector search
+ * const query = new VectorQuery({
+ *   vector: [0.1, 0.2, 0.3, ...],
+ *   vectorField: 'embedding',
+ *   numResults: 10
+ * });
+ *
+ * const results = await index.search(query);
+ * ```
+ *
+ * @example
+ * ```typescript
+ * // Vector search with metadata filtering
+ * const query = new VectorQuery({
+ *   vector: embedding,
+ *   vectorField: 'embedding',
+ *   filter: '@category:{electronics} @price:[0 1000]',
+ *   numResults: 5,
+ *   returnFields: ['title', 'price']
+ * });
+ *
+ * const results = await index.search(query);
+ * ```
+ */
+export class VectorQuery {
+    vector;
+    vectorField;
+    numResults;
+    filter;
+    returnFields;
+    distanceMetric;
+    datatype;
+    offset;
+    limit;
+    scoreAlias;
+    efRuntime;
+    epsilon;
+    hybridPolicy;
+    batchSize;
+    normalizeDistance;
+    searchWindowSize;
+    useSearchHistory;
+    searchBufferCapacity;
+    constructor(config) {
+        // Validate vector
+        if (!config.vector || config.vector.length === 0) {
+            throw new QueryValidationError('Vector cannot be empty');
+        }
+        // Validate vectorField
+        if (!config.vectorField) {
+            throw new QueryValidationError('vectorField is required');
+        }
+        // Validate HNSW parameters
+        if (config.efRuntime !== undefined && config.efRuntime <= 0) {
+            throw new QueryValidationError('efRuntime must be positive');
+        }
+        if (config.epsilon !== undefined && config.epsilon < 0) {
+            throw new QueryValidationError('epsilon must be non-negative');
+        }
+        // Validate hybrid policy parameters
+        if (config.hybridPolicy !== undefined) {
+            if (config.hybridPolicy !== 'BATCHES' && config.hybridPolicy !== 'ADHOC_BF') {
+                throw new QueryValidationError('hybridPolicy must be either BATCHES or ADHOC_BF');
+            }
+        }
+        if (config.batchSize !== undefined) {
+            if (config.hybridPolicy === undefined) {
+                throw new QueryValidationError('batchSize can only be used with hybridPolicy');
+            }
+            if (config.batchSize <= 0) {
+                throw new QueryValidationError('batchSize must be positive');
+            }
+        }
+        // Validate normalizeDistance with IP metric
+        if (config.normalizeDistance && config.distanceMetric === VectorDistanceMetric.IP) {
+            console.warn('Attempting to normalize inner product distance metric. ' +
+                'Use cosine distance instead which is normalized inner product by definition.');
+        }
+        // Validate SVS-VAMANA parameters
+        if (config.searchWindowSize !== undefined && config.searchWindowSize <= 0) {
+            throw new QueryValidationError('searchWindowSize must be positive');
+        }
+        if (config.useSearchHistory !== undefined) {
+            const validValues = ['OFF', 'ON', 'AUTO'];
+            if (!validValues.includes(config.useSearchHistory)) {
+                throw new QueryValidationError('useSearchHistory must be one of: OFF, ON, AUTO');
+            }
+        }
+        if (config.searchBufferCapacity !== undefined && config.searchBufferCapacity <= 0) {
+            throw new QueryValidationError('searchBufferCapacity must be positive');
+        }
+        this.vector = config.vector;
+        this.vectorField = config.vectorField;
+        this.numResults = config.numResults ?? 10;
+        this.filter = config.filter;
+        this.returnFields = config.returnFields;
+        this.distanceMetric = config.distanceMetric ?? VectorDistanceMetric.COSINE;
+        try {
+            this.datatype = normalizeVectorDataType(config.datatype);
+        }
+        catch (error) {
+            if (error instanceof SchemaValidationError) {
+                throw new QueryValidationError(error.message);
+            }
+            throw error;
+        }
+        this.offset = config.offset;
+        this.limit = config.limit;
+        this.scoreAlias = config.scoreAlias ?? 'vector_distance';
+        this.efRuntime = config.efRuntime;
+        this.epsilon = config.epsilon;
+        this.hybridPolicy = config.hybridPolicy;
+        this.batchSize = config.batchSize;
+        this.normalizeDistance = config.normalizeDistance ?? false;
+        this.searchWindowSize = config.searchWindowSize;
+        this.useSearchHistory = config.useSearchHistory;
+        this.searchBufferCapacity = config.searchBufferCapacity;
+    }
+    /**
+     * Build the Redis KNN query string
+     *
+     * Format: (filter)=>[KNN K @vector_field $vector AS score EF_RUNTIME $ef_runtime EPSILON $epsilon]
+     *
+     * @returns Redis FT.SEARCH query string
+     */
+    buildQuery() {
+        const filterPart = this.filter ? `(${this.filter})` : '*';
+        let knnPart = `=>[KNN ${this.numResults} @${this.vectorField} $vector AS ${this.scoreAlias}`;
+        // Add HNSW parameters if provided
+        if (this.efRuntime !== undefined) {
+            knnPart += ' EF_RUNTIME $ef_runtime';
+        }
+        if (this.epsilon !== undefined) {
+            knnPart += ' EPSILON $epsilon';
+        }
+        // Add hybrid policy parameters if provided
+        if (this.hybridPolicy !== undefined) {
+            knnPart += ` HYBRID_POLICY ${this.hybridPolicy}`;
+        }
+        if (this.batchSize !== undefined && this.hybridPolicy === 'BATCHES') {
+            knnPart += ` BATCH_SIZE ${this.batchSize}`;
+        }
+        // Add SVS-VAMANA parameters if provided
+        if (this.searchWindowSize !== undefined) {
+            knnPart += ' SEARCH_WINDOW_SIZE $search_window_size';
+        }
+        if (this.useSearchHistory !== undefined) {
+            knnPart += ` USE_SEARCH_HISTORY ${this.useSearchHistory}`;
+        }
+        if (this.searchBufferCapacity !== undefined) {
+            knnPart += ' SEARCH_BUFFER_CAPACITY $search_buffer_capacity';
+        }
+        knnPart += ']';
+        return `${filterPart}${knnPart}`;
+    }
+    /**
+     * Build query parameters for Redis FT.SEARCH
+     *
+     * Converts the vector to a binary buffer as expected by Redis.
+     * Includes HNSW and SVS-VAMANA parameters if provided.
+     *
+     * @returns Query parameters object with vector buffer and algorithm params
+     */
+    buildParams() {
+        const vectorBuffer = encodeVectorBuffer(this.vector, this.datatype);
+        const params = {
+            vector: vectorBuffer,
+        };
+        // Add HNSW parameters if provided
+        if (this.efRuntime !== undefined) {
+            params.ef_runtime = this.efRuntime;
+        }
+        if (this.epsilon !== undefined) {
+            params.epsilon = this.epsilon;
+        }
+        // Add SVS-VAMANA parameters if provided
+        if (this.searchWindowSize !== undefined) {
+            params.search_window_size = this.searchWindowSize;
+        }
+        if (this.searchBufferCapacity !== undefined) {
+            params.search_buffer_capacity = this.searchBufferCapacity;
+        }
+        return params;
+    }
+}
+//# sourceMappingURL=vector.js.map

package/dist/query/vector.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"vector.js","sourceRoot":"","sources":["../../src/query/vector.ts"],"names":[],"mappings":"AACA,OAAO,EAAkB,oBAAoB,EAAE,MAAM,oBAAoB,CAAC;AAC1E,OAAO,EAAE,oBAAoB,EAAE,qBAAqB,EAAE,MAAM,cAAc,CAAC;AAC3E,OAAO,EAAE,kBAAkB,EAAE,uBAAuB,EAAE,MAAM,mBAAmB,CAAC;AAmJhF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAgCG;AACH,MAAM,OAAO,WAAW;IACJ,MAAM,CAAW;IACjB,WAAW,CAAS;IACpB,UAAU,CAAS;IACnB,MAAM,CAAU;IAChB,YAAY,CAAY;IACxB,cAAc,CAAuB;IACrC,QAAQ,CAAiB;IACzB,MAAM,CAAU;IAChB,KAAK,CAAU;IACf,UAAU,CAAS;IACnB,SAAS,CAAU;IACnB,OAAO,CAAU;IACjB,YAAY,CAAgB;IAC5B,SAAS,CAAU;IACnB,iBAAiB,CAAU;IAC3B,gBAAgB,CAAU;IAC1B,gBAAgB,CAAoB;IACpC,oBAAoB,CAAU;IAE9C,YAAY,MAAyB;QACjC,kBAAkB;QAClB,IAAI,CAAC,MAAM,CAAC,MAAM,IAAI,MAAM,CAAC,MAAM,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YAC/C,MAAM,IAAI,oBAAoB,CAAC,wBAAwB,CAAC,CAAC;QAC7D,CAAC;QAED,uBAAuB;QACvB,IAAI,CAAC,MAAM,CAAC,WAAW,EAAE,CAAC;YACtB,MAAM,IAAI,oBAAoB,CAAC,yBAAyB,CAAC,CAAC;QAC9D,CAAC;QAED,2BAA2B;QAC3B,IAAI,MAAM,CAAC,SAAS,KAAK,SAAS,IAAI,MAAM,CAAC,SAAS,IAAI,CAAC,EAAE,CAAC;YAC1D,MAAM,IAAI,oBAAoB,CAAC,4BAA4B,CAAC,CAAC;QACjE,CAAC;QAED,IAAI,MAAM,CAAC,OAAO,KAAK,SAAS,IAAI,MAAM,CAAC,OAAO,GAAG,CAAC,EAAE,CAAC;YACrD,MAAM,IAAI,oBAAoB,CAAC,8BAA8B,CAAC,CAAC;QACnE,CAAC;QAED,oCAAoC;QACpC,IAAI,MAAM,CAAC,YAAY,KAAK,SAAS,EAAE,CAAC;YACpC,IAAI,MAAM,CAAC,YAAY,KAAK,SAAS,IAAI,MAAM,CAAC,YAAY,KAAK,UAAU,EAAE,CAAC;gBAC1E,MAAM,IAAI,oBAAoB,CAAC,iDAAiD,CAAC,CAAC;YACtF,CAAC;QACL,CAAC;QAED,IAAI,MAAM,CAAC,SAAS,KAAK,SAAS,EAAE,CAAC;YACjC,IAAI,MAAM,CAAC,YAAY,KAAK,SAAS,EAAE,CAAC;gBACpC,MAAM,IAAI,oBAAoB,CAAC,8CAA8C,CAAC,CAAC;YACnF,CAAC;YACD,IAAI,MAAM,CAAC,SAAS,IAAI,CAAC,EAAE,CAAC;gBACxB,MAAM,IAAI,oBAAoB,CAAC,4BAA4B,CAAC,CAAC;YACjE,CAAC;QACL,CAAC;QAED,4CAA4C;QAC5C,IAAI,MAAM,CAAC,iBAAiB,IAAI,MAAM,CAAC,cAAc,KAAK,oBAAoB,CAAC,EAAE,EAAE,CAAC;YAChF,OAAO,CAAC,IAAI,CACR,yDAAyD;gBACrD,8EAA8E,CACrF,CAAC;QACN,CAAC;QAED,iCAAiC;QACjC,IAAI,MAAM,CAAC,gBAAgB,KAAK,SAAS,IAAI,MAAM,CAAC,gBAAgB,IAAI,CAAC,EAAE,CAAC;YACxE,MAAM,IAAI,oBAAoB,CAAC,mCAAmC,CAAC,CAAC;QACxE,CAAC;QAED,IAAI,MAAM,CAAC,gBAAgB,KAAK,SAAS,EAAE,CAAC;YACxC,MAAM,WAAW,GAAuB,CAAC,KAAK,EAAE,IAAI,EAAE,MAAM,CAAC,CAAC;YAC9D,IAAI,CAAC,WAAW,CAAC,QAAQ,CAAC,MAAM,CAAC,gBAAgB,CAAC,EAAE,CAAC;gBACjD,MAAM,IAAI,oBAAoB,CAAC,gDAAgD,CAAC,CAAC;YACrF,CAAC;QACL,CAAC;QAED,IAAI,MAAM,CAAC,oBAAoB,KAAK,SAAS,IAAI,MAAM,CAAC,oBAAoB,IAAI,CAAC,EAAE,CAAC;YAChF,MAAM,IAAI,oBAAoB,CAAC,uCAAuC,CAAC,CAAC;QAC5E,CAAC;QAED,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC,MAAM,CAAC;QAC5B,IAAI,CAAC,WAAW,GAAG,MAAM,CAAC,WAAW,CAAC;QACtC,IAAI,CAAC,UAAU,GAAG,MAAM,CAAC,UAAU,IAAI,EAAE,CAAC;QAC1C,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC,MAAM,CAAC;QAC5B,IAAI,CAAC,YAAY,GAAG,MAAM,CAAC,YAAY,CAAC;QACxC,IAAI,CAAC,cAAc,GAAG,MAAM,CAAC,cAAc,IAAI,oBAAoB,CAAC,MAAM,CAAC;QAC3E,IAAI,CAAC;YACD,IAAI,CAAC,QAAQ,GAAG,uBAAuB,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;QAC7D,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACb,IAAI,KAAK,YAAY,qBAAqB,EAAE,CAAC;gBACzC,MAAM,IAAI,oBAAoB,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;YAClD,CAAC;YACD,MAAM,KAAK,CAAC;QAChB,CAAC;QACD,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC,MAAM,CAAC;QAC5B,IAAI,CAAC,KAAK,GAAG,MAAM,CAAC,KAAK,CAAC;QAC1B,IAAI,CAAC,UAAU,GAAG,MAAM,CAAC,UAAU,IAAI,iBAAiB,CAAC;QACzD,IAAI,CAAC,SAAS,GAAG,MAAM,CAAC,SAAS,CAAC;QAClC,IAAI,CAAC,OAAO,GAAG,MAAM,CAAC,OAAO,CAAC;QAC9B,IAAI,CAAC,YAAY,GAAG,MAAM,CAAC,YAAY,CAAC;QACxC,IAAI,CAAC,SAAS,GAAG,MAAM,CAAC,SAAS,CAAC;QAClC,IAAI,CAAC,iBAAiB,GAAG,MAAM,CAAC,iBAAiB,IAAI,KAAK,CAAC;QAC3D,IAAI,CAAC,gBAAgB,GAAG,MAAM,CAAC,gBAAgB,CAAC;QAChD,IAAI,CAAC,gBAAgB,GAAG,MAAM,CAAC,gBAAgB,CAAC;QAChD,IAAI,CAAC,oBAAoB,GAAG,MAAM,CAAC,oBAAoB,CAAC;IAC5D,CAAC;IAED;;;;;;OAMG;IACH,UAAU;QACN,MAAM,UAAU,GAAG,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,IAAI,IAAI,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,GAAG,CAAC;QAC1D,IAAI,OAAO,GAAG,UAAU,IAAI,CAAC,UAAU,KAAK,IAAI,CAAC,WAAW,eAAe,IAAI,CAAC,UAAU,EAAE,CAAC;QAE7F,kCAAkC;QAClC,IAAI,IAAI,CAAC,SAAS,KAAK,SAAS,EAAE,CAAC;YAC/B,OAAO,IAAI,yBAAyB,CAAC;QACzC,CAAC;QACD,IAAI,IAAI,CAAC,OAAO,KAAK,SAAS,EAAE,CAAC;YAC7B,OAAO,IAAI,mBAAmB,CAAC;QACnC,CAAC;QAED,2CAA2C;QAC3C,IAAI,IAAI,CAAC,YAAY,KAAK,SAAS,EAAE,CAAC;YAClC,OAAO,IAAI,kBAAkB,IAAI,CAAC,YAAY,EAAE,CAAC;QACrD,CAAC;QACD,IAAI,IAAI,CAAC,SAAS,KAAK,SAAS,IAAI,IAAI,CAAC,YAAY,KAAK,SAAS,EAAE,CAAC;YAClE,OAAO,IAAI,eAAe,IAAI,CAAC,SAAS,EAAE,CAAC;QAC/C,CAAC;QAED,wCAAwC;QACxC,IAAI,IAAI,CAAC,gBAAgB,KAAK,SAAS,EAAE,CAAC;YACtC,OAAO,IAAI,yCAAyC,CAAC;QACzD,CAAC;QACD,IAAI,IAAI,CAAC,gBAAgB,KAAK,SAAS,EAAE,CAAC;YACtC,OAAO,IAAI,uBAAuB,IAAI,CAAC,gBAAgB,EAAE,CAAC;QAC9D,CAAC;QACD,IAAI,IAAI,CAAC,oBAAoB,KAAK,SAAS,EAAE,CAAC;YAC1C,OAAO,IAAI,iDAAiD,CAAC;QACjE,CAAC;QAED,OAAO,IAAI,GAAG,CAAC;QACf,OAAO,GAAG,UAAU,GAAG,OAAO,EAAE,CAAC;IACrC,CAAC;IAED;;;;;;;OAOG;IACH,WAAW;QACP,MAAM,YAAY,GAAG,kBAAkB,CAAC,IAAI,CAAC,MAAM,EAAE,IAAI,CAAC,QAAQ,CAAC,CAAC;QAEpE,MAAM,MAAM,GAA4B;YACpC,MAAM,EAAE,YAAY;SACvB,CAAC;QAEF,kCAAkC;QAClC,IAAI,IAAI,CAAC,SAAS,KAAK,SAAS,EAAE,CAAC;YAC/B,MAAM,CAAC,UAAU,GAAG,IAAI,CAAC,SAAS,CAAC;QACvC,CAAC;QACD,IAAI,IAAI,CAAC,OAAO,KAAK,SAAS,EAAE,CAAC;YAC7B,MAAM,CAAC,OAAO,GAAG,IAAI,CAAC,OAAO,CAAC;QAClC,CAAC;QAED,wCAAwC;QACxC,IAAI,IAAI,CAAC,gBAAgB,KAAK,SAAS,EAAE,CAAC;YACtC,MAAM,CAAC,kBAAkB,GAAG,IAAI,CAAC,gBAAgB,CAAC;QACtD,CAAC;QACD,IAAI,IAAI,CAAC,oBAAoB,KAAK,SAAS,EAAE,CAAC;YAC1C,MAAM,CAAC,sBAAsB,GAAG,IAAI,CAAC,oBAAoB,CAAC;QAC9D,CAAC;QAED,OAAO,MAAM,CAAC;IAClB,CAAC;CACJ"}

package/dist/redis/index-info-parser.d.ts

@@ -0,0 +1,25 @@
+/**
+ * Parser for Redis FT.INFO output to reconstruct IndexSchema
+ */
+import { IndexSchema } from '../schema/index.js';
+import type { RedisClientType } from 'redis';
+export type RawInfoReply = Awaited<ReturnType<RedisClientType['ft']['info']>>;
+/**
+ * Input type for the index info parser.
+ *
+ * This is derived from the native Redis client `ft.info()` return type.
+ * We intentionally widen `index_definition` and `attributes` value types to
+ * reflect the runtime plain-object shape used by node-redis.
+ */
+export type RedisIndexInfoReply = Pick<RawInfoReply, 'index_name' | 'stopwords_list'> & {
+    index_definition: Record<string, unknown>;
+    attributes: Array<Record<string, unknown>>;
+};
+/**
+ * Build RedisVL IndexSchema from Redis FT.INFO output
+ *
+ * @param info - The raw output from FT.INFO command
+ * @returns IndexSchema instance reconstructed from Redis index metadata
+ */
+export declare function buildRedisVLSchemaFromRedisIndexInfo(info: RedisIndexInfoReply): IndexSchema;
+//# sourceMappingURL=index-info-parser.d.ts.map

package/dist/redis/index-info-parser.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index-info-parser.d.ts","sourceRoot":"","sources":["../../src/redis/index-info-parser.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,EAAE,WAAW,EAA0B,MAAM,oBAAoB,CAAC;AAiBzE,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,OAAO,CAAC;AAO7C,MAAM,MAAM,YAAY,GAAG,OAAO,CAAC,UAAU,CAAC,eAAe,CAAC,IAAI,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC;AAE9E;;;;;;GAMG;AACH,MAAM,MAAM,mBAAmB,GAAG,IAAI,CAAC,YAAY,EAAE,YAAY,GAAG,gBAAgB,CAAC,GAAG;IACpF,gBAAgB,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAC1C,UAAU,EAAE,KAAK,CAAC,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC,CAAC;CAC9C,CAAC;AAMF;;;;;GAKG;AACH,wBAAgB,oCAAoC,CAAC,IAAI,EAAE,mBAAmB,GAAG,WAAW,CAgC3F"}