Skip to content

Commit afdd636

Browse files
author
Erick Friis
authored
docs: partner packages (langchain-ai#16960)
1 parent 06660bc commit afdd636

File tree

10 files changed

+293
-9
lines changed

10 files changed

+293
-9
lines changed

‎docs/.local_build.sh

+2-1
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,8 @@ cp ../cookbook/README.md src/pages/cookbook.mdx
1616
mkdir -p docs/templates
1717
cp ../templates/docs/INDEX.md docs/templates/index.md
1818
poetry run python scripts/copy_templates.py
19-
wget https://raw.githubusercontent.com/langchain-ai/langserve/main/README.md -O docs/langserve.md
19+
wget -q https://raw.githubusercontent.com/langchain-ai/langserve/main/README.md -O docs/langserve.md
20+
wget -q https://raw.githubusercontent.com/langchain-ai/langgraph/main/README.md -O docs/langgraph.md
2021

2122
yarn
2223

‎docs/docs/integrations/chat/mistralai.ipynb

+13-1
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,19 @@
1919
"\n",
2020
"This notebook covers how to get started with MistralAI chat models, via their [API](https://docs.mistral.ai/api/).\n",
2121
"\n",
22-
"A valid [API key](https://console.mistral.ai/users/api-keys/) is needed to communicate with the API."
22+
"A valid [API key](https://console.mistral.ai/users/api-keys/) is needed to communicate with the API.\n",
23+
"\n",
24+
"You will need the `langchain-mistralai` package to use the API. You can install it via pip:"
25+
]
26+
},
27+
{
28+
"cell_type": "code",
29+
"execution_count": null,
30+
"id": "eb978a7e",
31+
"metadata": {},
32+
"outputs": [],
33+
"source": [
34+
"%pip install -qU langchain-core langchain-mistralai"
2335
]
2436
},
2537
{

‎docs/docs/integrations/platforms/index.mdx

+22
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
# Providers
2+
3+
LangChain integrates with many providers
4+
5+
## Partner Packages
6+
7+
- [OpenAI](/docs/integrations/platforms/openai)
8+
- [Anthropic](/docs/integrations/platforms/anthropic)
9+
- [Google](/docs/integrations/platforms/google)
10+
- [MistralAI](/docs/integrations/providers/mistralai)
11+
- [NVIDIA AI](/docs/integrations/providers/nvidia)
12+
- [Together AI](/docs/integrations/providers/together)
13+
- [Robocorp](/docs/integrations/providers/robocorp)
14+
- [Exa Search](/docs/integrations/providers/exa_search)
15+
- [Nomic](/docs/integrations/providers/nomic)
16+
17+
18+
## Featured Community Providers
19+
20+
- [AWS](/docs/integrations/platforms/aws)
21+
- [Hugging Face](/docs/integrations/platforms/huggingface)
22+
- [Microsoft](/docs/integrations/platforms/microsoft)

‎docs/docs/integrations/providers/exa_search.ipynb

+77
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,77 @@
1+
{
2+
"cells": [
3+
{
4+
"cell_type": "markdown",
5+
"metadata": {},
6+
"source": [
7+
"# Exa Search\n",
8+
"\n",
9+
"Exa's search integration exists in its own [partner package](https://pypi.org/project/langchain-exa/). You can install it with:"
10+
]
11+
},
12+
{
13+
"cell_type": "code",
14+
"execution_count": null,
15+
"metadata": {},
16+
"outputs": [],
17+
"source": [
18+
"%pip install -qU langchain-exa"
19+
]
20+
},
21+
{
22+
"cell_type": "markdown",
23+
"metadata": {},
24+
"source": [
25+
"In order to use the package, you will also need to set the `EXA_API_KEY` environment variable to your Exa API key.\n",
26+
"\n",
27+
"## Retriever\n",
28+
"\n",
29+
"You can use the [`ExaSearchRetriever`](/docs/integrations/tools/exa_search#using-exasearchretriever) in a standard retrieval pipeline. You can import it as follows"
30+
]
31+
},
32+
{
33+
"cell_type": "code",
34+
"execution_count": 2,
35+
"metadata": {
36+
"id": "y8ku6X96sebl"
37+
},
38+
"outputs": [],
39+
"source": [
40+
"from langchain_exa import ExaSearchRetriever"
41+
]
42+
},
43+
{
44+
"cell_type": "markdown",
45+
"metadata": {},
46+
"source": [
47+
"## Tools\n",
48+
"\n",
49+
"You can use Exa as an agent tool as described in the [Exa tool calling docs](/docs/integrations/tools/exa_search#using-the-exa-sdk-as-langchain-agent-tools).\n"
50+
]
51+
}
52+
],
53+
"metadata": {
54+
"colab": {
55+
"provenance": []
56+
},
57+
"kernelspec": {
58+
"display_name": "Python 3 (ipykernel)",
59+
"language": "python",
60+
"name": "python3"
61+
},
62+
"language_info": {
63+
"codemirror_mode": {
64+
"name": "ipython",
65+
"version": 3
66+
},
67+
"file_extension": ".py",
68+
"mimetype": "text/x-python",
69+
"name": "python",
70+
"nbconvert_exporter": "python",
71+
"pygments_lexer": "ipython3",
72+
"version": "3.10.11"
73+
}
74+
},
75+
"nbformat": 4,
76+
"nbformat_minor": 1
77+
}

‎docs/docs/integrations/providers/mistralai.ipynb

+78
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,78 @@
1+
{
2+
"cells": [
3+
{
4+
"cell_type": "markdown",
5+
"metadata": {},
6+
"source": [
7+
"# MistralAI\n",
8+
"\n",
9+
"Mistral AI is a platform that offers hosting for their powerful open source models.\n",
10+
"\n",
11+
"You can access them via their [API](https://docs.mistral.ai/api/).\n",
12+
"\n",
13+
"A valid [API key](https://console.mistral.ai/users/api-keys/) is needed to communicate with the API.\n",
14+
"\n",
15+
"You will also need the `langchain-mistralai` package:"
16+
]
17+
},
18+
{
19+
"cell_type": "code",
20+
"execution_count": null,
21+
"metadata": {},
22+
"outputs": [],
23+
"source": [
24+
"%pip install -qU langchain-core langchain-mistralai"
25+
]
26+
},
27+
{
28+
"cell_type": "code",
29+
"execution_count": 2,
30+
"metadata": {
31+
"id": "y8ku6X96sebl"
32+
},
33+
"outputs": [],
34+
"source": [
35+
"from langchain_mistralai import ChatMistralAI, MistralAIEmbeddings"
36+
]
37+
},
38+
{
39+
"cell_type": "markdown",
40+
"metadata": {},
41+
"source": [
42+
"See the docs for their\n",
43+
"\n",
44+
"- [Chat Model](/docs/integrations/chat/mistralai)\n",
45+
"- [Embeddings Model](/docs/integrations/text_embedding/mistralai)"
46+
]
47+
},
48+
{
49+
"cell_type": "markdown",
50+
"metadata": {},
51+
"source": []
52+
}
53+
],
54+
"metadata": {
55+
"colab": {
56+
"provenance": []
57+
},
58+
"kernelspec": {
59+
"display_name": "Python 3 (ipykernel)",
60+
"language": "python",
61+
"name": "python3"
62+
},
63+
"language_info": {
64+
"codemirror_mode": {
65+
"name": "ipython",
66+
"version": 3
67+
},
68+
"file_extension": ".py",
69+
"mimetype": "text/x-python",
70+
"name": "python",
71+
"nbconvert_exporter": "python",
72+
"pygments_lexer": "ipython3",
73+
"version": "3.10.11"
74+
}
75+
},
76+
"nbformat": 4,
77+
"nbformat_minor": 1
78+
}

‎docs/docs/integrations/providers/nomic.ipynb

+16
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,22 @@
1111
"- Atlas: their Visual Data Engine\n",
1212
"- GPT4All: their Open Source Edge Language Model Ecosystem\n",
1313
"\n",
14+
"The Nomic integration exists in its own [partner package](https://pypi.org/project/langchain-nomic/). You can install it with:"
15+
]
16+
},
17+
{
18+
"cell_type": "code",
19+
"execution_count": null,
20+
"metadata": {},
21+
"outputs": [],
22+
"source": [
23+
"%pip install -qU langchain-nomic"
24+
]
25+
},
26+
{
27+
"cell_type": "markdown",
28+
"metadata": {},
29+
"source": [
1430
"Currently, you can import their hosted [embedding model](/docs/integrations/text_embedding/nomic) as follows:"
1531
]
1632
},

‎docs/docs/integrations/providers/together.ipynb

+78
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,78 @@
1+
{
2+
"cells": [
3+
{
4+
"cell_type": "markdown",
5+
"metadata": {},
6+
"source": [
7+
"# Together AI\n",
8+
"\n",
9+
"> The Together API makes it easy to fine-tune or run leading open-source models with a couple lines of code. We have integrated the world’s leading open-source models, including Llama-2, RedPajama, Falcon, Alpaca, Stable Diffusion XL, and more. Read more: https://together.ai\n",
10+
"\n",
11+
"To use, you'll need an API key which you can find here:\n",
12+
"https://api.together.xyz/settings/api-keys. This can be passed in as init param\n",
13+
"``together_api_key`` or set as environment variable ``TOGETHER_API_KEY``.\n",
14+
"\n",
15+
"Together API reference: https://docs.together.ai/reference/inference\n",
16+
"\n",
17+
"You will also need to install the `langchain-together` integration package:"
18+
]
19+
},
20+
{
21+
"cell_type": "code",
22+
"execution_count": null,
23+
"metadata": {},
24+
"outputs": [],
25+
"source": [
26+
"%pip install --upgrade --quiet langchain-together"
27+
]
28+
},
29+
{
30+
"cell_type": "code",
31+
"execution_count": 2,
32+
"metadata": {
33+
"id": "y8ku6X96sebl"
34+
},
35+
"outputs": [],
36+
"source": [
37+
"from __module_name__ import (\n",
38+
" Together, # LLM\n",
39+
" TogetherEmbeddings,\n",
40+
")"
41+
]
42+
},
43+
{
44+
"cell_type": "markdown",
45+
"metadata": {},
46+
"source": [
47+
"See the docs for their\n",
48+
"\n",
49+
"- [LLM](/docs/integrations/llms/together)\n",
50+
"- [Embeddings Model](/docs/integrations/text_embedding/together)"
51+
]
52+
}
53+
],
54+
"metadata": {
55+
"colab": {
56+
"provenance": []
57+
},
58+
"kernelspec": {
59+
"display_name": "Python 3 (ipykernel)",
60+
"language": "python",
61+
"name": "python3"
62+
},
63+
"language_info": {
64+
"codemirror_mode": {
65+
"name": "ipython",
66+
"version": 3
67+
},
68+
"file_extension": ".py",
69+
"mimetype": "text/x-python",
70+
"name": "python",
71+
"nbconvert_exporter": "python",
72+
"pygments_lexer": "ipython3",
73+
"version": "3.10.11"
74+
}
75+
},
76+
"nbformat": 4,
77+
"nbformat_minor": 1
78+
}

‎docs/docs/integrations/tools/exa_search.ipynb

+1-1
Original file line numberDiff line numberDiff line change
@@ -60,7 +60,7 @@
6060
"cell_type": "markdown",
6161
"metadata": {},
6262
"source": [
63-
"# Using ExaSearchRetriever\n",
63+
"## Using ExaSearchRetriever\n",
6464
"\n",
6565
"ExaSearchRetriever is a retriever that uses Exa Search to retrieve relevant documents."
6666
]

‎docs/sidebars.js

+3-3
Original file line numberDiff line numberDiff line change
@@ -87,11 +87,11 @@ module.exports = {
8787
collapsible: false,
8888
items: [
8989
{ type: "autogenerated", dirName: "integrations/platforms" },
90-
{ type: "category", label: "More", collapsed: true, items: [{type:"autogenerated", dirName: "integrations/providers" }]},
90+
{ type: "category", label: "More", collapsed: true, items: [{type:"autogenerated", dirName: "integrations/providers" }], link: { type: 'generated-index', slug: "integrations/providers", }},
9191
],
9292
link: {
93-
type: 'generated-index',
94-
slug: "integrations/providers",
93+
type: 'doc',
94+
id: 'integrations/platforms/index'
9595
},
9696
},
9797
{

‎libs/cli/langchain_cli/integration_template/docs/provider.ipynb

+3-3
Original file line numberDiff line numberDiff line change
@@ -17,9 +17,9 @@
1717
},
1818
"outputs": [],
1919
"source": [
20-
"from __module_name__.chat_models import __ModuleName__Chat\n",
21-
"from __module_name__.llms import __ModuleName__LLM\n",
22-
"from __module_name__.vectorstores import __ModuleName__VectorStore"
20+
"from __module_name__ import Chat__ModuleName__\n",
21+
"from __module_name__ import __ModuleName__LLM\n",
22+
"from __module_name__ import __ModuleName__VectorStore"
2323
]
2424
}
2525
],

0 commit comments

Comments
 (0)