Home Assistant Unofficial Reference 2024.12.1
homeassistant.components.conversation.agent_manager.AgentManager Class Reference

Public Member Functions

None __init__ (self, HomeAssistant hass)
 
AbstractConversationAgent|None async_get_agent (self, str agent_id)
 
list[AgentInfoasync_get_agent_info (self)
 
bool async_is_valid_agent_id (self, str agent_id)
 
None async_set_agent (self, str agent_id, AbstractConversationAgent agent)
 
None async_unset_agent (self, str agent_id)
 

Public Attributes

 hass
 

Detailed Description

Class to manage conversation agents.

Definition at line 115 of file agent_manager.py.

Constructor & Destructor Documentation

◆ __init__()

None homeassistant.components.conversation.agent_manager.AgentManager.__init__ (   self,
HomeAssistant  hass 
)
Initialize the conversation agents.

Definition at line 118 of file agent_manager.py.

Member Function Documentation

◆ async_get_agent()

AbstractConversationAgent | None homeassistant.components.conversation.agent_manager.AgentManager.async_get_agent (   self,
str  agent_id 
)
Get the agent.

Definition at line 124 of file agent_manager.py.

◆ async_get_agent_info()

list[AgentInfo] homeassistant.components.conversation.agent_manager.AgentManager.async_get_agent_info (   self)
List all agents.

Definition at line 132 of file agent_manager.py.

◆ async_is_valid_agent_id()

bool homeassistant.components.conversation.agent_manager.AgentManager.async_is_valid_agent_id (   self,
str  agent_id 
)
Check if the agent id is valid.

Definition at line 156 of file agent_manager.py.

◆ async_set_agent()

None homeassistant.components.conversation.agent_manager.AgentManager.async_set_agent (   self,
str  agent_id,
AbstractConversationAgent  agent 
)
Set the agent.

Definition at line 161 of file agent_manager.py.

◆ async_unset_agent()

None homeassistant.components.conversation.agent_manager.AgentManager.async_unset_agent (   self,
str  agent_id 
)
Unset the agent.

Definition at line 166 of file agent_manager.py.

Member Data Documentation

◆ hass

homeassistant.components.conversation.agent_manager.AgentManager.hass

Definition at line 120 of file agent_manager.py.


The documentation for this class was generated from the following file: