Interface for the configuration of the RedisVectorStore. It includes the Redis client, index name, index options, key prefix, content key, metadata key, vector key, and filter.

interface RedisVectorStoreConfig {
    indexName: string;
    redisClient: RedisClientType<{} & RedisModules, RedisFunctions, RedisScripts> | RedisClusterType<{} & RedisModules, RedisFunctions, RedisScripts>;
    contentKey?: string;
    createIndexOptions?: Omit<RedisVectorStoreIndexOptions, "PREFIX">;
    filter?: RedisVectorStoreFilterType;
    indexOptions?: CreateSchemaFlatVectorField | CreateSchemaHNSWVectorField;
    keyPrefix?: string;
    metadataKey?: string;
    vectorKey?: string;
}

Properties

indexName: string
redisClient: RedisClientType<{} & RedisModules, RedisFunctions, RedisScripts> | RedisClusterType<{} & RedisModules, RedisFunctions, RedisScripts>
contentKey?: string
createIndexOptions?: Omit<RedisVectorStoreIndexOptions, "PREFIX">
keyPrefix?: string
metadataKey?: string
vectorKey?: string