[docs]: vector store integration pages (#24858)

Co-authored-by: Erick Friis <erick@langchain.dev>
2025-09-04 04:28:58 +00:00 · 2024-08-06 10:20:27 -07:00
parent 2c798622cd
commit a72fddbf8d
29 changed files with 5649 additions and 4436 deletions
--- a/docs/src/theme/EmbeddingTabs.js
+++ b/docs/src/theme/EmbeddingTabs.js
@@ -0,0 +1,75 @@
+import React from "react";
+import Tabs from "@theme/Tabs";
+import TabItem from "@theme/TabItem";
+import CodeBlock from "@theme-original/CodeBlock";
+
+export default function EmbeddingTabs(props) {
+    const {
+      openaiParams,
+      hideOpenai,
+      huggingFaceParams,
+      hideHuggingFace,
+      fakeEmbeddingParams,
+      hideFakeEmbedding,
+      customVarName,
+    } = props;
+  
+    const openAIParamsOrDefault = openaiParams ?? `model="text-embedding-3-large"`;
+    const huggingFaceParamsOrDefault = huggingFaceParams ?? `model="sentence-transformers/all-mpnet-base-v2"`;
+    const fakeEmbeddingParamsOrDefault = fakeEmbeddingParams ?? `size=4096`;
+  
+    const embeddingVarName = customVarName ?? "embeddings";
+  
+    const tabItems = [
+      {
+        value: "OpenAI",
+        label: "OpenAI",
+        text: `from langchain_openai import OpenAIEmbeddings\n\n${embeddingVarName} = OpenAIEmbeddings(${openAIParamsOrDefault})`,
+        apiKeyName: "OPENAI_API_KEY",
+        packageName: "langchain-openai",
+        default: true,
+        shouldHide: hideOpenai,
+      },
+      {
+        value: "HuggingFace",
+        label: "HuggingFace",
+        text: `from langchain_huggingface import HuggingFaceEmbeddings\n\n${embeddingVarName} = HuggingFaceEmbeddings(${huggingFaceParamsOrDefault})`,
+        apiKeyName: undefined,
+        packageName: "langchain-huggingface",
+        default: false,
+        shouldHide: hideHuggingFace,
+      },
+      {
+        value: "Fake Embedding",
+        label: "Fake Embedding",
+        text: `from langchain_core.embeddings import FakeEmbeddings\n\n${embeddingVarName} = FakeEmbeddings(${fakeEmbeddingParamsOrDefault})`,
+        apiKeyName: undefined,
+        packageName: "langchain-core",
+        default: false,
+        shouldHide: hideFakeEmbedding,
+      },
+    ];
+  
+    return (
+        <Tabs groupId="modelTabs">
+            {tabItems
+                .filter((tabItem) => !tabItem.shouldHide)
+                .map((tabItem) => {
+                    const apiKeyText = tabItem.apiKeyName ? `import getpass
+
+    os.environ["${tabItem.apiKeyName}"] = getpass.getpass()` : '';
+                    return (
+                        <TabItem
+                            value={tabItem.value}
+                            label={tabItem.label}
+                            default={tabItem.default}
+                        >
+                            <CodeBlock language="bash">{`pip install -qU ${tabItem.packageName}`}</CodeBlock>              
+                            <CodeBlock language="python">{apiKeyText + (apiKeyText ? "\n\n" : '') + tabItem.text}</CodeBlock>
+                        </TabItem>
+                    );
+                })
+            }
+        </Tabs>
+    );
+  }