Interface RedisVectorStoreConfig

⚠️ Deprecated ⚠️

This feature is deprecated and will be removed in the future.

It is not recommended for use.

Install and import from the "@langchain/redis" integration package instead. 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>

Optional contentKey

contentKey?: string

Optional createIndexOptions

createIndexOptions?: Omit<RedisVectorStoreIndexOptions, "PREFIX">

Optional filter

filter?: RedisVectorStoreFilterType

Optional indexOptions

indexOptions?: CreateSchemaFlatVectorField | CreateSchemaHNSWVectorField

Optional keyPrefix

keyPrefix?: string

Optional metadataKey

metadataKey?: string

Optional vectorKey

vectorKey?: string

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc