agents
Class info¶
Classes¶
| Name | Children | Inherits |
|---|---|---|
| AgentConfig llmling_agent.models.agents Configuration for a single agent in the system. |
|
|
| BasePrompt llmling_agent.prompts.prompts Base class for all prompts. |
||
BaseToolConfigllmling_agent_config.tools Base configuration for agent tools. |
|
|
Knowledgellmling_agent_config.knowledge Collection of context sources for an agent. |
||
MemoryConfigllmling_agent_config.session Configuration for agent memory and history handling. |
||
NodeConfigllmling_agent_config.nodes Configuration for a Node of the messaging system. |
|
|
| PromptMessage llmling_agent.prompts.prompts A message in a prompt template. |
||
SessionQueryllmling_agent_config.session Query configuration for session recovery. |
||
| StaticPrompt llmling_agent.prompts.prompts Static prompt defined by message list. |
||
| StaticResourceProvider llmling_agent.resource_providers.static Provider for pre-configured tools, prompts and resources. |
||
StructuredResponseConfigllmling_agent_config.output_types Base class for response definitions. |
🛈 DocStrings¶
Models for agent configuration.
AgentConfig
¶
Bases: NodeConfig
Configuration for a single agent in the system.
Defines an agent's complete configuration including its model, environment, and behavior settings.
Docs: https://phil65.github.io/llmling-agent/YAML%20Configuration/agent_configuration/
Source code in src/llmling_agent/models/agents.py
43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 | |
avatar
class-attribute
instance-attribute
¶
avatar: str | None = Field(
default=None,
examples=["https://example.com/avatar.png", "/assets/robot.jpg"],
title="Avatar image",
)
URL or path to agent's avatar image
config_file_path
class-attribute
instance-attribute
¶
config_file_path: str | None = Field(
default=None,
examples=["/path/to/config.yml", "configs/agent.yaml"],
title="Configuration file path",
)
Config file path for resolving environment.
debug
class-attribute
instance-attribute
¶
debug: bool = Field(default=False, title='Debug mode')
Enable debug output for this agent.
end_strategy
class-attribute
instance-attribute
¶
end_strategy: EndStrategy = Field(
default="early", examples=["early", "exhaust"], title="Tool execution strategy"
)
The strategy for handling multiple tool calls when a final result is found
inherits
class-attribute
instance-attribute
¶
inherits: str | None = Field(default=None, title='Inheritance source')
Name of agent config to inherit from
knowledge
class-attribute
instance-attribute
¶
knowledge: Knowledge | None = Field(
default=None,
title="Knowledge sources",
json_schema_extra={
"documentation_url": "https://phil65.github.io/llmling-agent/YAML%20Configuration/knowledge_configuration/"
},
)
Knowledge sources for this agent.
Docs: https://phil65.github.io/llmling-agent/YAML%20Configuration/knowledge_configuration/
model
class-attribute
instance-attribute
¶
model: str | ModelName | AnyModelConfig | None = Field(
default=None,
examples=["openai:gpt-5-nano"],
title="Model configuration or name",
json_schema_extra={
"documentation_url": "https://phil65.github.io/llmling-agent/YAML%20Configuration/model_configuration/"
},
)
The model to use for this agent. Can be either a simple model name string (e.g. 'openai:gpt-5') or a structured model definition.
Docs: https://phil65.github.io/llmling-agent/YAML%20Configuration/model_configuration/
output_retries
class-attribute
instance-attribute
¶
output_retries: int | None = Field(default=None, examples=[1, 3], title='Output retries')
Max retries for result validation
output_type
class-attribute
instance-attribute
¶
output_type: str | StructuredResponseConfig | None = Field(
default=None,
examples=["json_response", "code_output"],
title="Response type",
json_schema_extra={
"documentation_url": "https://phil65.github.io/llmling-agent/YAML%20Configuration/response_configuration/"
},
)
Name of the response definition to use.
Docs: https://phil65.github.io/llmling-agent/YAML%20Configuration/response_configuration/
requires_tool_confirmation
class-attribute
instance-attribute
¶
requires_tool_confirmation: ToolConfirmationMode = Field(
default="per_tool", examples=["always", "never", "per_tool"], title="Tool confirmation mode"
)
How to handle tool confirmation: - "always": Always require confirmation for all tools - "never": Never require confirmation (ignore tool settings) - "per_tool": Use individual tool settings
retries
class-attribute
instance-attribute
¶
retries: int = Field(default=1, ge=0, examples=[1, 3], title='Model retries')
Number of retries for failed operations (maps to pydantic-ai's retries)
session
class-attribute
instance-attribute
¶
session: str | SessionQuery | MemoryConfig | None = Field(
default=None,
examples=["main_session", "user_123"],
title="Session configuration",
json_schema_extra={
"documentation_url": "https://phil65.github.io/llmling-agent/YAML%20Configuration/session_configuration/"
},
)
Session configuration for conversation recovery.
Docs: https://phil65.github.io/llmling-agent/YAML%20Configuration/session_configuration/
system_prompts
class-attribute
instance-attribute
¶
system_prompts: Sequence[str | PromptConfig] = Field(
default_factory=list,
title="System prompts",
examples=[["You are an AI assistant."]],
json_schema_extra={
"documentation_url": "https://phil65.github.io/llmling-agent/YAML%20Configuration/system_prompts_configuration/"
},
)
System prompts for the agent. Can be strings or structured prompt configs.
Docs: https://phil65.github.io/llmling-agent/YAML%20Configuration/system_prompts_configuration/
tool_mode
class-attribute
instance-attribute
¶
tool_mode: ToolMode | None = Field(default=None, examples=["codemode"], title="Tool execution mode")
Tool execution mode: - None: Default mode - tools are called directly - "codemode": Tools are wrapped in a Python execution environment
tools
class-attribute
instance-attribute
¶
tools: list[ToolConfig | str] = Field(
default_factory=list,
examples=[
["webbrowser:open", "builtins:print"],
[{"type": "import", "import_path": "webbrowser:open", "name": "web_browser"}],
],
title="Tool configurations",
json_schema_extra={
"documentation_url": "https://phil65.github.io/llmling-agent/YAML%20Configuration/tool_configuration/"
},
)
A list of tools to register with this agent.
Docs: https://phil65.github.io/llmling-agent/YAML%20Configuration/tool_configuration/
toolsets
class-attribute
instance-attribute
¶
toolsets: list[ToolsetConfig] = Field(
default_factory=list,
examples=[
[
{"type": "openapi", "spec": "https://api.example.com/openapi.json", "namespace": "api"},
{"type": "file_access"},
{"type": "composio", "user_id": "user123@example.com", "toolsets": ["github", "slack"]},
]
],
title="Toolset configurations",
json_schema_extra={
"documentation_url": "https://phil65.github.io/llmling-agent/YAML%20Configuration/toolset_configuration/"
},
)
Toolset configurations for extensible tool collections.
Docs: https://phil65.github.io/llmling-agent/YAML%20Configuration/toolset_configuration/
usage_limits
class-attribute
instance-attribute
¶
usage_limits: UsageLimits | None = Field(default=None, title='Usage limits')
Usage limits for this agent.
workers
class-attribute
instance-attribute
¶
workers: list[WorkerConfig] = Field(
default_factory=list,
examples=[
[{"type": "agent", "name": "web_agent", "reset_history_on_run": True}],
[{"type": "team", "name": "analysis_team"}],
],
title="Worker agents",
json_schema_extra={
"documentation_url": "https://phil65.github.io/llmling-agent/YAML%20Configuration/worker_configuration/"
},
)
Worker agents which will be available as tools.
Docs: https://phil65.github.io/llmling-agent/YAML%20Configuration/worker_configuration/
get_session_config
¶
get_session_config() -> MemoryConfig
Get resolved memory configuration.
Source code in src/llmling_agent/models/agents.py
342 343 344 345 346 347 348 349 350 351 352 353 354 355 | |
get_system_prompts
¶
get_system_prompts() -> list[BasePrompt]
Get all system prompts as BasePrompts.
Source code in src/llmling_agent/models/agents.py
357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 | |
get_tool_provider
¶
get_tool_provider() -> ResourceProvider | None
Get tool provider for this agent.
Source code in src/llmling_agent/models/agents.py
313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 | |
get_toolsets
¶
get_toolsets() -> list[ResourceProvider]
Get all resource providers for this agent.
Source code in src/llmling_agent/models/agents.py
297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 | |
handle_model_types
classmethod
¶
handle_model_types(data: dict[str, Any]) -> dict[str, Any]
Convert model inputs to appropriate format.
Source code in src/llmling_agent/models/agents.py
289 290 291 292 293 294 295 | |
is_structured
¶
is_structured() -> bool
Check if this config defines a structured agent.
Source code in src/llmling_agent/models/agents.py
259 260 261 | |
render_system_prompts
¶
render_system_prompts(context: dict[str, Any] | None = None) -> list[str]
Render system prompts with context.
Source code in src/llmling_agent/models/agents.py
424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 | |
validate_output_type
classmethod
¶
validate_output_type(data: dict[str, Any]) -> dict[str, Any]
Convert result type and apply its settings.
Source code in src/llmling_agent/models/agents.py
263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 | |