langchain.js
    Preparing search index...

    Install and import from the "@langchain/redis" integration package instead. Class representing a RedisVectorStore. It extends the VectorStore class and includes methods for adding documents and vectors, performing similarity searches, managing the index, and more.

    Hierarchy (View Summary)

    Index

    Constructors

    Properties

    contentKey: string
    createIndexOptions: CreateOptions
    indexName: string
    keyPrefix: string
    metadataKey: string
    vectorKey: string

    Methods

    • Returns string

    • Method for adding documents to the RedisVectorStore. It first converts the documents to texts and then adds them as vectors.

      Parameters

      • documents: Document[]

        The documents to add.

      • Optionaloptions: RedisAddOptions

        Optional parameters for adding the documents.

      Returns Promise<void>

      A promise that resolves when the documents have been added.

    • Method for adding vectors to the RedisVectorStore. It checks if the index exists and creates it if it doesn't, then adds the vectors in batches.

      Parameters

      • vectors: number[][]

        The vectors to add.

      • documents: Document[]

        The documents associated with the vectors.

      • __namedParameters: RedisAddOptions = {}

      Returns Promise<void>

      A promise that resolves when the vectors have been added.

    • Method for checking if an index exists in the RedisVectorStore.

      Returns Promise<boolean>

      A promise that resolves to a boolean indicating whether the index exists.

    • Method for creating an index in the RedisVectorStore. If the index already exists, it does nothing.

      Parameters

      • dimensions: number = 1536

        The dimensions of the index

      Returns Promise<void>

      A promise that resolves when the index has been created.

    • Deletes vectors from the vector store.

      Parameters

      • params: { deleteAll: boolean }

        The parameters for deleting vectors.

      Returns Promise<void>

      A promise that resolves when the vectors have been deleted.

    • Method for dropping an index from the RedisVectorStore.

      Parameters

      • OptionaldeleteDocuments: boolean

        Optional boolean indicating whether to drop the associated documents.

      Returns Promise<boolean>

      A promise that resolves to a boolean indicating whether the index was dropped.

    • Method for performing a similarity search in the RedisVectorStore. It returns the documents and their scores.

      Parameters

      • query: number[]

        The query vector.

      • k: number

        The number of nearest neighbors to return.

      • Optionalfilter: RedisVectorStoreFilterType

        Optional filter to apply to the search.

      Returns Promise<[Document, number][]>

      A promise that resolves to an array of documents and their scores.

    • Static method for creating a new instance of RedisVectorStore from documents. It adds the documents to the RedisVectorStore.

      Parameters

      • docs: Document[]

        The documents to add.

      • embeddings: EmbeddingsInterface

        The embeddings to use.

      • dbConfig: RedisVectorStoreConfig

        The configuration for the RedisVectorStore.

      Returns Promise<RedisVectorStore>

      A promise that resolves to a new instance of RedisVectorStore.

    • Static method for creating a new instance of RedisVectorStore from texts. It creates documents from the texts and metadata, then adds them to the RedisVectorStore.

      Parameters

      • texts: string[]

        The texts to add.

      • metadatas: object | object[]

        The metadata associated with the texts.

      • embeddings: EmbeddingsInterface

        The embeddings to use.

      • dbConfig: RedisVectorStoreConfig

        The configuration for the RedisVectorStore.

      Returns Promise<RedisVectorStore>

      A promise that resolves to a new instance of RedisVectorStore.