Conversation entity

A conversation entity allows users to converse with Home Assistant.

A conversation entity is derived from the homeassistant.components.conversation.ConversationEntity.

Properties

tip

Properties should always only return information from memory and not do I/O (like network requests).

Name	Type	Default	Description
supported_languages	list[str] | Literal["*"]	Required	The supported languages of the service. Return "*" if you support all.

Supported features

Supported features are defined by using values in the ConversationEntityFeature enum and are combined using the bitwise or (|) operator.

Value	Description
CONTROL	The entity is able to control Home Assistant.

Methods

Handle Message

This method is used to handle an incoming chat message.

from homeassistant.components.conversation import ChatLog, ConversationEntity

class MyConversationEntity(ConversationEntity):
    """Represent a conversation entity."""

    async def _async_handle_message(
        self,
        user_input: ConversationInput,
        chat_log: ChatLog,
    ) -> ConversationResult:
        """Call the API."""
        # Add the response to the chat log.
        chat_log.async_add_assistant_content_without_tools(
            AssistantContent(
                agent_id=user_input.agent_id,
                content="Test response",
            )
        )
        response = intent.IntentResponse(language=user_input.language)
        response.async_set_speech("Test response")
        return agent.ConversationResult(
            conversation_id=None,
            response=response,
            continue_conversation=False,
        )

A ConversationInput object contains the following data:

Name	Type	Description
text	str	User input
context	Context	HA context to attach to actions in HA
conversation_id	Optional[str]	Can be used to track a multi-turn conversation. Return None if not supported
language	str	Language of the text. If user did not provide one, it's set to the HA configured language.
continue_conversation	bool	If the agent expects the user to respond. If not set, it's assumed to be False.

We used to promote async_process as the method to process messages. This was changed to _async_handle_message to automatically include the chat log. The change is backwards compatible.

Chat log

The chat log object allows the conversation entity to read the conversation history and to add messages and tool calls to it.

See the Python interface for the full typed API.

Prepare

As soon as Home Assistant knows a request is coming in, we will let the conversation entity prepare for it. This can be used to load a language model or other resources. This function is optional to implement.

class MyConversationEntity(ConversationEntity):
    """Represent a conversation entity."""

    async def async_prepare(self, language: str | None = None) -> None:
        """Prepare a language for processing."""