Skip to content

Commit d7c4836

Browse files
committed
docs: add IBM watsonx provider documentation
Add documentation for IBM watsonx AI provider following PR #10167. Includes setup instructions for both IBM Cloud and Cloud Pak for Data platforms. Related: RooCodeInc/Roo-Code#10167
1 parent 13ca67a commit d7c4836

File tree

2 files changed

+129
-0
lines changed

2 files changed

+129
-0
lines changed

docs/providers/ibm-watsonx.md

Lines changed: 123 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,123 @@
1+
---
2+
sidebar_label: IBM watsonx
3+
description: Configure IBM watsonx AI models in Roo Code. Access IBM's enterprise AI platform with support for both IBM Cloud and Cloud Pak for Data.
4+
keywords:
5+
- ibm watsonx
6+
- watsonx
7+
- ibm ai
8+
- roo code
9+
- api provider
10+
- enterprise ai
11+
- cloud pak
12+
- ibm cloud
13+
image: /img/social-share.jpg
14+
---
15+
16+
# Using IBM watsonx With Roo Code
17+
18+
IBM watsonx is an enterprise AI and data platform designed to help businesses scale and accelerate AI adoption with trusted data. It provides access to IBM's foundation models and supports deployment on both IBM Cloud and Cloud Pak for Data.
19+
20+
**Website:** [https://www.ibm.com/watsonx](https://www.ibm.com/watsonx)
21+
22+
---
23+
24+
## Getting Started
25+
26+
IBM watsonx supports two deployment platforms:
27+
28+
- **IBM Cloud**: Cloud-based deployment with pay-as-you-go pricing
29+
- **Cloud Pak for Data**: On-premises or private cloud deployment
30+
31+
### Free Trial Setup (IBM Cloud)
32+
33+
1. **Start Free Trial:** Visit [watsonx.ai registration](https://dataplatform.cloud.ibm.com/registration/stepone?context=wx)
34+
2. **Sign Up:** Use Google authentication (recommended, not RedHat)
35+
3. **Add Payment Info:** Add address and credit card information (no charges for trial)
36+
4. **Create Runtime:** Create a watsonx.ai runtime resource (Dallas region recommended, select Lite plan)
37+
5. **Launch watsonx:** Launch IBM watsonx and create a new project
38+
6. **Get Credentials:**
39+
- Generate an API key from your IBM Cloud account
40+
- Note your project ID from the project settings
41+
42+
---
43+
44+
## Getting API Credentials
45+
46+
### For IBM Cloud Platform
47+
48+
1. **API Key:**
49+
50+
- Go to [IBM Cloud API Keys](https://cloud.ibm.com/iam/apikeys)
51+
- Click "Create an IBM Cloud API key"
52+
- Give it a descriptive name (e.g., "Roo Code")
53+
- Copy and save the API key securely
54+
55+
2. **Project ID:**
56+
- Open your watsonx.ai project
57+
- Click on the project name in the top navigation
58+
- Go to "Manage" tab
59+
- Copy the "Project ID" value
60+
61+
### For Cloud Pak for Data Platform
62+
63+
1. **API Key or Username/Password:**
64+
65+
- Contact your Cloud Pak administrator for authentication credentials
66+
- You'll need either an API key or username/password combination
67+
68+
2. **Instance URL:**
69+
- Get the base URL of your Cloud Pak for Data instance from your administrator
70+
- Format: `https://your-cpd-instance.com`
71+
72+
---
73+
74+
## Available Models
75+
76+
IBM watsonx provides access to various foundation models including:
77+
78+
- IBM Granite models
79+
- Meta Llama models
80+
- Other open-source and IBM models
81+
82+
For the complete list of available models and their capabilities, see [IBM watsonx.ai documentation](https://www.ibm.com/docs/en/watsonx-as-a-service).
83+
84+
---
85+
86+
## Configuration in Roo Code
87+
88+
### For IBM Cloud
89+
90+
1. **Open Roo Code Settings:** Click the gear icon (<Codicon name="gear" />) in the Roo Code panel.
91+
2. **Select Provider:** Choose "IBM watsonx" from the "API Provider" dropdown.
92+
3. **Select Platform:** Choose "IBM Cloud" from the "Platform" dropdown.
93+
4. **Enter API Key:** Paste your IBM Cloud API key into the "API Key" field.
94+
5. **Enter Project ID:** Paste your watsonx project ID into the "Project ID" field.
95+
6. **Select Model:** Choose your desired model from the "Model" dropdown.
96+
97+
### For Cloud Pak for Data
98+
99+
1. **Open Roo Code Settings:** Click the gear icon (<Codicon name="gear" />) in the Roo Code panel.
100+
2. **Select Provider:** Choose "IBM watsonx" from the "API Provider" dropdown.
101+
3. **Select Platform:** Choose "Cloud Pak for Data" from the "Platform" dropdown.
102+
4. **Enter Instance URL:** Enter your Cloud Pak for Data instance URL.
103+
5. **Choose Authentication:**
104+
- **API Key:** Enter your Cloud Pak API key
105+
- **OR Username/Password:** Enter your credentials
106+
6. **Enter Project ID or Space ID:** Provide your project or deployment space identifier.
107+
7. **Select Model:** Choose your desired model from the "Model" dropdown.
108+
109+
---
110+
111+
## Tips and Notes
112+
113+
- **Enterprise Features:** IBM watsonx is designed for enterprise use with features like governance, compliance, and security controls.
114+
- **Model Selection:** The available models depend on your watsonx plan and configuration. Some models may require additional setup or permissions.
115+
- **Pricing:** For IBM Cloud, refer to the [IBM watsonx Pricing](https://www.ibm.com/products/watsonx-ai/pricing) page. For Cloud Pak, contact your IBM representative.
116+
- **Documentation:** For detailed platform documentation, visit [IBM watsonx.ai docs](https://www.ibm.com/docs/en/watsonx-as-a-service).
117+
- **Support:** Enterprise support is available through IBM. For trial accounts, use the [IBM Community forums](https://community.ibm.com/).
118+
119+
---
120+
121+
## Credits
122+
123+
IBM watsonx integration was contributed by [@PrasangAPrajapati](https://github.com/PrasangAPrajapati) in [PR #8321](https://github.com/RooCodeInc/Roo-Code/pull/8321) and continued in [PR #10167](https://github.com/RooCodeInc/Roo-Code/pull/10167).

docs/providers/index.json

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -90,6 +90,12 @@
9090
"extension": true,
9191
"cloud": false
9292
},
93+
{
94+
"id": "providers/ibm-watsonx",
95+
"title": "IBM watsonx",
96+
"extension": true,
97+
"cloud": false
98+
},
9399
{
94100
"id": "providers/io-intelligence",
95101
"title": "IO Intelligence",

0 commit comments

Comments
 (0)