Add update instructions

Kureev · Apr 9, 2023 · 15e132d · 15e132d
1 parent 5987015
commit 15e132d
Show file tree

Hide file tree

Showing 5 changed files with 33 additions and 3 deletions.
diff --git a/docs/docs/getting-started/install.md b/docs/docs/getting-started/install.md
@@ -4,6 +4,10 @@ sidebar_position: 1
 
 # Setup and Installation
 
+:::info
+Updating from <0.0.52? See [this section](#updating-from-0052) for instructions.
+:::
+
 ## Quickstart
 
 If you want to get started quickly on using LangChain in Node.js, [clone this repository](https://github.com/domeccleston/langchain-ts-starter) and follow the README instructions for a boilerplate project with those dependencies set up.
@@ -83,6 +87,17 @@ const nextConfig = {
 };
 ```
 
+## Updating from <0.0.52
+
+If you are updating from a version of LangChain prior to 0.0.52, you will need to update your imports to use the new path structure. For example, if you were previously importing `OpenAI` from `langchain/llms`, you will now need to import it from `langchain/llms/openai`. This applies to all imports from
+
+- `langchain/llms`, see [LLMs](../modules/models/llms/integrations)
+- `langchain/chat_models`, see [Chat Models](../modules/models/chat/integrations)
+- `langchain/embeddings`, see [Embeddings](../modules/models/embeddings/integrations)
+- `langchain/vectorstores`, see [Vector Stores](../modules/indexes/vector_stores/integrations/)
+- `langchain/document_loaders`, see [Document Loaders](../modules/indexes/document_loaders/examples/)
+- `langchain/retrievers`, see [Retrievers](../modules/indexes/retrievers/)
+
 ## Unsupported: Node.js 16
 
 We do not support Node.js 16, but if you still want to run LangChain on Node.js 16, you will need to follow the instructions in this section. We do not guarantee that these instructions will continue to work in the future.

diff --git a/docs/docs/modules/indexes/retrievers/chatgpt-retriever-plugin.mdx b/docs/docs/modules/indexes/retrievers/chatgpt-retriever-plugin.mdx
@@ -1,3 +1,7 @@
+---
+hide_table_of_contents: true
+---
+
 # ChatGPT Plugin Retriever
 
 This example shows how to use the ChatGPT Retriever Plugin within LangChain.

diff --git a/docs/docs/modules/indexes/retrievers/metal-retriever.mdx b/docs/docs/modules/indexes/retrievers/metal-retriever.mdx
@@ -1,3 +1,7 @@
+---
+hide_table_of_contents: true
+---
+
 # Remote Retriever
 
 This example shows how to use the Metal Retriever in a `RetrievalQAChain` to retrieve documents from Metal index.

diff --git a/docs/docs/modules/indexes/retrievers/remote-retriever.mdx b/docs/docs/modules/indexes/retrievers/remote-retriever.mdx
@@ -1,3 +1,7 @@
+---
+hide_table_of_contents: true
+---
+
 # Remote Retriever
 
 This example shows how to use a Remote Retriever in a `RetrievalQAChain` to retrieve documents from a remote server.

diff --git a/docs/docs/modules/indexes/retrievers/vectorstore.md b/docs/docs/modules/indexes/retrievers/vectorstore.md
@@ -1,7 +1,10 @@
-# VectorStore
+---
+hide_table_of_contents: true
+---
 
-The main supported type of Retriever is one backed by a Vector Store.
-Once you've created a Vector Store, the way to use it as a Retriever is very simple:
+# Vector Store
+
+Once you've created a [Vector Store](../vector_stores/), the way to use it as a Retriever is very simple:
 
 ```typescript
 vectorStore = ...