mirror of
https://github.com/meta-llama/llama-stack.git
synced 2025-07-04 21:25:23 +00:00
c9a49a80e8
# What does this PR do? Simple approach to get some provider pages in the docs. Add or update description fields in the provider configuration class using Pydantic’s Field, ensuring these descriptions are clear and complete, as they will be used to auto-generate provider documentation via ./scripts/distro_codegen.py instead of editing the docs manually. Signed-off-by: Sébastien Han <seb@redhat.com>
24 lines
828 B
Markdown
24 lines
828 B
Markdown
# remote::watsonx
|
|
|
|
## Description
|
|
|
|
IBM WatsonX inference provider for accessing AI models on IBM's WatsonX platform.
|
|
|
|
## Configuration
|
|
|
|
| Field | Type | Required | Default | Description |
|
|
|-------|------|----------|---------|-------------|
|
|
| `url` | `<class 'str'>` | No | https://us-south.ml.cloud.ibm.com | A base url for accessing the watsonx.ai |
|
|
| `api_key` | `pydantic.types.SecretStr \| None` | No | | The watsonx API key, only needed of using the hosted service |
|
|
| `project_id` | `str \| None` | No | | The Project ID key, only needed of using the hosted service |
|
|
| `timeout` | `<class 'int'>` | No | 60 | Timeout for the HTTP requests |
|
|
|
|
## Sample Configuration
|
|
|
|
```yaml
|
|
url: ${env.WATSONX_BASE_URL:=https://us-south.ml.cloud.ibm.com}
|
|
api_key: ${env.WATSONX_API_KEY:+}
|
|
project_id: ${env.WATSONX_PROJECT_ID:+}
|
|
|
|
```
|
|
|