Class RedisVectorStore

constructor

• new RedisVectorStore(embeddings, _dbConfig): RedisVectorStore

• Parameters

  • embeddings: EmbeddingsInterface

  • _dbConfig: RedisVectorStoreConfig

  Returns RedisVectorStore

FilterType

contentKey

createIndexOptions

indexName

indexOptions

keyPrefix

metadataKey

vectorKey

Optional filter

addDocuments

• addDocuments(documents, options?): Promise<void>

• 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.

  • Optional options: RedisAddOptions

    Optional parameters for adding the documents.

  Returns Promise<void>

  A promise that resolves when the documents have been added.

addVectors

• addVectors(vectors, documents, __namedParameters?): Promise<void>

• 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.

checkIndexExists

• checkIndexExists(): Promise<boolean>

• 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.

createIndex

• createIndex(dimensions?): Promise<void>

• 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.

delete

• delete(params): Promise<void>

• Deletes vectors from the vector store.

  Parameters

  • params: {
        deleteAll: boolean;
    }

    The parameters for deleting vectors.

    • deleteAll: boolean

  Returns Promise<void>

  A promise that resolves when the vectors have been deleted.

dropIndex

• dropIndex(deleteDocuments?): Promise<boolean>

• Method for dropping an index from the RedisVectorStore.

  Parameters

  • Optional deleteDocuments: 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.

similaritySearchVectorWithScore

• similaritySearchVectorWithScore(query, k, filter?): Promise<[Document, number][]>

• 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.

  • Optional filter: string | string[]

    Optional filter to apply to the search.

  Returns Promise<[Document, number][]>

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

Static fromDocuments

• fromDocuments(docs, embeddings, dbConfig, docsOptions?): Promise<RedisVectorStore>

• 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.

  • Optional docsOptions: RedisAddOptions

    The document options to use.

  Returns Promise<RedisVectorStore>

  A promise that resolves to a new instance of RedisVectorStore.

Static fromTexts

• fromTexts(texts, metadatas, embeddings, dbConfig, docsOptions?): Promise<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.

  • Optional docsOptions: RedisAddOptions

    The document options to use.

  Returns Promise<RedisVectorStore>

  A promise that resolves to a new instance of RedisVectorStore.