redis-vl 0.1.0-beta.0

package/dist/indexes/search-index.js

@@ -0,0 +1,475 @@
+/**
+ * @module Search Index
+ * Main search index class for managing Redis search indexes.
+ */
+import { IndexSchema } from '../schema/schema.js';
+import { buildRedisVLSchemaFromRedisIndexInfo } from '../redis/index-info-parser.js';
+import { HashStorage, JsonStorage } from '../storage/index.js';
+import { RedisVLError, SchemaValidationError } from '../errors.js';
+import { VectorQuery } from '../query/vector.js';
+import { DISTANCE_NORMALIZERS } from '../utils/distance.js';
+/**
+ * SearchIndex class for managing Redis vector search indices.
+ *
+ * This class provides methods to create, manage, and query Redis search indices.
+ * Users create their own Redis client and pass it to the constructor.
+ *
+ * @example
+ * ```typescript
+ * import { createClient } from 'redis';
+ * import { SearchIndex, IndexSchema, StorageType } from 'redis-vl';
+ *
+ * const client = createClient();
+ * await client.connect();
+ *
+ * const schema = new IndexSchema({
+ *   index: { name: 'my-index', prefix: 'doc', storageType: StorageType.HASH }
+ * });
+ * schema.addField({ name: 'title', type: 'text' });
+ *
+ * const searchIndex = new SearchIndex(schema, client);
+ * await searchIndex.create();
+ * ```
+ */
+export class SearchIndex {
+    /**
+     * The index schema defining the structure and fields.
+     */
+    schema;
+    /**
+     * The Redis client instance.
+     */
+    client;
+    /**
+     * Internal storage handler for data operations.
+     */
+    storage;
+    /**
+     * Whether to validate documents against schema when loading.
+     * Can be overridden per load() call.
+     */
+    validateOnLoad;
+    /**
+     * Create a new SearchIndex instance.
+     *
+     * @param schema - The index schema
+     * @param client - Redis client instance (created by user)
+     * @param validateOnLoad - Whether to validate documents on load (default: false)
+     * @throws {Error} If schema is not a valid IndexSchema instance
+     * @throws {Error} If client is not provided
+     */
+    constructor(schema, client, validateOnLoad = false) {
+        if (!(schema instanceof IndexSchema)) {
+            throw new RedisVLError('Must provide a valid IndexSchema object');
+        }
+        if (!client) {
+            throw new RedisVLError('Must provide a valid Redis client');
+        }
+        this.schema = schema;
+        this.client = client;
+        this.validateOnLoad = validateOnLoad;
+        // Initialize appropriate storage based on storage type
+        const isJson = this.schema.index.storageType.toLowerCase() === 'json';
+        this.storage = isJson ? new JsonStorage(schema) : new HashStorage(schema);
+    }
+    /**
+     * Load an existing index from Redis by name.
+     *
+     * This method fetches the index metadata using FT.INFO and reconstructs
+     * the IndexSchema from the stored information.
+     *
+     * @param name - Name of the existing index in Redis
+     * @param client - Redis client instance
+     * @param validateOnLoad - Whether to validate documents on load (default: false)
+     * @returns SearchIndex instance with reconstructed schema
+     * @throws {RedisVLError} If index doesn't exist or cannot be loaded
+     *
+     * @example
+     * ```typescript
+     * // Load an existing index
+     * const index = await SearchIndex.fromExisting('my-index', client);
+     *
+     * // Use the loaded index
+     * const docs = await index.fetchMany(['key1', 'key2']);
+     * ```
+     */
+    static async fromExisting(name, client, validateOnLoad = false) {
+        let info;
+        try {
+            // Fetch index info from Redis
+            info = await client.ft.info(name);
+        }
+        catch (error) {
+            const message = error instanceof Error ? error.message : String(error);
+            throw new RedisVLError(`Failed to load index '${name}' via FT.INFO: ${message}`, {
+                cause: error,
+            });
+        }
+        // Convert to IndexSchema
+        // The parser accepts the raw return type from client.ft.info()
+        const schema = buildRedisVLSchemaFromRedisIndexInfo(info);
+        // Create SearchIndex with reconstructed schema
+        return new SearchIndex(schema, client, validateOnLoad);
+    }
+    /**
+     * Get the index name from the schema.
+     */
+    get name() {
+        return this.schema.index.name;
+    }
+    /**
+     * Convert schema fields to Redis field schema format.
+     * Each field class knows how to convert itself via the toRedisField() method.
+     * @private
+     */
+    convertFieldsToRedisSchema() {
+        const redisSchema = {};
+        const isJson = this.schema.index.storageType.toLowerCase() === 'json';
+        for (const field of Object.values(this.schema.fields)) {
+            // Determine the field key for Redis schema
+            let key;
+            if (isJson) {
+                // For JSON storage, use the path (which should already have $. prefix)
+                key = field.path || field.name;
+                // Safety check: ensure path starts with $.
+                if (!key.startsWith('$.')) {
+                    key = `$.${key}`;
+                }
+            }
+            else {
+                // For HASH storage, use the field name directly
+                key = field.name;
+            }
+            // Converts each field to Redis format
+            redisSchema[key] = field.toRedisField(isJson);
+        }
+        return redisSchema;
+    }
+    getVectorScoreAlias(query) {
+        return query instanceof VectorQuery ? query.scoreAlias : null;
+    }
+    getVectorDistanceNormalizer(query) {
+        if (!(query instanceof VectorQuery) || !query.normalizeDistance) {
+            return null;
+        }
+        const vectorField = this.schema.fields[query.vectorField];
+        const metricFromSchema = vectorField?.type === 'vector'
+            ? vectorField.attrs.distanceMetric
+            : undefined;
+        const distanceMetric = (metricFromSchema ?? query.distanceMetric ?? 'COSINE').toUpperCase();
+        return DISTANCE_NORMALIZERS[distanceMetric] || null;
+    }
+    /**
+     * Create the index in Redis.
+     *
+     * @param options - Creation options
+     * @throws {Error} If no fields are defined for the index
+     * @returns The result from Redis FT.CREATE command
+     */
+    async create(options = {}) {
+        const { overwrite = false, drop = false } = options;
+        // Check that fields are defined
+        const fields = Object.values(this.schema.fields);
+        if (fields.length === 0) {
+            throw new SchemaValidationError('No fields defined for index');
+        }
+        // Check if index already exists
+        if (await this.exists()) {
+            if (!overwrite) {
+                // Index exists and we're not overwriting - do nothing
+                return;
+            }
+            // Delete existing index
+            await this.delete({ drop });
+        }
+        // Create the index using Redis FT.CREATE
+        const fieldSchema = this.convertFieldsToRedisSchema();
+        return this.client.ft.create(this.name, fieldSchema, {
+            ON: this.schema.index.storageType.toUpperCase(),
+            PREFIX: this.schema.index.prefix,
+        });
+    }
+    /**
+     * Check if the index exists in Redis.
+     *
+     * @returns True if the index exists, false otherwise
+     */
+    async exists() {
+        try {
+            // Try to get index info - if it exists, this will succeed
+            await this.client.ft.info(this.name);
+            return true;
+        }
+        catch {
+            // If index doesn't exist, FT.INFO will throw an error
+            return false;
+        }
+    }
+    /**
+     * Delete the index from Redis.
+     *
+     * @param options - Deletion options
+     * @returns The result from Redis FT.DROPINDEX command
+     */
+    async delete(options = {}) {
+        const { drop = false } = options;
+        if (drop) {
+            // Drop index and associated data
+            return this.client.ft.dropIndex(this.name, { DD: true });
+        }
+        else {
+            // Drop index only, keep data
+            return this.client.ft.dropIndex(this.name);
+        }
+    }
+    /**
+     * Get information about the index.
+     *
+     * @returns Index information from Redis
+     */
+    async info() {
+        return this.client.ft.info(this.name);
+    }
+    /**
+     * Load documents into the index.
+     *
+     * This method handles:
+     * - Auto-generating keys using ULID if no idField or keys provided
+     * - Extracting IDs from documents using idField
+     * - Using explicit keys if provided
+     * - Preprocessing documents before storage
+     * - Setting TTL on documents
+     * - Supporting both HASH and JSON storage types
+     * - Batching operations using Redis pipelining for performance
+     * - Optional schema validation
+     *
+     * @param data - Array of documents to load
+     * @param options - Load options
+     * @returns Array of keys that were loaded
+     * @throws {Error} If keys length doesn't match data length
+     * @throws {Error} If idField is not found in a document
+     * @throws {SchemaValidationError} If validation fails when validateOnLoad is enabled
+     * @throws {RedisVLError} If there's an error loading data to Redis
+     *
+     * @example
+     * ```typescript
+     * // Auto-generate keys
+     * const keys = await index.load([
+     *   { title: 'Doc 1', score: 100 },
+     *   { title: 'Doc 2', score: 200 }
+     * ]);
+     *
+     * // Use idField
+     * const keys = await index.load(
+     *   [{ id: 'user1', name: 'John' }],
+     *   { idField: 'id' }
+     * );
+     *
+     * // Use explicit keys
+     * const keys = await index.load(
+     *   [{ name: 'John' }],
+     *   { keys: ['user:1'] }
+     * );
+     *
+     * // With preprocessing, TTL, and validation
+     * const keys = await index.load(
+     *   [{ name: 'John' }],
+     *   {
+     *     ttl: 3600,
+     *     batchSize: 100,
+     *     validateOnLoad: true,
+     *     preprocess: (doc) => ({ ...doc, timestamp: Date.now() })
+     *   }
+     * );
+     * ```
+     */
+    async load(data, options = {}) {
+        // Use instance-level validateOnLoad setting if not overridden in options
+        const validateOnLoad = options.validateOnLoad ?? this.validateOnLoad;
+        try {
+            return await this.storage.write(this.client, data, { ...options, validateOnLoad });
+        }
+        catch (error) {
+            if (error instanceof SchemaValidationError) {
+                // Re-throw validation errors as-is with detailed information
+                throw error;
+            }
+            // Wrap other errors as general RedisVL errors
+            throw new RedisVLError(`Failed to load data: ${error instanceof Error ? error.message : String(error)}`, { cause: error instanceof Error ? error : undefined });
+        }
+    }
+    /**
+     * Fetch a single document by key.
+     *
+     * @param key - The document key (without prefix)
+     * @returns The document or null if not found
+     *
+     * @example
+     * ```typescript
+     * const doc = await index.fetch('123');
+     */
+    async fetch(key) {
+        try {
+            // Normalize prefix (use first prefix if array)
+            const prefix = Array.isArray(this.schema.index.prefix)
+                ? this.schema.index.prefix[0]
+                : this.schema.index.prefix;
+            // Build full key with prefix and separator
+            // Normalize prefix by removing trailing separator to avoid double separators (e.g. ::)
+            const normalizedPrefix = prefix.endsWith(this.schema.index.keySeparator)
+                ? prefix.slice(0, -this.schema.index.keySeparator.length)
+                : prefix;
+            const fullKey = normalizedPrefix
+                ? `${normalizedPrefix}${this.schema.index.keySeparator}${key}`
+                : key;
+            // Fetch using storage layer
+            const results = await this.storage.get(this.client, [fullKey]);
+            // Return first result (or null)
+            return results[0];
+        }
+        catch (error) {
+            throw new RedisVLError(`Failed to fetch document: ${error instanceof Error ? error.message : String(error)}`, { cause: error instanceof Error ? error : undefined });
+        }
+    }
+    /**
+     * Fetch multiple documents by keys.
+     * Uses pipelining for efficient batch retrieval.
+     *
+     * @param keys - Array of document keys (without prefix)
+     * @param batchSize - Number of commands per pipeline batch (default: 200)
+     * @returns Array of documents (null for missing keys)
+     *
+     * @example
+     * ```typescript
+     * const docs = await index.fetchMany(['123', '456', '789']);
+     */
+    async fetchMany(keys, batchSize = 200) {
+        try {
+            if (!keys || keys.length === 0) {
+                return [];
+            }
+            // Normalize prefix (use first prefix if array)
+            const prefix = Array.isArray(this.schema.index.prefix)
+                ? this.schema.index.prefix[0]
+                : this.schema.index.prefix;
+            // Build full keys with prefix and separator
+            // Normalize prefix by removing trailing separator to avoid double separators (e.g. ::)
+            const normalizedPrefix = prefix.endsWith(this.schema.index.keySeparator)
+                ? prefix.slice(0, -this.schema.index.keySeparator.length)
+                : prefix;
+            const fullKeys = normalizedPrefix
+                ? keys.map((key) => `${normalizedPrefix}${this.schema.index.keySeparator}${key}`)
+                : keys;
+            // Fetch using storage layer with pipelining
+            return await this.storage.get(this.client, fullKeys, batchSize);
+        }
+        catch (error) {
+            throw new RedisVLError(`Failed to fetch documents: ${error instanceof Error ? error.message : String(error)}`, { cause: error instanceof Error ? error : undefined });
+        }
+    }
+    /**
+     * Execute a search query against the index
+     *
+     * @param query - Query object (VectorQuery, FilterQuery, etc.)
+     * @param options - Optional query execution options
+     * @returns Search results with documents and scores
+     *
+     * @example
+     * ```typescript
+     * import { VectorQuery } from 'redis-vl';
+     *
+     * // Vector similarity search
+     * const query = new VectorQuery({
+     *   vector: embedding,
+     *   vectorField: 'embedding',
+     *   topK: 10,
+     *   returnFields: ['title', 'content']
+     * });
+     *
+     * const results = await index.search(query);
+     * console.log(`Found ${results.total} results`);
+     *
+     * results.documents.forEach((doc) => {
+     *   console.log(`${doc.value.title} (score: ${doc.score})`);
+     * });
+     * ```
+     *
+     * @example
+     * ```typescript
+     * // Vector search with metadata filtering
+     * const query = new VectorQuery({
+     *   vector: embedding,
+     *   vectorField: 'embedding',
+     *   filter: '@category:{electronics}',
+     *   topK: 5
+     * });
+     *
+     * const results = await index.search(query);
+     * ```
+     */
+    async search(query, options) {
+        try {
+            const queryString = query.buildQuery();
+            const params = query.buildParams();
+            const scoreAlias = this.getVectorScoreAlias(query);
+            const normalizer = this.getVectorDistanceNormalizer(query);
+            // Build FT.SEARCH options
+            const searchOptions = {
+                PARAMS: params,
+                DIALECT: options?.dialect ?? 2, // DIALECT 2 required for KNN
+            };
+            // Add RETURN fields if specified
+            // For VectorQuery, always include the score field (vector_distance by default)
+            if (query.returnFields && query.returnFields.length > 0) {
+                const returnFields = [...query.returnFields];
+                if (scoreAlias && !returnFields.includes(scoreAlias)) {
+                    returnFields.push(scoreAlias);
+                }
+                searchOptions.RETURN = returnFields;
+            }
+            // Add pagination
+            if (query.limit !== undefined || query.offset !== undefined) {
+                const offset = query.offset ?? 0;
+                const limit = query.limit ?? 10;
+                searchOptions.LIMIT = { from: offset, size: limit };
+            }
+            // Add sorting if specified
+            if (options?.sortBy) {
+                searchOptions.SORTBY = options.sortBy;
+                if (options.sortOrder) {
+                    searchOptions.SORTBY = {
+                        BY: options.sortBy,
+                        DIRECTION: options.sortOrder,
+                    };
+                }
+            }
+            // Execute search
+            const response = await this.client.ft.search(this.schema.index.name, queryString, searchOptions);
+            // Transform response to SearchResult format
+            const documents = response.documents.map((doc) => {
+                const value = doc.value;
+                const scoreValue = scoreAlias ? value[scoreAlias] : undefined;
+                let score = typeof scoreValue === 'string'
+                    ? parseFloat(scoreValue)
+                    : scoreValue;
+                // Apply normalization if needed
+                if (score !== undefined && normalizer) {
+                    score = normalizer(score);
+                }
+                return {
+                    id: doc.id,
+                    value: value,
+                    score,
+                };
+            });
+            return {
+                total: response.total,
+                documents,
+            };
+        }
+        catch (error) {
+            throw new RedisVLError(`Failed to execute search query: ${error instanceof Error ? error.message : String(error)}`, { cause: error instanceof Error ? error : undefined });
+        }
+    }
+}
+//# sourceMappingURL=search-index.js.map

package/dist/indexes/search-index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"search-index.js","sourceRoot":"","sources":["../../src/indexes/search-index.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAIH,OAAO,EAAE,WAAW,EAAE,MAAM,qBAAqB,CAAC;AAClD,OAAO,EAAE,oCAAoC,EAAE,MAAM,+BAA+B,CAAC;AACrF,OAAO,EAAe,WAAW,EAAE,WAAW,EAAE,MAAM,qBAAqB,CAAC;AAC5E,OAAO,EAAE,YAAY,EAAE,qBAAqB,EAAE,MAAM,cAAc,CAAC;AAEnE,OAAO,EAAE,WAAW,EAAE,MAAM,oBAAoB,CAAC;AACjD,OAAO,EAAE,oBAAoB,EAAE,MAAM,sBAAsB,CAAC;AA0F5D;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH,MAAM,OAAO,WAAW;IACpB;;OAEG;IACa,MAAM,CAAc;IAEpC;;OAEG;IACc,MAAM,CAAqC;IAE5D;;OAEG;IACc,OAAO,CAAc;IAEtC;;;OAGG;IACc,cAAc,CAAU;IAEzC;;;;;;;;OAQG;IACH,YACI,MAAmB,EACnB,MAA0C,EAC1C,cAAc,GAAG,KAAK;QAEtB,IAAI,CAAC,CAAC,MAAM,YAAY,WAAW,CAAC,EAAE,CAAC;YACnC,MAAM,IAAI,YAAY,CAAC,yCAAyC,CAAC,CAAC;QACtE,CAAC;QAED,IAAI,CAAC,MAAM,EAAE,CAAC;YACV,MAAM,IAAI,YAAY,CAAC,mCAAmC,CAAC,CAAC;QAChE,CAAC;QAED,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;QACrB,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;QACrB,IAAI,CAAC,cAAc,GAAG,cAAc,CAAC;QAErC,uDAAuD;QACvD,MAAM,MAAM,GAAG,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,WAAW,CAAC,WAAW,EAAE,KAAK,MAAM,CAAC;QACtE,IAAI,CAAC,OAAO,GAAG,MAAM,CAAC,CAAC,CAAC,IAAI,WAAW,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,IAAI,WAAW,CAAC,MAAM,CAAC,CAAC;IAC9E,CAAC;IAED;;;;;;;;;;;;;;;;;;;;OAoBG;IACH,MAAM,CAAC,KAAK,CAAC,YAAY,CACrB,IAAY,EACZ,MAA0C,EAC1C,cAAc,GAAG,KAAK;QAEtB,IAAI,IAA6E,CAAC;QAClF,IAAI,CAAC;YACD,8BAA8B;YAC9B,IAAI,GAAG,MAAM,MAAM,CAAC,EAAE,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QACtC,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACb,MAAM,OAAO,GAAG,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;YACvE,MAAM,IAAI,YAAY,CAAC,yBAAyB,IAAI,kBAAkB,OAAO,EAAE,EAAE;gBAC7E,KAAK,EAAE,KAAK;aACf,CAAC,CAAC;QACP,CAAC;QAED,yBAAyB;QACzB,+DAA+D;QAC/D,MAAM,MAAM,GAAG,oCAAoC,CAAC,IAAI,CAAC,CAAC;QAE1D,+CAA+C;QAC/C,OAAO,IAAI,WAAW,CAAC,MAAM,EAAE,MAAM,EAAE,cAAc,CAAC,CAAC;IAC3D,CAAC;IAED;;OAEG;IACH,IAAI,IAAI;QACJ,OAAO,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC;IAClC,CAAC;IAED;;;;OAIG;IACK,0BAA0B;QAC9B,MAAM,WAAW,GAAqB,EAAE,CAAC;QACzC,MAAM,MAAM,GAAG,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,WAAW,CAAC,WAAW,EAAE,KAAK,MAAM,CAAC;QAEtE,KAAK,MAAM,KAAK,IAAI,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,EAAE,CAAC;YACpD,2CAA2C;YAC3C,IAAI,GAAW,CAAC;YAChB,IAAI,MAAM,EAAE,CAAC;gBACT,uEAAuE;gBACvE,GAAG,GAAG,KAAK,CAAC,IAAI,IAAI,KAAK,CAAC,IAAI,CAAC;gBAC/B,2CAA2C;gBAC3C,IAAI,CAAC,GAAG,CAAC,UAAU,CAAC,IAAI,CAAC,EAAE,CAAC;oBACxB,GAAG,GAAG,KAAK,GAAG,EAAE,CAAC;gBACrB,CAAC;YACL,CAAC;iBAAM,CAAC;gBACJ,gDAAgD;gBAChD,GAAG,GAAG,KAAK,CAAC,IAAI,CAAC;YACrB,CAAC;YAED,sCAAsC;YACtC,WAAW,CAAC,GAAG,CAAC,GAAG,KAAK,CAAC,YAAY,CAAC,MAAM,CAAC,CAAC;QAClD,CAAC;QAED,OAAO,WAAW,CAAC;IACvB,CAAC;IAEO,mBAAmB,CAAC,KAAgB;QACxC,OAAO,KAAK,YAAY,WAAW,CAAC,CAAC,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC,CAAC,IAAI,CAAC;IAClE,CAAC;IAEO,2BAA2B,CAAC,KAAgB;QAChD,IAAI,CAAC,CAAC,KAAK,YAAY,WAAW,CAAC,IAAI,CAAC,KAAK,CAAC,iBAAiB,EAAE,CAAC;YAC9D,OAAO,IAAI,CAAC;QAChB,CAAC;QAED,MAAM,WAAW,GAAG,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,WAAW,CAAC,CAAC;QAC1D,MAAM,gBAAgB,GAClB,WAAW,EAAE,IAAI,KAAK,QAAQ;YAC1B,CAAC,CAAE,WAAW,CAAC,KAA0B,CAAC,cAAc;YACxD,CAAC,CAAC,SAAS,CAAC;QACpB,MAAM,cAAc,GAAG,CAAC,gBAAgB,IAAI,KAAK,CAAC,cAAc,IAAI,QAAQ,CAAC,CAAC,WAAW,EAAE,CAAC;QAE5F,OAAO,oBAAoB,CAAC,cAAc,CAAC,IAAI,IAAI,CAAC;IACxD,CAAC;IAED;;;;;;OAMG;IACH,KAAK,CAAC,MAAM,CAAC,UAA8B,EAAE;QACzC,MAAM,EAAE,SAAS,GAAG,KAAK,EAAE,IAAI,GAAG,KAAK,EAAE,GAAG,OAAO,CAAC;QAEpD,gCAAgC;QAChC,MAAM,MAAM,GAAG,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;QACjD,IAAI,MAAM,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YACtB,MAAM,IAAI,qBAAqB,CAAC,6BAA6B,CAAC,CAAC;QACnE,CAAC;QAED,gCAAgC;QAChC,IAAI,MAAM,IAAI,CAAC,MAAM,EAAE,EAAE,CAAC;YACtB,IAAI,CAAC,SAAS,EAAE,CAAC;gBACb,sDAAsD;gBACtD,OAAO;YACX,CAAC;YACD,wBAAwB;YACxB,MAAM,IAAI,CAAC,MAAM,CAAC,EAAE,IAAI,EAAE,CAAC,CAAC;QAChC,CAAC;QAED,yCAAyC;QACzC,MAAM,WAAW,GAAG,IAAI,CAAC,0BAA0B,EAAE,CAAC;QAEtD,OAAO,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,EAAE,WAAW,EAAE;YACjD,EAAE,EAAE,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,WAAW,CAAC,WAAW,EAAqB;YAClE,MAAM,EAAE,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,MAAM;SACnC,CAAC,CAAC;IACP,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,MAAM;QACR,IAAI,CAAC;YACD,0DAA0D;YAC1D,MAAM,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;YACrC,OAAO,IAAI,CAAC;QAChB,CAAC;QAAC,MAAM,CAAC;YACL,sDAAsD;YACtD,OAAO,KAAK,CAAC;QACjB,CAAC;IACL,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,MAAM,CAAC,UAA8B,EAAE;QACzC,MAAM,EAAE,IAAI,GAAG,KAAK,EAAE,GAAG,OAAO,CAAC;QAEjC,IAAI,IAAI,EAAE,CAAC;YACP,iCAAiC;YACjC,OAAO,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC,SAAS,CAAC,IAAI,CAAC,IAAI,EAAE,EAAE,EAAE,EAAE,IAAI,EAAE,CAAC,CAAC;QAC7D,CAAC;aAAM,CAAC;YACJ,6BAA6B;YAC7B,OAAO,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QAC/C,CAAC;IACL,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,IAAI;QACN,OAAO,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IAC1C,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAoDG;IACH,KAAK,CAAC,IAAI,CAAC,IAA+B,EAAE,UAAuB,EAAE;QACjE,yEAAyE;QACzE,MAAM,cAAc,GAAG,OAAO,CAAC,cAAc,IAAI,IAAI,CAAC,cAAc,CAAC;QAErE,IAAI,CAAC;YACD,OAAO,MAAM,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,IAAI,CAAC,MAAM,EAAE,IAAI,EAAE,EAAE,GAAG,OAAO,EAAE,cAAc,EAAE,CAAC,CAAC;QACvF,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACb,IAAI,KAAK,YAAY,qBAAqB,EAAE,CAAC;gBACzC,6DAA6D;gBAC7D,MAAM,KAAK,CAAC;YAChB,CAAC;YACD,8CAA8C;YAC9C,MAAM,IAAI,YAAY,CAClB,wBAAwB,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,EAAE,EAChF,EAAE,KAAK,EAAE,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,SAAS,EAAE,CACxD,CAAC;QACN,CAAC;IACL,CAAC;IAED;;;;;;;;;OASG;IACH,KAAK,CAAC,KAAK,CAAC,GAAW;QACnB,IAAI,CAAC;YACD,+CAA+C;YAC/C,MAAM,MAAM,GAAG,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC;gBAClD,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC;gBAC7B,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC;YAE/B,2CAA2C;YAC3C,uFAAuF;YACvF,MAAM,gBAAgB,GAAG,MAAM,CAAC,QAAQ,CAAC,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,YAAY,CAAC;gBACpE,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,YAAY,CAAC,MAAM,CAAC;gBACzD,CAAC,CAAC,MAAM,CAAC;YACb,MAAM,OAAO,GAAG,gBAAgB;gBAC5B,CAAC,CAAC,GAAG,gBAAgB,GAAG,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,YAAY,GAAG,GAAG,EAAE;gBAC9D,CAAC,CAAC,GAAG,CAAC;YAEV,4BAA4B;YAC5B,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,MAAM,EAAE,CAAC,OAAO,CAAC,CAAC,CAAC;YAE/D,gCAAgC;YAChC,OAAO,OAAO,CAAC,CAAC,CAAC,CAAC;QACtB,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACb,MAAM,IAAI,YAAY,CAClB,6BAA6B,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,EAAE,EACrF,EAAE,KAAK,EAAE,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,SAAS,EAAE,CACxD,CAAC;QACN,CAAC;IACL,CAAC;IAED;;;;;;;;;;;OAWG;IACH,KAAK,CAAC,SAAS,CAAC,IAAc,EAAE,SAAS,GAAG,GAAG;QAC3C,IAAI,CAAC;YACD,IAAI,CAAC,IAAI,IAAI,IAAI,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;gBAC7B,OAAO,EAAE,CAAC;YACd,CAAC;YAED,+CAA+C;YAC/C,MAAM,MAAM,GAAG,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC;gBAClD,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC;gBAC7B,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC;YAE/B,4CAA4C;YAC5C,uFAAuF;YACvF,MAAM,gBAAgB,GAAG,MAAM,CAAC,QAAQ,CAAC,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,YAAY,CAAC;gBACpE,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,YAAY,CAAC,MAAM,CAAC;gBACzD,CAAC,CAAC,MAAM,CAAC;YACb,MAAM,QAAQ,GAAG,gBAAgB;gBAC7B,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,gBAAgB,GAAG,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,YAAY,GAAG,GAAG,EAAE,CAAC;gBACjF,CAAC,CAAC,IAAI,CAAC;YAEX,4CAA4C;YAC5C,OAAO,MAAM,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,MAAM,EAAE,QAAQ,EAAE,SAAS,CAAC,CAAC;QACpE,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACb,MAAM,IAAI,YAAY,CAClB,8BAA8B,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,EAAE,EACtF,EAAE,KAAK,EAAE,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,SAAS,EAAE,CACxD,CAAC;QACN,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAuCG;IACH,KAAK,CAAC,MAAM,CACR,KAAgB,EAChB,OAAsB;QAEtB,IAAI,CAAC;YACD,MAAM,WAAW,GAAG,KAAK,CAAC,UAAU,EAAE,CAAC;YACvC,MAAM,MAAM,GAAG,KAAK,CAAC,WAAW,EAAE,CAAC;YACnC,MAAM,UAAU,GAAG,IAAI,CAAC,mBAAmB,CAAC,KAAK,CAAC,CAAC;YACnD,MAAM,UAAU,GAAG,IAAI,CAAC,2BAA2B,CAAC,KAAK,CAAC,CAAC;YAE3D,0BAA0B;YAC1B,MAAM,aAAa,GAA4B;gBAC3C,MAAM,EAAE,MAAM;gBACd,OAAO,EAAE,OAAO,EAAE,OAAO,IAAI,CAAC,EAAE,6BAA6B;aAChE,CAAC;YAEF,iCAAiC;YACjC,+EAA+E;YAC/E,IAAI,KAAK,CAAC,YAAY,IAAI,KAAK,CAAC,YAAY,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;gBACtD,MAAM,YAAY,GAAG,CAAC,GAAG,KAAK,CAAC,YAAY,CAAC,CAAC;gBAC7C,IAAI,UAAU,IAAI,CAAC,YAAY,CAAC,QAAQ,CAAC,UAAU,CAAC,EAAE,CAAC;oBACnD,YAAY,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;gBAClC,CAAC;gBACD,aAAa,CAAC,MAAM,GAAG,YAAY,CAAC;YACxC,CAAC;YAED,iBAAiB;YACjB,IAAI,KAAK,CAAC,KAAK,KAAK,SAAS,IAAI,KAAK,CAAC,MAAM,KAAK,SAAS,EAAE,CAAC;gBAC1D,MAAM,MAAM,GAAG,KAAK,CAAC,MAAM,IAAI,CAAC,CAAC;gBACjC,MAAM,KAAK,GAAG,KAAK,CAAC,KAAK,IAAI,EAAE,CAAC;gBAChC,aAAa,CAAC,KAAK,GAAG,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,KAAK,EAAE,CAAC;YACxD,CAAC;YAED,2BAA2B;YAC3B,IAAI,OAAO,EAAE,MAAM,EAAE,CAAC;gBAClB,aAAa,CAAC,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;gBACtC,IAAI,OAAO,CAAC,SAAS,EAAE,CAAC;oBACpB,aAAa,CAAC,MAAM,GAAG;wBACnB,EAAE,EAAE,OAAO,CAAC,MAAM;wBAClB,SAAS,EAAE,OAAO,CAAC,SAAS;qBAC/B,CAAC;gBACN,CAAC;YACL,CAAC;YAED,iBAAiB;YACjB,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC,MAAM,CACxC,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,IAAI,EACtB,WAAW,EACX,aAAa,CAChB,CAAC;YAEF,4CAA4C;YAC5C,MAAM,SAAS,GAAwB,QAAQ,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE;gBAClE,MAAM,KAAK,GAAG,GAAG,CAAC,KAAgC,CAAC;gBACnD,MAAM,UAAU,GAAG,UAAU,CAAC,CAAC,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;gBAC9D,IAAI,KAAK,GACL,OAAO,UAAU,KAAK,QAAQ;oBAC1B,CAAC,CAAC,UAAU,CAAC,UAAU,CAAC;oBACxB,CAAC,CAAE,UAAiC,CAAC;gBAE7C,gCAAgC;gBAChC,IAAI,KAAK,KAAK,SAAS,IAAI,UAAU,EAAE,CAAC;oBACpC,KAAK,GAAG,UAAU,CAAC,KAAK,CAAC,CAAC;gBAC9B,CAAC;gBAED,OAAO;oBACH,EAAE,EAAE,GAAG,CAAC,EAAE;oBACV,KAAK,EAAE,KAAU;oBACjB,KAAK;iBACR,CAAC;YACN,CAAC,CAAC,CAAC;YAEH,OAAO;gBACH,KAAK,EAAE,QAAQ,CAAC,KAAK;gBACrB,SAAS;aACZ,CAAC;QACN,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACb,MAAM,IAAI,YAAY,CAClB,mCAAmC,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,EAAE,EAC3F,EAAE,KAAK,EAAE,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,SAAS,EAAE,CACxD,CAAC;QACN,CAAC;IACL,CAAC;CACJ"}

package/dist/query/base.d.ts

@@ -0,0 +1,51 @@
+/**
+ * @module Query
+ * Query builders for Redis search operations.
+ */
+/**
+ * Base interface for all query types
+ */
+export interface BaseQuery {
+    /** Fields to return in results */
+    returnFields?: string[];
+    /** Number of results to return */
+    limit?: number;
+    /** Offset for pagination */
+    offset?: number;
+    /** Build the Redis query string */
+    buildQuery(): string;
+    /** Build the query parameters for Redis */
+    buildParams(): Record<string, unknown>;
+}
+/**
+ * Search result document with optional score
+ */
+export interface SearchDocument<T = Record<string, unknown>> {
+    /** Document fields */
+    value: T;
+    /** Relevance score (for vector search) */
+    score?: number;
+    /** Document ID */
+    id: string;
+}
+/**
+ * Search result structure
+ */
+export interface SearchResult<T = Record<string, unknown>> {
+    /** Total number of results */
+    total: number;
+    /** Retrieved documents */
+    documents: SearchDocument<T>[];
+}
+/**
+ * Options for query execution
+ */
+export interface QueryOptions {
+    /** Redis DIALECT version (default: 2 for KNN) */
+    dialect?: number;
+    /** Sort by field */
+    sortBy?: string;
+    /** Sort order */
+    sortOrder?: 'ASC' | 'DESC';
+}
+//# sourceMappingURL=base.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"base.d.ts","sourceRoot":"","sources":["../../src/query/base.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH;;GAEG;AACH,MAAM,WAAW,SAAS;IACtB,kCAAkC;IAClC,YAAY,CAAC,EAAE,MAAM,EAAE,CAAC;IAExB,kCAAkC;IAClC,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf,4BAA4B;IAC5B,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB,mCAAmC;IACnC,UAAU,IAAI,MAAM,CAAC;IAErB,2CAA2C;IAC3C,WAAW,IAAI,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;CAC1C;AAED;;GAEG;AACH,MAAM,WAAW,cAAc,CAAC,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC;IACvD,sBAAsB;IACtB,KAAK,EAAE,CAAC,CAAC;IAET,0CAA0C;IAC1C,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf,kBAAkB;IAClB,EAAE,EAAE,MAAM,CAAC;CACd;AAED;;GAEG;AACH,MAAM,WAAW,YAAY,CAAC,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC;IACrD,8BAA8B;IAC9B,KAAK,EAAE,MAAM,CAAC;IAEd,0BAA0B;IAC1B,SAAS,EAAE,cAAc,CAAC,CAAC,CAAC,EAAE,CAAC;CAClC;AAED;;GAEG;AACH,MAAM,WAAW,YAAY;IACzB,iDAAiD;IACjD,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB,oBAAoB;IACpB,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB,iBAAiB;IACjB,SAAS,CAAC,EAAE,KAAK,GAAG,MAAM,CAAC;CAC9B"}

package/dist/query/base.js

@@ -0,0 +1,6 @@
+/**
+ * @module Query
+ * Query builders for Redis search operations.
+ */
+export {};
+//# sourceMappingURL=base.js.map

package/dist/query/base.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"base.js","sourceRoot":"","sources":["../../src/query/base.ts"],"names":[],"mappings":"AAAA;;;GAGG"}

package/dist/query/index.d.ts

@@ -0,0 +1,7 @@
+/**
+ * @module Query
+ * Query builders for Redis search operations.
+ */
+export * from './base.js';
+export * from './vector.js';
+//# sourceMappingURL=index.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/query/index.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,cAAc,WAAW,CAAC;AAC1B,cAAc,aAAa,CAAC"}

package/dist/query/index.js

@@ -0,0 +1,7 @@
+/**
+ * @module Query
+ * Query builders for Redis search operations.
+ */
+export * from './base.js';
+export * from './vector.js';
+//# sourceMappingURL=index.js.map

package/dist/query/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/query/index.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,cAAc,WAAW,CAAC;AAC1B,cAAc,aAAa,CAAC"}