From 024f020f04c93fe5895d866cffa17d8dc8b2cc99 Mon Sep 17 00:00:00 2001
From: fzowl <160063452+fzowl@users.noreply.github.com>
Date: Thu, 19 Dec 2024 15:29:30 +0100
Subject: [PATCH] docs: Adding VoyageAI to 'integrations/text_embedding/'
 dropdown (#28817)

Thank you for contributing to LangChain!

- [x] **PR title**: "package: description"
- Where "package" is whichever of langchain, community, core, etc. is
being modified. Use "docs: ..." for purely docs changes, "infra: ..."
for CI changes.
  - Example: "community: add foobar LLM"


**Description:**
Adding VoyageAI's text_embedding to 'integrations/text_embedding/'


- [ ] **Add tests and docs**: If you're adding a new integration, please
include
1. a test for the integration, preferably unit tests that do not rely on
network access,
2. an example notebook showing its use. It lives in
`docs/docs/integrations` directory.


- [ ] **Lint and test**: Run `make format`, `make lint` and `make test`
from the root of the package(s) you've modified. See contribution
guidelines for more: https://python.langchain.com/docs/contributing/

Additional guidelines:
- Make sure optional dependencies are imported within a function.
- Please do not add dependencies to pyproject.toml files (even optional
ones) unless they are required for unit tests.
- Most PRs should not touch more than one package.
- Changes should be backwards compatible.
- If you are adding something to community, do not re-import it in
langchain.

If no one reviews your PR within a few days, please @-mention one of
baskaryan, efriis, eyurtsev, ccurme, vbarda, hwchase17.
---
 docs/src/theme/EmbeddingTabs.js | 18 +++++++++++++++---
 1 file changed, 15 insertions(+), 3 deletions(-)

diff --git a/docs/src/theme/EmbeddingTabs.js b/docs/src/theme/EmbeddingTabs.js
index 101adc7b9dc7f..e452989aea0f7 100644
--- a/docs/src/theme/EmbeddingTabs.js
+++ b/docs/src/theme/EmbeddingTabs.js
@@ -25,11 +25,13 @@ export default function EmbeddingTabs(props) {
       hideNomic,
       nvidiaParams,
       hideNvidia,
+      voyageaiParams,
+      hideVoyageai,
       fakeEmbeddingParams,
       hideFakeEmbedding,
       customVarName,
     } = props;
-  
+
     const openAIParamsOrDefault = openaiParams ?? `model="text-embedding-3-large"`;
     const azureParamsOrDefault =
       azureOpenaiParams ??
@@ -42,10 +44,11 @@ export default function EmbeddingTabs(props) {
     const mistralParamsOrDefault = mistralParams ?? `model="mistral-embed"`;
     const nomicsParamsOrDefault = nomicParams ?? `model="nomic-embed-text-v1.5"`;
     const nvidiaParamsOrDefault = nvidiaParams ?? `model="NV-Embed-QA"`;
+    const voyageaiParamsOrDefault = voyageaiParams ?? `model="voyage-3"`;
     const fakeEmbeddingParamsOrDefault = fakeEmbeddingParams ?? `size=4096`;
-  
+
     const embeddingVarName = customVarName ?? "embeddings";
-  
+
     const tabItems = [
       {
         value: "OpenAI",
@@ -137,6 +140,15 @@ export default function EmbeddingTabs(props) {
         default: false,
         shouldHide: hideNvidia,
       },
+      {
+        value: "Voyage AI",
+        label: "Voyage AI",
+        text: `from langchain-voyageai import VoyageAIEmbeddings\n\n${embeddingVarName} = VoyageAIEmbeddings(${voyageaiParamsOrDefault})`,
+        apiKeyName: "VOYAGE_API_KEY",
+        packageName: "langchain-voyageai",
+        default: false,
+        shouldHide: hideVoyageai,
+      },
       {
         value: "Fake",
         label: "Fake",