Skip to content

Commit e7ef74d

Browse files
MateuszOssGitMateuszOssGit
authored
docs(langchain-ibm): Updated langchain-ibm reference documentation (#1247)
## Overview Updated `langchain-ibm` reference documentation ## Type of change **Type:** [Replace with: New documentation page / Update existing documentation / Fix typo/bug/link/formatting / Remove outdated content / Other] - Update existing documentation: Updated `langchain-ibm` reference documentation ## Related issues/PRs <!-- Link to related issues, feature PRs, or discussions (if applicable) To automatically close an issue when this PR is merged, use closing keywords: - "closes #123" or "fixes #123" or "resolves #123" For regular references without auto-closing, just use: - "#123" or "See issue #123" Examples: - closes #456 (will auto-close issue #456 when PR is merged) - See #789 for context (will reference but not auto-close issue #789) --> - GitHub issue: - Feature PR: <!-- For LangChain employees, if applicable: --> - Linear issue: - Slack thread: ## Checklist <!-- Put an 'x' in all boxes that apply --> - [x] I have read the [contributing guidelines](README.md) - [x] I have tested my changes locally using `docs dev` - [x] All code examples have been tested and work correctly - [ ] I have used **root relative** paths for internal links - [ ] I have updated navigation in `src/docs.json` if needed - I have gotten approval from the relevant reviewers - (Internal team members only / optional) I have created a preview deployment using the [Create Preview Branch workflow](https://github.com/langchain-ai/docs/actions/workflows/create-preview-branch.yml) ## Additional notes <!-- Any other information that would be helpful for reviewers -->
1 parent 91367a7 commit e7ef74d

File tree

9 files changed

+144
-12
lines changed

9 files changed

+144
-12
lines changed

‎reference/python/docs/integrations/langchain_ibm.md‎

Lines changed: 0 additions & 11 deletions
This file was deleted.

‎reference/python/docs/integrations/langchain_ibm/ChatWatsonx.md‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
---
2+
title: ChatWatsonx
3+
---
4+
5+
# `ChatWatsonx`
6+
7+
!!! warning "Reference docs"
8+
This page contains **reference documentation** for `ChatWatsonx`. See
9+
[the docs](https://docs.langchain.com/oss/python/integrations/chat/ibm_watsonx)
10+
for conceptual guides, tutorials, and examples on using `ChatWatsonx`.
11+
12+
::: langchain_ibm.chat_models.ChatWatsonx

‎reference/python/docs/integrations/langchain_ibm/WatsonxEmbeddings.md‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
---
2+
title: WatsonxEmbeddings
3+
---
4+
5+
# `WatsonxEmbeddings`
6+
7+
!!! warning "Reference docs"
8+
This page contains **reference documentation** for `WatsonxEmbeddings`. See
9+
[the docs](https://docs.langchain.com/oss/python/integrations/text_embedding/ibm_watsonx)
10+
for conceptual guides, tutorials, and examples on using `WatsonxEmbeddings`.
11+
12+
::: langchain_ibm.embeddings.WatsonxEmbeddings

‎reference/python/docs/integrations/langchain_ibm/WatsonxLLM.md‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
---
2+
title: WatsonxLLM
3+
---
4+
5+
# `WatsonxLLM`
6+
7+
!!! warning "Reference docs"
8+
This page contains **reference documentation** for `WatsonxLLM`. See
9+
[the docs](https://docs.langchain.com/oss/python/integrations/llms/ibm_watsonx)
10+
for conceptual guides, tutorials, and examples on using `WatsonxLLM`.
11+
12+
::: langchain_ibm.llms.WatsonxLLM

‎reference/python/docs/integrations/langchain_ibm/WatsonxRerank.md‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
---
2+
title: WatsonxRerank
3+
---
4+
5+
# `WatsonxRerank`
6+
7+
!!! warning "Reference docs"
8+
This page contains **reference documentation** for `WatsonxRerank`. See
9+
[the docs](https://docs.langchain.com/oss/python/integrations/retrievers/ibm_watsonx_ranker)
10+
for conceptual guides, tutorials, and examples on using `WatsonxRerank`.
11+
12+
::: langchain_ibm.rerank.WatsonxRerank

‎reference/python/docs/integrations/langchain_ibm/WatsonxSQLDatabaseToolkit.md‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
---
2+
title: WatsonxSQLDatabaseToolkit
3+
---
4+
5+
# `WatsonxSQLDatabaseToolkit`
6+
7+
!!! warning "Reference docs"
8+
This page contains **reference documentation** for `WatsonxSQLDatabaseToolkit`.
9+
10+
::: langchain_ibm.agent_toolkits.sql.toolkit.WatsonxSQLDatabaseToolkit

‎reference/python/docs/integrations/langchain_ibm/WatsonxToolkit.md‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
---
2+
title: WatsonxToolkit
3+
---
4+
5+
# `WatsonxToolkit`
6+
7+
!!! warning "Reference docs"
8+
This page contains **reference documentation** for `WatsonxToolkit`. See
9+
[the docs](https://docs.langchain.com/oss/python/integrations/tools/ibm_watsonx)
10+
for conceptual guides, tutorials, and examples on using `WatsonxToolkit`.
11+
12+
::: langchain_ibm.agent_toolkits.utility.toolkit.WatsonxToolkit

‎reference/python/docs/integrations/langchain_ibm/index.md‎

Lines changed: 66 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,66 @@
1+
---
2+
title: IBM
3+
---
4+
5+
# `langchain-ibm`
6+
7+
[![PyPI - Version](https://img.shields.io/pypi/v/langchain-ibm?label=%20)](https://pypi.org/project/langchain-ibm/#history)
8+
[![PyPI - License](https://img.shields.io/pypi/l/langchain-ibm)](https://opensource.org/licenses/MIT)
9+
[![PyPI - Downloads](https://img.shields.io/pepy/dt/langchain-ibm)](https://pypistats.org/packages/langchain-ibm)
10+
11+
## Modules
12+
13+
!!! note "Usage documentation"
14+
Refer to [the docs](https://docs.langchain.com/oss/python/integrations/providers/ibm) for a high-level guide on how to use each module. These reference pages contain auto-generated API documentation for each module, focusing on the "what" rather than the "how" or "why" (i.e. no end-to-end tutorials or conceptual overviews).
15+
16+
<div class="grid cards" markdown>
17+
18+
- :material-message-text:{ .lg .middle } __`ChatWatsonx`__
19+
20+
---
21+
22+
IBM watsonx.ai chat models.
23+
24+
[:octicons-arrow-right-24: Reference](./ChatWatsonx.md)
25+
26+
- :material-message-text:{ .lg .middle } __`WatsonxLLM`__
27+
28+
---
29+
30+
(Legacy) IBM watsonx.ai text completion models.
31+
32+
[:octicons-arrow-right-24: Reference](./WatsonxLLM.md)
33+
34+
- :fontawesome-solid-layer-group:{ .lg .middle } __`WatsonxEmbeddings`__
35+
36+
---
37+
38+
IBM watsonx.ai embedding models.
39+
40+
[:octicons-arrow-right-24: Reference](./WatsonxEmbeddings.md)
41+
42+
- :fontawesome-solid-layer-group:{ .lg .middle } __`WatsonxRerank`__
43+
44+
---
45+
46+
IBM watsonx.ai document retriever.
47+
48+
[:octicons-arrow-right-24: Reference](./WatsonxRerank.md)
49+
50+
- :fontawesome-solid-screwdriver-wrench:{ .lg .middle } __`WatsonxToolkit`__
51+
52+
---
53+
54+
IBM watsonx.ai toolkit.
55+
56+
[:octicons-arrow-right-24: Reference](./WatsonxToolkit.md)
57+
58+
- :fontawesome-solid-screwdriver-wrench:{ .lg .middle } __`WatsonxSQLDatabaseToolkit`__
59+
60+
---
61+
62+
IBM watsonx.ai SQL database toolkit.
63+
64+
[:octicons-arrow-right-24: Reference](./WatsonxSQLDatabaseToolkit.md)
65+
66+
</div>

‎reference/python/mkdocs.yml‎

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -444,7 +444,14 @@ nav:
444444
- Google (VertexAI): integrations/langchain_google_vertexai.md
445445
- Groq: integrations/langchain_groq.md
446446
- HuggingFace: integrations/langchain_huggingface.md
447-
- IBM: integrations/langchain_ibm.md
447+
- IBM:
448+
- integrations/langchain_ibm/index.md
449+
- ChatWatsonx: integrations/langchain_ibm/ChatWatsonx.md
450+
- WatsonxLLM: integrations/langchain_ibm/WatsonxLLM.md
451+
- WatsonxEmbeddings: integrations/langchain_ibm/WatsonxEmbeddings.md
452+
- WatsonxRerank: integrations/langchain_ibm/WatsonxRerank.md
453+
- WatsonxToolkit: integrations/langchain_ibm/WatsonxToolkit.md
454+
- WatsonxSQLDatabaseToolkit: integrations/langchain_ibm/WatsonxSQLDatabaseToolkit.md
448455
- Milvus: integrations/langchain_milvus.md
449456
- Mistral AI: integrations/langchain_mistralai.md
450457
- MongoDB: https://langchain-mongodb.readthedocs.io/en/latest/index.html

0 commit comments

Comments
 (0)