mirror of
https://github.com/OpenHands/OpenHands.git
synced 2025-12-26 05:48:36 +08:00
50d4c79094
Co-authored-by: openhands <openhands@all-hands.dev> Co-authored-by: Engel Nyst <enyst@users.noreply.github.com> Co-authored-by: Engel Nyst <engel.nyst@gmail.com>
109 lines
4.8 KiB
Python
109 lines
4.8 KiB
Python
from __future__ import annotations
|
|
|
|
from pydantic import BaseModel, Field, ValidationError
|
|
|
|
from openhands.core.config.condenser_config import CondenserConfig, NoOpCondenserConfig
|
|
from openhands.core.config.extended_config import ExtendedConfig
|
|
from openhands.core.logger import openhands_logger as logger
|
|
|
|
|
|
class AgentConfig(BaseModel):
|
|
llm_config: str | None = Field(default=None)
|
|
"""The name of the llm config to use. If specified, this will override global llm config."""
|
|
classpath: str | None = Field(default=None)
|
|
"""The classpath of the agent to use. To be used for custom agents that are not defined in the openhands.agenthub package."""
|
|
enable_browsing: bool = Field(default=True)
|
|
"""Whether to enable browsing tool.
|
|
Note: If using CLIRuntime, browsing is not implemented and should be disabled."""
|
|
enable_llm_editor: bool = Field(default=False)
|
|
"""Whether to enable LLM editor tool"""
|
|
enable_editor: bool = Field(default=True)
|
|
"""Whether to enable the standard editor tool (str_replace_editor), only has an effect if enable_llm_editor is False."""
|
|
enable_jupyter: bool = Field(default=True)
|
|
"""Whether to enable Jupyter tool.
|
|
Note: If using CLIRuntime, Jupyter use is not implemented and should be disabled."""
|
|
enable_cmd: bool = Field(default=True)
|
|
"""Whether to enable bash tool"""
|
|
enable_think: bool = Field(default=True)
|
|
"""Whether to enable think tool"""
|
|
enable_finish: bool = Field(default=True)
|
|
"""Whether to enable finish tool"""
|
|
enable_prompt_extensions: bool = Field(default=True)
|
|
"""Whether to enable prompt extensions"""
|
|
enable_mcp: bool = Field(default=True)
|
|
"""Whether to enable MCP tools"""
|
|
disabled_microagents: list[str] = Field(default_factory=list)
|
|
"""A list of microagents to disable (by name, without .py extension, e.g. ["github", "lint"]). Default is None."""
|
|
enable_history_truncation: bool = Field(default=True)
|
|
"""Whether history should be truncated to continue the session when hitting LLM context length limit."""
|
|
enable_som_visual_browsing: bool = Field(default=True)
|
|
"""Whether to enable SoM (Set of Marks) visual browsing."""
|
|
condenser: CondenserConfig = Field(
|
|
default_factory=lambda: NoOpCondenserConfig(type='noop')
|
|
)
|
|
extended: ExtendedConfig = Field(default_factory=lambda: ExtendedConfig({}))
|
|
"""Extended configuration for the agent."""
|
|
|
|
model_config = {'extra': 'forbid'}
|
|
|
|
@classmethod
|
|
def from_toml_section(cls, data: dict) -> dict[str, AgentConfig]:
|
|
"""
|
|
Create a mapping of AgentConfig instances from a toml dictionary representing the [agent] section.
|
|
|
|
The default configuration is built from all non-dict keys in data.
|
|
Then, each key with a dict value is treated as a custom agent configuration, and its values override
|
|
the default configuration.
|
|
|
|
Example:
|
|
Apply generic agent config with custom agent overrides, e.g.
|
|
[agent]
|
|
enable_prompt_extensions = false
|
|
[agent.BrowsingAgent]
|
|
enable_prompt_extensions = true
|
|
results in prompt_extensions being true for BrowsingAgent but false for others.
|
|
|
|
Returns:
|
|
dict[str, AgentConfig]: A mapping where the key "agent" corresponds to the default configuration
|
|
and additional keys represent custom configurations.
|
|
"""
|
|
|
|
# Initialize the result mapping
|
|
agent_mapping: dict[str, AgentConfig] = {}
|
|
|
|
# Extract base config data (non-dict values)
|
|
base_data = {}
|
|
custom_sections: dict[str, dict] = {}
|
|
for key, value in data.items():
|
|
if isinstance(value, dict):
|
|
custom_sections[key] = value
|
|
else:
|
|
base_data[key] = value
|
|
|
|
# Try to create the base config
|
|
try:
|
|
base_config = cls.model_validate(base_data)
|
|
agent_mapping['agent'] = base_config
|
|
except ValidationError as e:
|
|
logger.warning(f'Invalid base agent configuration: {e}. Using defaults.')
|
|
# If base config fails, create a default one
|
|
base_config = cls()
|
|
# Still add it to the mapping
|
|
agent_mapping['agent'] = base_config
|
|
|
|
# Process each custom section independently
|
|
for name, overrides in custom_sections.items():
|
|
try:
|
|
# Merge base config with overrides
|
|
merged = {**base_config.model_dump(), **overrides}
|
|
custom_config = cls.model_validate(merged)
|
|
agent_mapping[name] = custom_config
|
|
except ValidationError as e:
|
|
logger.warning(
|
|
f'Invalid agent configuration for [{name}]: {e}. This section will be skipped.'
|
|
)
|
|
# Skip this custom section but continue with others
|
|
continue
|
|
|
|
return agent_mapping
|