mirror of
https://github.com/meta-llama/llama-stack.git
synced 2025-10-11 05:38:38 +00:00
# What does this PR do? use SecretStr for OpenAIMixin providers - RemoteInferenceProviderConfig now has auth_credential: SecretStr - the default alias is api_key (most common name) - some providers override to use api_token (RunPod, vLLM, Databricks) - some providers exclude it (Ollama, TGI, Vertex AI) addresses #3517 ## Test Plan ci w/ new tests
30 lines
1.2 KiB
Text
30 lines
1.2 KiB
Text
---
|
|
description: "IBM WatsonX inference provider for accessing AI models on IBM's WatsonX platform."
|
|
sidebar_label: Remote - Watsonx
|
|
title: remote::watsonx
|
|
---
|
|
|
|
# remote::watsonx
|
|
|
|
## Description
|
|
|
|
IBM WatsonX inference provider for accessing AI models on IBM's WatsonX platform.
|
|
|
|
## Configuration
|
|
|
|
| Field | Type | Required | Default | Description |
|
|
|-------|------|----------|---------|-------------|
|
|
| `allowed_models` | `list[str \| None` | No | | List of models that should be registered with the model registry. If None, all models are allowed. |
|
|
| `refresh_models` | `<class 'bool'>` | No | False | Whether to refresh models periodically from the provider |
|
|
| `api_key` | `pydantic.types.SecretStr \| None` | No | | Authentication credential for the provider |
|
|
| `url` | `<class 'str'>` | No | https://us-south.ml.cloud.ibm.com | A base url for accessing the watsonx.ai |
|
|
| `project_id` | `str \| None` | No | | The watsonx.ai project ID |
|
|
| `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:=}
|
|
```
|