Home Assistant Unofficial Reference 2024.12.1
homeassistant.components.conversation.agent_manager Namespace Reference

Classes

class  AgentManager
 

Functions

str agent_id_validator (Any value)
 
ConversationResult async_converse (HomeAssistant hass, str text, str|None conversation_id, Context context, str|None language=None, str|None agent_id=None, str|None device_id=None)
 
AbstractConversationAgent|ConversationEntity|None async_get_agent (HomeAssistant hass, str|None agent_id=None)
 
AgentManager get_agent_manager (HomeAssistant hass)
 

Variables

 _LOGGER = logging.getLogger(__name__)
 

Detailed Description

Agent foundation for conversation integration.

Function Documentation

◆ agent_id_validator()

str homeassistant.components.conversation.agent_manager.agent_id_validator ( Any  value)
Validate agent ID.

Definition at line 43 of file agent_manager.py.

◆ async_converse()

ConversationResult homeassistant.components.conversation.agent_manager.async_converse ( HomeAssistant  hass,
str  text,
str | None  conversation_id,
Context  context,
str | None   language = None,
str | None   agent_id = None,
str | None   device_id = None 
)
Process text and get intent.

Definition at line 70 of file agent_manager.py.

◆ async_get_agent()

AbstractConversationAgent | ConversationEntity | None homeassistant.components.conversation.agent_manager.async_get_agent ( HomeAssistant  hass,
str | None   agent_id = None 
)
Get specified agent.

Definition at line 52 of file agent_manager.py.

◆ get_agent_manager()

AgentManager homeassistant.components.conversation.agent_manager.get_agent_manager ( HomeAssistant  hass)
Get the active agent.

Definition at line 38 of file agent_manager.py.

Variable Documentation

◆ _LOGGER

homeassistant.components.conversation.agent_manager._LOGGER = logging.getLogger(__name__)
private

Definition at line 33 of file agent_manager.py.