docs[patch]: Update ParentDocument docs to use byte store (#6647)

langchain-ai · Aug 28, 2024 · 3a61cdb · 3a61cdb
1 parent 3f9d6a2
commit 3a61cdb
Show file tree

Hide file tree

Showing 4 changed files with 11 additions and 9 deletions.
diff --git a/examples/src/retrievers/parent_document_retriever.ts b/examples/src/retrievers/parent_document_retriever.ts
@@ -1,15 +1,16 @@
 import { OpenAIEmbeddings } from "@langchain/openai";
 import { MemoryVectorStore } from "langchain/vectorstores/memory";
-import { InMemoryStore } from "@langchain/core/stores";
 import { ParentDocumentRetriever } from "langchain/retrievers/parent_document";
 import { RecursiveCharacterTextSplitter } from "@langchain/textsplitters";
 import { TextLoader } from "langchain/document_loaders/fs/text";
+import { InMemoryStore } from "@langchain/core/stores";
 
 const vectorstore = new MemoryVectorStore(new OpenAIEmbeddings());
-const docstore = new InMemoryStore();
+const byteStore = new InMemoryStore<Uint8Array>();
+
 const retriever = new ParentDocumentRetriever({
   vectorstore,
-  docstore,
+  byteStore,
   // Optional, not required if you're already passing in split documents
   parentSplitter: new RecursiveCharacterTextSplitter({
     chunkOverlap: 0,

diff --git a/examples/src/retrievers/parent_document_retriever_chunk_header.ts b/examples/src/retrievers/parent_document_retriever_chunk_header.ts
@@ -22,11 +22,11 @@ const pamChunkHeaderOptions = {
 };
 
 const vectorstore = await HNSWLib.fromDocuments([], new OpenAIEmbeddings());
-const docstore = new InMemoryStore();
+const byteStore = new InMemoryStore<Uint8Array>();
 
 const retriever = new ParentDocumentRetriever({
   vectorstore,
-  docstore,
+  byteStore,
   // Very small chunks for demo purposes.
   // Use a bigger chunk size for serious use-cases.
   childSplitter: new RecursiveCharacterTextSplitter({

diff --git a/examples/src/retrievers/parent_document_retriever_rerank.ts b/examples/src/retrievers/parent_document_retriever_rerank.ts
@@ -44,11 +44,11 @@ const jimDocs = await splitter.createDocuments([`Jim favorite color is blue.`]);
 const pamDocs = await splitter.createDocuments([`Pam favorite color is red.`]);
 
 const vectorstore = await HNSWLib.fromDocuments([], new OpenAIEmbeddings());
-const docstore = new InMemoryStore();
+const byteStore = new InMemoryStore<Uint8Array>();
 
 const retriever = new ParentDocumentRetriever({
   vectorstore,
-  docstore,
+  byteStore,
   // Very small chunks for demo purposes.
   // Use a bigger chunk size for serious use-cases.
   childSplitter: new RecursiveCharacterTextSplitter({

diff --git a/examples/src/retrievers/parent_document_retriever_score_threshold.ts b/examples/src/retrievers/parent_document_retriever_score_threshold.ts
@@ -7,7 +7,8 @@ import { TextLoader } from "langchain/document_loaders/fs/text";
 import { ScoreThresholdRetriever } from "langchain/retrievers/score_threshold";
 
 const vectorstore = new MemoryVectorStore(new OpenAIEmbeddings());
-const docstore = new InMemoryStore();
+const byteStore = new InMemoryStore<Uint8Array>();
+
 const childDocumentRetriever = ScoreThresholdRetriever.fromVectorStore(
   vectorstore,
   {
@@ -17,7 +18,7 @@ const childDocumentRetriever = ScoreThresholdRetriever.fromVectorStore(
 );
 const retriever = new ParentDocumentRetriever({
   vectorstore,
-  docstore,
+  byteStore,
   childDocumentRetriever,
   // Optional, not required if you're already passing in split documents
   parentSplitter: new RecursiveCharacterTextSplitter({