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?: string;
    indexOptions?: CreateSchemaFlatVectorField | CreateSchemaHNSWVectorField;
    keyPrefix?: string;
    metadataSchema?: RediSearchSchema;
    vectorKey?: string;
}

Properties

indexName redisClient contentKey? createIndexOptions? filter? indexOptions? keyPrefix? metadataSchema? vectorKey?

Properties

indexName

indexName: string

redisClient

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

Optional contentKey

contentKey?: string

Optional createIndexOptions

createIndexOptions?: Omit<RedisVectorStoreIndexOptions, "PREFIX">

Optional filter

filter?: string

Optional indexOptions

indexOptions?: CreateSchemaFlatVectorField | CreateSchemaHNSWVectorField

Optional keyPrefix

keyPrefix?: string

Optional metadataSchema

metadataSchema?: RediSearchSchema

Optional vectorKey

vectorKey?: string

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc