ChannelField
Defined in the protocols module.AI Agent A single configuration field a channel plugin declares about itself. A channel adapter attaches a list of these (via
ChannelDescriptor) so
the gateway can wire its config schema, onboarding wizard, and env-var
fallbacks with zero core edits. Without this, a plugin channel’s own keys
(e.g. IRC’s server / nickserv_password) are silently dropped by the
fixed ChannelConfigSchema under Pydantic’s extra="ignore" default.
Attributes:
name: Config key name (as it appears under channels.<platform>).
required: Whether the field must be provided.
secret: Whether the value is sensitive (masked in prompts/logs).
prompt: Human-friendly prompt shown by the onboarding wizard.
env: Optional environment-variable name used as a fallback source.
Properties
str
No description available.
bool
No description available.
bool
No description available.
str
No description available.
Optional[str]
No description available.
Internal & Generic Methods
Internal & Generic Methods
- to_dict: Convert to dictionary.
Source
View on GitHub
praisonaiagents/bots/protocols.py at line 173