!function(){function t(t){document.documentElement.setAttribute("data-theme",t)}var e=function(){var t=null;try{t=new URLSearchParams(window.location.search).get("docusaurus-theme")}catch(t){}return t}()||function(){var t=null;try{t=localStorage.getItem("theme")}catch(t){}return t}();t(null!==e?e:"light")}(),document.documentElement.setAttribute("data-announcement-bar-initially-dismissed",function(){try{return"true"===localStorage.getItem("docusaurus.announcement.dismiss")}catch(t){}return!1}())

[Skip to main content](#__docusaurus_skipToContent_fallback)

You are viewing the **preview** v0.2 docs. View the **stable** v0.1 docs [here](/v0.1/docs/get_started/introduction/). Leave feedback on the v0.2 docs [here](https://github.com/langchain-ai/langchainjs/discussions/5386).

[

![🦜️🔗 Langchain](/v0.2/img/brand/wordmark.png)![🦜️🔗 Langchain](/v0.2/img/brand/wordmark-dark.png)

](/v0.2/)[Integrations](/v0.2/docs/integrations/platforms/)[API Reference](https://v02.api.js.langchain.com)

[More](#)

*   [People](/v0.2/docs/people/)
*   [Community](/v0.2/docs/community)
*   [Tutorials](/v0.2/docs/additional_resources/tutorials)
*   [Contributing](/v0.2/docs/contributing)

[v0.2](#)

*   [v0.2](/v0.2/docs/introduction)
*   [v0.1](https://js.langchain.com/v0.1/docs/get_started/introduction)

[🦜🔗](#)

*   [LangSmith](https://smith.langchain.com)
*   [LangSmith Docs](https://docs.smith.langchain.com)
*   [LangChain Hub](https://smith.langchain.com/hub)
*   [LangServe](https://github.com/langchain-ai/langserve)
*   [Python Docs](https://python.langchain.com/)

[Chat](https://chatjs.langchain.com)[](https://github.com/langchain-ai/langchainjs)

Search

*   [Providers](/v0.2/docs/integrations/platforms/)
    
    *   [Providers](/v0.2/docs/integrations/platforms/)
    *   [Anthropic](/v0.2/docs/integrations/platforms/anthropic)
    *   [AWS](/v0.2/docs/integrations/platforms/aws)
    *   [Google](/v0.2/docs/integrations/platforms/google)
    *   [Microsoft](/v0.2/docs/integrations/platforms/microsoft)
    *   [OpenAI](/v0.2/docs/integrations/platforms/openai)
*   [Components](/v0.2/docs/integrations/components)
    
    *   [Chat models](/v0.2/docs/integrations/chat/)
        
    *   [LLMs](/v0.2/docs/integrations/llms/)
        
    *   [Embedding models](/v0.2/docs/integrations/text_embedding)
        
    *   [Document loaders](/v0.2/docs/integrations/document_loaders)
        
    *   [Document transformers](/v0.2/docs/integrations/document_transformers)
        
    *   [Vector stores](/v0.2/docs/integrations/vectorstores)
        
        *   [Memory](/v0.2/docs/integrations/vectorstores/memory)
        *   [AnalyticDB](/v0.2/docs/integrations/vectorstores/analyticdb)
        *   [Astra DB](/v0.2/docs/integrations/vectorstores/astradb)
        *   [Azure AI Search](/v0.2/docs/integrations/vectorstores/azure_aisearch)
        *   [Azure Cosmos DB](/v0.2/docs/integrations/vectorstores/azure_cosmosdb)
        *   [Cassandra](/v0.2/docs/integrations/vectorstores/cassandra)
        *   [Chroma](/v0.2/docs/integrations/vectorstores/chroma)
        *   [ClickHouse](/v0.2/docs/integrations/vectorstores/clickhouse)
        *   [CloseVector](/v0.2/docs/integrations/vectorstores/closevector)
        *   [Cloudflare Vectorize](/v0.2/docs/integrations/vectorstores/cloudflare_vectorize)
        *   [Convex](/v0.2/docs/integrations/vectorstores/convex)
        *   [Couchbase](/v0.2/docs/integrations/vectorstores/couchbase)
        *   [Elasticsearch](/v0.2/docs/integrations/vectorstores/elasticsearch)
        *   [Faiss](/v0.2/docs/integrations/vectorstores/faiss)
        *   [Google Vertex AI Matching Engine](/v0.2/docs/integrations/vectorstores/googlevertexai)
        *   [SAP HANA Cloud Vector Engine](/v0.2/docs/integrations/vectorstores/hanavector)
        *   [HNSWLib](/v0.2/docs/integrations/vectorstores/hnswlib)
        *   [LanceDB](/v0.2/docs/integrations/vectorstores/lancedb)
        *   [Milvus](/v0.2/docs/integrations/vectorstores/milvus)
        *   [Momento Vector Index (MVI)](/v0.2/docs/integrations/vectorstores/momento_vector_index)
        *   [MongoDB Atlas](/v0.2/docs/integrations/vectorstores/mongodb_atlas)
        *   [MyScale](/v0.2/docs/integrations/vectorstores/myscale)
        *   [Neo4j Vector Index](/v0.2/docs/integrations/vectorstores/neo4jvector)
        *   [Neon Postgres](/v0.2/docs/integrations/vectorstores/neon)
        *   [OpenSearch](/v0.2/docs/integrations/vectorstores/opensearch)
        *   [PGVector](/v0.2/docs/integrations/vectorstores/pgvector)
        *   [Pinecone](/v0.2/docs/integrations/vectorstores/pinecone)
        *   [Prisma](/v0.2/docs/integrations/vectorstores/prisma)
        *   [Qdrant](/v0.2/docs/integrations/vectorstores/qdrant)
        *   [Redis](/v0.2/docs/integrations/vectorstores/redis)
        *   [Rockset](/v0.2/docs/integrations/vectorstores/rockset)
        *   [SingleStore](/v0.2/docs/integrations/vectorstores/singlestore)
        *   [Supabase](/v0.2/docs/integrations/vectorstores/supabase)
        *   [Tigris](/v0.2/docs/integrations/vectorstores/tigris)
        *   [Turbopuffer](/v0.2/docs/integrations/vectorstores/turbopuffer)
        *   [TypeORM](/v0.2/docs/integrations/vectorstores/typeorm)
        *   [Typesense](/v0.2/docs/integrations/vectorstores/typesense)
        *   [Upstash Vector](/v0.2/docs/integrations/vectorstores/upstash)
        *   [USearch](/v0.2/docs/integrations/vectorstores/usearch)
        *   [Vectara](/v0.2/docs/integrations/vectorstores/vectara)
        *   [Vercel Postgres](/v0.2/docs/integrations/vectorstores/vercel_postgres)
        *   [Voy](/v0.2/docs/integrations/vectorstores/voy)
        *   [Weaviate](/v0.2/docs/integrations/vectorstores/weaviate)
        *   [Xata](/v0.2/docs/integrations/vectorstores/xata)
        *   [Zep](/v0.2/docs/integrations/vectorstores/zep)
    *   [Retrievers](/v0.2/docs/integrations/retrievers)
        
    *   [Tools](/v0.2/docs/integrations/tools)
        
    *   [Toolkits](/v0.2/docs/integrations/toolkits)
        
    *   [Stores](/v0.2/docs/integrations/stores/)
        

*   [](/v0.2/)
*   [Components](/v0.2/docs/integrations/components)
*   [Vector stores](/v0.2/docs/integrations/vectorstores)
*   Redis

On this page

Redis
=====

[Redis](https://redis.io/) is a fast open source, in-memory data store. As part of the [Redis Stack](https://redis.io/docs/stack/get-started/), [RediSearch](https://redis.io/docs/stack/search/) is the module that enables vector similarity semantic search, as well as many other types of searching.

Compatibility

Only available on Node.js.

LangChain.js accepts [node-redis](https://github.com/redis/node-redis) as the client for Redis vectorstore.

Setup[​](#setup "Direct link to Setup")
---------------------------------------

1.  Run Redis with Docker on your computer following [the docs](https://redis.io/docs/stack/get-started/install/docker/#redisredis-stack)
2.  Install the node-redis JS client

*   npm
*   Yarn
*   pnpm

    npm install -S redis

    yarn add redis

    pnpm add redis

tip

See [this section for general instructions on installing integration packages](/v0.2/docs/how_to/installation#installing-integration-packages).

*   npm
*   Yarn
*   pnpm

    npm install @langchain/openai @langchain/community

    yarn add @langchain/openai @langchain/community

    pnpm add @langchain/openai @langchain/community

Index docs[​](#index-docs "Direct link to Index docs")
------------------------------------------------------

    import { createClient } from "redis";import { OpenAIEmbeddings } from "@langchain/openai";import { RedisVectorStore } from "@langchain/redis";import { Document } from "@langchain/core/documents";const client = createClient({  url: process.env.REDIS_URL ?? "redis://localhost:6379",});await client.connect();const docs = [  new Document({    metadata: { foo: "bar" },    pageContent: "redis is fast",  }),  new Document({    metadata: { foo: "bar" },    pageContent: "the quick brown fox jumped over the lazy dog",  }),  new Document({    metadata: { baz: "qux" },    pageContent: "lorem ipsum dolor sit amet",  }),  new Document({    metadata: { baz: "qux" },    pageContent: "consectetur adipiscing elit",  }),];const vectorStore = await RedisVectorStore.fromDocuments(  docs,  new OpenAIEmbeddings(),  {    redisClient: client,    indexName: "docs",  });await client.disconnect();

#### API Reference:

*   [OpenAIEmbeddings](https://v02.api.js.langchain.com/classes/langchain_openai.OpenAIEmbeddings.html) from `@langchain/openai`
*   [RedisVectorStore](https://v02.api.js.langchain.com/classes/langchain_redis.RedisVectorStore.html) from `@langchain/redis`
*   [Document](https://v02.api.js.langchain.com/classes/langchain_core_documents.Document.html) from `@langchain/core/documents`

Query docs[​](#query-docs "Direct link to Query docs")
------------------------------------------------------

    import { createClient } from "redis";import { ChatOpenAI, OpenAIEmbeddings } from "@langchain/openai";import { RedisVectorStore } from "@langchain/redis";import { ChatPromptTemplate } from "@langchain/core/prompts";import { createStuffDocumentsChain } from "langchain/chains/combine_documents";import { createRetrievalChain } from "langchain/chains/retrieval";const client = createClient({  url: process.env.REDIS_URL ?? "redis://localhost:6379",});await client.connect();const vectorStore = new RedisVectorStore(new OpenAIEmbeddings(), {  redisClient: client,  indexName: "docs",});/* Simple standalone search in the vector DB */const simpleRes = await vectorStore.similaritySearch("redis", 1);console.log(simpleRes);/*[  Document {    pageContent: "redis is fast",    metadata: { foo: "bar" }  }]*//* Search in the vector DB using filters */const filterRes = await vectorStore.similaritySearch("redis", 3, ["qux"]);console.log(filterRes);/*[  Document {    pageContent: "consectetur adipiscing elit",    metadata: { baz: "qux" },  },  Document {    pageContent: "lorem ipsum dolor sit amet",    metadata: { baz: "qux" },  }]*//* Usage as part of a chain */const model = new ChatOpenAI({ model: "gpt-3.5-turbo-1106" });const questionAnsweringPrompt = ChatPromptTemplate.fromMessages([  [    "system",    "Answer the user's questions based on the below context:\n\n{context}",  ],  ["human", "{input}"],]);const combineDocsChain = await createStuffDocumentsChain({  llm: model,  prompt: questionAnsweringPrompt,});const chain = await createRetrievalChain({  retriever: vectorStore.asRetriever(),  combineDocsChain,});const chainRes = await chain.invoke({ input: "What did the fox do?" });console.log(chainRes);/*  {    input: 'What did the fox do?',    chat_history: [],    context: [      Document {        pageContent: 'the quick brown fox jumped over the lazy dog',        metadata: [Object]      },      Document {        pageContent: 'lorem ipsum dolor sit amet',        metadata: [Object]      },      Document {        pageContent: 'consectetur adipiscing elit',        metadata: [Object]      },      Document { pageContent: 'redis is fast', metadata: [Object] }    ],    answer: 'The fox jumped over the lazy dog.'  }*/await client.disconnect();

#### API Reference:

*   [ChatOpenAI](https://v02.api.js.langchain.com/classes/langchain_openai.ChatOpenAI.html) from `@langchain/openai`
*   [OpenAIEmbeddings](https://v02.api.js.langchain.com/classes/langchain_openai.OpenAIEmbeddings.html) from `@langchain/openai`
*   [RedisVectorStore](https://v02.api.js.langchain.com/classes/langchain_redis.RedisVectorStore.html) from `@langchain/redis`
*   [ChatPromptTemplate](https://v02.api.js.langchain.com/classes/langchain_core_prompts.ChatPromptTemplate.html) from `@langchain/core/prompts`
*   [createStuffDocumentsChain](https://v02.api.js.langchain.com/functions/langchain_chains_combine_documents.createStuffDocumentsChain.html) from `langchain/chains/combine_documents`
*   [createRetrievalChain](https://v02.api.js.langchain.com/functions/langchain_chains_retrieval.createRetrievalChain.html) from `langchain/chains/retrieval`

Create index with options[​](#create-index-with-options "Direct link to Create index with options")
---------------------------------------------------------------------------------------------------

To pass arguments for [index creation](https://redis.io/commands/ft.create/), you can utilize the [available options](https://github.com/redis/node-redis/blob/294cbf8367295ac81cbe51ce2932493ab80493f1/packages/search/lib/commands/CREATE.ts#L4) offered by [node-redis](https://github.com/redis/node-redis) through `createIndexOptions` parameter.

    import { createClient } from "redis";import { OpenAIEmbeddings } from "@langchain/openai";import { RedisVectorStore } from "@langchain/redis";import { Document } from "@langchain/core/documents";const client = createClient({  url: process.env.REDIS_URL ?? "redis://localhost:6379",});await client.connect();const docs = [  new Document({    metadata: { foo: "bar" },    pageContent: "redis is fast",  }),  new Document({    metadata: { foo: "bar" },    pageContent: "the quick brown fox jumped over the lazy dog",  }),  new Document({    metadata: { baz: "qux" },    pageContent: "lorem ipsum dolor sit amet",  }),  new Document({    metadata: { baz: "qux" },    pageContent: "consectetur adipiscing elit",  }),];const vectorStore = await RedisVectorStore.fromDocuments(  docs,  new OpenAIEmbeddings(),  {    redisClient: client,    indexName: "docs",    createIndexOptions: {      TEMPORARY: 1000,    },  });await client.disconnect();

#### API Reference:

*   [OpenAIEmbeddings](https://v02.api.js.langchain.com/classes/langchain_openai.OpenAIEmbeddings.html) from `@langchain/openai`
*   [RedisVectorStore](https://v02.api.js.langchain.com/classes/langchain_redis.RedisVectorStore.html) from `@langchain/redis`
*   [Document](https://v02.api.js.langchain.com/classes/langchain_core_documents.Document.html) from `@langchain/core/documents`

Delete an index[​](#delete-an-index "Direct link to Delete an index")
---------------------------------------------------------------------

    import { createClient } from "redis";import { OpenAIEmbeddings } from "@langchain/openai";import { RedisVectorStore } from "@langchain/redis";import { Document } from "@langchain/core/documents";const client = createClient({  url: process.env.REDIS_URL ?? "redis://localhost:6379",});await client.connect();const docs = [  new Document({    metadata: { foo: "bar" },    pageContent: "redis is fast",  }),  new Document({    metadata: { foo: "bar" },    pageContent: "the quick brown fox jumped over the lazy dog",  }),  new Document({    metadata: { baz: "qux" },    pageContent: "lorem ipsum dolor sit amet",  }),  new Document({    metadata: { baz: "qux" },    pageContent: "consectetur adipiscing elit",  }),];const vectorStore = await RedisVectorStore.fromDocuments(  docs,  new OpenAIEmbeddings(),  {    redisClient: client,    indexName: "docs",  });await vectorStore.delete({ deleteAll: true });await client.disconnect();

#### API Reference:

*   [OpenAIEmbeddings](https://v02.api.js.langchain.com/classes/langchain_openai.OpenAIEmbeddings.html) from `@langchain/openai`
*   [RedisVectorStore](https://v02.api.js.langchain.com/classes/langchain_redis.RedisVectorStore.html) from `@langchain/redis`
*   [Document](https://v02.api.js.langchain.com/classes/langchain_core_documents.Document.html) from `@langchain/core/documents`

* * *

#### Was this page helpful?

  

#### You can leave detailed feedback [on GitHub](https://github.com/langchain-ai/langchainjs/issues/new?assignees=&labels=03+-+Documentation&projects=&template=documentation.yml&title=DOC%3A+%3CPlease+write+a+comprehensive+title+after+the+%27DOC%3A+%27+prefix%3E).

[

Previous

Qdrant

](/v0.2/docs/integrations/vectorstores/qdrant)[

Next

Rockset

](/v0.2/docs/integrations/vectorstores/rockset)

*   [Setup](#setup)
*   [Index docs](#index-docs)
*   [Query docs](#query-docs)
*   [Create index with options](#create-index-with-options)
*   [Delete an index](#delete-an-index)

Community

*   [Discord](https://discord.gg/cU2adEyC7w)
*   [Twitter](https://twitter.com/LangChainAI)

GitHub

*   [Python](https://github.com/langchain-ai/langchain)
*   [JS/TS](https://github.com/langchain-ai/langchainjs)

More

*   [Homepage](https://langchain.com)
*   [Blog](https://blog.langchain.dev)

Copyright © 2024 LangChain, Inc.