Interface RedisVectorStoreConfig

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 redisClient contentKey? createIndexOptions? filter? indexOptions? keyPrefix? metadataKey? vectorKey?

Properties

indexName

indexName: string

redisClient

redisClient: RedisClientType<{} & RedisModules, RedisFunctions, RedisScripts> | RedisClusterType<{} & RedisModules, RedisFunctions, RedisScripts>

OptionalcontentKey

contentKey?: string

OptionalcreateIndexOptions

createIndexOptions?: Omit<RedisVectorStoreIndexOptions, "PREFIX">

Optionalfilter

filter?: RedisVectorStoreFilterType

OptionalindexOptions

indexOptions?: CreateSchemaFlatVectorField | CreateSchemaHNSWVectorField

OptionalkeyPrefix

keyPrefix?: string

OptionalmetadataKey

metadataKey?: string

OptionalvectorKey

vectorKey?: string

Settings

Member Visibility

On This Page

Properties