Skip to content

Commit

Permalink
docs: Adding VoyageAI to 'integrations/text_embedding/' dropdown (#28817
Browse files Browse the repository at this point in the history
)

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.
  • Loading branch information
fzowl authored Dec 19, 2024
1 parent f48755d commit 024f020
Showing 1 changed file with 15 additions and 3 deletions.
18 changes: 15 additions & 3 deletions docs/src/theme/EmbeddingTabs.js
Original file line number Diff line number Diff line change
Expand Up @@ -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 ??
Expand All @@ -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",
Expand Down Expand Up @@ -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",
Expand Down

0 comments on commit 024f020

Please sign in to comment.