-
Notifications
You must be signed in to change notification settings - Fork 774
feat: support all model providers in JSON agent configuration #2109
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -9,17 +9,46 @@ | |
| agent = config_to_agent("config.json") | ||
| # Add tools that need code-based instantiation | ||
| agent.tool_registry.process_tools([ToolWithConfigArg(HttpsConnection("localhost"))]) | ||
|
|
||
| The ``model`` field supports two formats: | ||
|
|
||
| **String format (backward compatible — defaults to Bedrock):** | ||
| {"model": "us.anthropic.claude-sonnet-4-20250514-v1:0"} | ||
|
|
||
| **Object format (supports all providers):** | ||
| { | ||
| "model": { | ||
| "provider": "anthropic", | ||
| "model_id": "claude-sonnet-4-20250514", | ||
| "max_tokens": 10000, | ||
| "client_args": {"api_key": "$ANTHROPIC_API_KEY"} | ||
| } | ||
| } | ||
|
|
||
| Environment variable references (``$VAR`` or ``${VAR}``) in model config values are resolved | ||
| automatically before provider instantiation. | ||
|
|
||
| Note: The following constructor parameters cannot be specified from JSON because they require | ||
| code-based instantiation: ``boto_session`` (Bedrock, SageMaker), ``client`` (OpenAI, Gemini), | ||
| ``gemini_tools`` (Gemini). Use ``region_name`` / ``client_args`` as JSON-friendly alternatives. | ||
| """ | ||
|
|
||
| from __future__ import annotations | ||
|
|
||
| import json | ||
| import os | ||
| import re | ||
| from pathlib import Path | ||
| from typing import Any | ||
| from typing import TYPE_CHECKING, Any | ||
|
|
||
| import jsonschema | ||
| from jsonschema import ValidationError | ||
|
|
||
| if TYPE_CHECKING: | ||
| from ..models.model import Model | ||
|
|
||
| # JSON Schema for agent configuration | ||
| AGENT_CONFIG_SCHEMA = { | ||
|
Check warning on line 51 in src/strands/experimental/agent_config.py
|
||
| "$schema": "http://json-schema.org/draft-07/schema#", | ||
| "title": "Agent Configuration", | ||
| "description": "Configuration schema for creating agents", | ||
|
|
@@ -27,8 +56,25 @@ | |
| "properties": { | ||
| "name": {"description": "Name of the agent", "type": ["string", "null"], "default": None}, | ||
| "model": { | ||
| "description": "The model ID to use for this agent. If not specified, uses the default model.", | ||
| "type": ["string", "null"], | ||
| "description": ( | ||
| "The model to use for this agent. Can be a string (Bedrock model_id) " | ||
| "or an object with a 'provider' field for any supported provider." | ||
| ), | ||
| "oneOf": [ | ||
| {"type": "string"}, | ||
| {"type": "null"}, | ||
| { | ||
| "type": "object", | ||
| "properties": { | ||
| "provider": { | ||
| "description": "The model provider name", | ||
| "type": "string", | ||
| } | ||
| }, | ||
| "required": ["provider"], | ||
| "additionalProperties": True, | ||
| }, | ||
| ], | ||
| "default": None, | ||
| }, | ||
| "prompt": { | ||
|
|
@@ -50,8 +96,90 @@ | |
| # Pre-compile validator for better performance | ||
| _VALIDATOR = jsonschema.Draft7Validator(AGENT_CONFIG_SCHEMA) | ||
|
|
||
| # Only full-string env var references are resolved (no inline interpolation). | ||
| # "prefix-$VAR" is NOT resolved; construct values programmatically instead. | ||
| _ENV_VAR_PATTERN = re.compile(r"^\$\{([^}]+)\}$|^\$([A-Za-z_][A-Za-z0-9_]*)$") | ||
|
|
||
| def config_to_agent(config: str | dict[str, Any], **kwargs: dict[str, Any]) -> Any: | ||
| # Provider name to model class name — resolved via strands.models lazy __getattr__ | ||
| PROVIDER_MAP: dict[str, str] = { | ||
|
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Issue: Suggestion: Map directly to function references instead: PROVIDER_MAP: dict[str, Callable[[dict[str, Any]], Any]] = {
"bedrock": _create_bedrock_model,
"anthropic": _create_anthropic_model,
...
}This requires moving There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. This has been addressed in the latest revision. |
||
| "bedrock": "BedrockModel", | ||
| "anthropic": "AnthropicModel", | ||
| "openai": "OpenAIModel", | ||
| "gemini": "GeminiModel", | ||
| "ollama": "OllamaModel", | ||
| "litellm": "LiteLLMModel", | ||
| "mistral": "MistralModel", | ||
| "llamaapi": "LlamaAPIModel", | ||
| "llamacpp": "LlamaCppModel", | ||
| "sagemaker": "SageMakerAIModel", | ||
| "writer": "WriterModel", | ||
| "openai_responses": "OpenAIResponsesModel", | ||
| } | ||
|
|
||
|
|
||
| def _resolve_env_vars(value: Any) -> Any: | ||
| """Recursively resolve environment variable references in config values. | ||
|
|
||
| String values matching ``$VAR_NAME`` or ``${VAR_NAME}`` are replaced with the | ||
| corresponding environment variable value. Dicts and lists are traversed recursively. | ||
|
|
||
| Args: | ||
| value: The value to resolve. Can be a string, dict, list, or any other type. | ||
|
|
||
| Returns: | ||
| The resolved value with environment variable references replaced. | ||
|
|
||
| Raises: | ||
| ValueError: If a referenced environment variable is not set. | ||
| """ | ||
| if isinstance(value, str): | ||
| match = _ENV_VAR_PATTERN.match(value) | ||
| if match: | ||
| var_name = match.group(1) or match.group(2) | ||
| env_value = os.environ.get(var_name) | ||
| if env_value is None: | ||
| raise ValueError(f"Environment variable '{var_name}' is not set") | ||
| return env_value | ||
| return value | ||
| if isinstance(value, dict): | ||
| return {k: _resolve_env_vars(v) for k, v in value.items()} | ||
| if isinstance(value, list): | ||
| return [_resolve_env_vars(item) for item in value] | ||
| return value | ||
|
|
||
|
|
||
| def _create_model_from_dict(model_config: dict[str, Any]) -> "Model": | ||
| """Create a Model instance from a provider config dict. | ||
|
|
||
| Routes the config to the appropriate model class based on the ``provider`` field, | ||
| then delegates to the class's ``from_dict`` method. All imports are lazy to avoid | ||
| requiring optional dependencies that are not installed. | ||
|
|
||
| Args: | ||
| model_config: Dict containing at least a ``provider`` key and provider-specific params. | ||
|
|
||
| Returns: | ||
| A configured Model instance for the specified provider. | ||
|
|
||
| Raises: | ||
| ValueError: If the provider name is not recognized. | ||
| ImportError: If the provider's optional dependencies are not installed. | ||
| """ | ||
| config = model_config.copy() | ||
| provider = config.pop("provider") | ||
|
|
||
| class_name = PROVIDER_MAP.get(provider) | ||
| if class_name is None: | ||
| supported = ", ".join(sorted(PROVIDER_MAP.keys())) | ||
| raise ValueError(f"Unknown model provider: '{provider}'. Supported providers: {supported}") | ||
|
|
||
| from .. import models | ||
|
|
||
| model_cls = getattr(models, class_name) | ||
| return model_cls.from_dict(config) | ||
|
|
||
|
|
||
| def config_to_agent(config: str | dict[str, Any], **kwargs: Any) -> Any: | ||
| """Create an Agent from a configuration file or dictionary. | ||
|
|
||
| This function supports tools that can be loaded declaratively (file paths, module names, | ||
|
|
@@ -83,6 +211,12 @@ | |
| Create agent from dictionary: | ||
| >>> config = {"model": "anthropic.claude-3-5-sonnet-20241022-v2:0", "tools": ["calculator"]} | ||
| >>> agent = config_to_agent(config) | ||
|
|
||
| Create agent with object model config: | ||
| >>> config = { | ||
| ... "model": {"provider": "openai", "model_id": "gpt-4o", "client_args": {"api_key": "$OPENAI_API_KEY"}} | ||
| ... } | ||
| >>> agent = config_to_agent(config) | ||
| """ | ||
| # Parse configuration | ||
| if isinstance(config, str): | ||
|
|
@@ -114,11 +248,20 @@ | |
| raise ValueError(f"Configuration validation error at {error_path}: {e.message}") from e | ||
|
|
||
| # Prepare Agent constructor arguments | ||
| agent_kwargs = {} | ||
| agent_kwargs: dict[str, Any] = {} | ||
|
|
||
| # Handle model field — string vs object format | ||
| model_value = config_dict.get("model") | ||
| if isinstance(model_value, dict): | ||
| # Object format: resolve env vars and create Model instance via factory | ||
| resolved_config = _resolve_env_vars(model_value) | ||
| agent_kwargs["model"] = _create_model_from_dict(resolved_config) | ||
| elif model_value is not None: | ||
| # String format (backward compat): pass directly as model_id to Agent | ||
| agent_kwargs["model"] = model_value | ||
|
|
||
| # Map configuration keys to Agent constructor parameters | ||
| # Map remaining configuration keys to Agent constructor parameters | ||
| config_mapping = { | ||
| "model": "model", | ||
| "prompt": "system_prompt", | ||
| "tools": "tools", | ||
| "name": "name", | ||
|
|
||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -133,6 +133,32 @@ class SageMakerAIEndpointConfig(TypedDict, total=False): | |
| target_variant: str | None | None | ||
| additional_args: dict[str, Any] | None | ||
|
|
||
| @classmethod | ||
| def from_dict(cls, config: dict[str, Any]) -> "SageMakerAIModel": | ||
| """Create a SageMakerAIModel from a configuration dictionary. | ||
|
|
||
| Handles extraction of ``endpoint_config``, ``payload_config``, and conversion of | ||
| ``boto_client_config`` from a plain dict to ``botocore.config.Config``. | ||
|
|
||
| Args: | ||
| config: Model configuration dictionary. A copy is made internally; | ||
| the caller's dict is not modified. | ||
|
|
||
| Returns: | ||
| A configured SageMakerAIModel instance. | ||
| """ | ||
| config = config.copy() | ||
| kwargs: dict[str, Any] = {} | ||
| kwargs["endpoint_config"] = config.pop("endpoint_config", {}) | ||
| kwargs["payload_config"] = config.pop("payload_config", {}) | ||
| if "boto_client_config" in config: | ||
| raw = config.pop("boto_client_config") | ||
| kwargs["boto_client_config"] = BotocoreConfig(**raw) if isinstance(raw, dict) else raw | ||
| if config: | ||
| unexpected = ", ".join(sorted(config.keys())) | ||
| raise ValueError(f"Unsupported SageMaker config keys: {unexpected}") | ||
|
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Issue: The new Suggestion: Add a test (in the appropriate model test file) like: def test_sagemaker_from_dict_rejects_unexpected_keys(self):
with pytest.raises(ValueError, match="Unsupported SageMaker config keys"):
SageMakerAIModel.from_dict({
"endpoint_config": {},
"payload_config": {},
"model_id": "unexpected",
}) |
||
| return cls(**kwargs) | ||
|
|
||
| def __init__( | ||
| self, | ||
| endpoint_config: SageMakerAIEndpointConfig, | ||
|
|
||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Issue: The regex
^\$\{([^}]+)\}$|^\$([A-Za-z_][A-Za-z0-9_]*)$only matches full-string env var references (anchored with^and$). This means"prefix-$VAR-suffix"won't be resolved, which may surprise users coming from shell-like environments.Suggestion: This is a reasonable design choice for security and simplicity, but it should be explicitly documented — either in the module docstring or as a comment near the pattern. Something like:
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Addressed in the latest revision — there is now an inline comment above
_ENV_VAR_PATTERNdocumenting this behavior.