Standardize conversation.async_process method (#140125)

homeassistant/components/anthropic/conversation.py

@@ -30,7 +30,7 @@ from homeassistant.config_entries import ConfigEntry
 from homeassistant.const import CONF_LLM_HASS_API, MATCH_ALL
 from homeassistant.core import HomeAssistant
 from homeassistant.exceptions import HomeAssistantError
-from homeassistant.helpers import chat_session, device_registry as dr, intent, llm
+from homeassistant.helpers import device_registry as dr, intent, llm
 from homeassistant.helpers.entity_platform import AddConfigEntryEntitiesCallback
 
 from . import AnthropicConfigEntry
@@ -226,18 +226,6 @@ class AnthropicConversationEntity(
             self.entry.add_update_listener(self._async_entry_update_listener)
         )
 
-    async def async_process(
-        self, user_input: conversation.ConversationInput
-    ) -> conversation.ConversationResult:
-        """Process a sentence."""
-        with (
-            chat_session.async_get_chat_session(
-                self.hass, user_input.conversation_id
-            ) as session,
-            conversation.async_get_chat_log(self.hass, session, user_input) as chat_log,
-        ):
-            return await self._async_handle_message(user_input, chat_log)
-
     async def _async_handle_message(
         self,
         user_input: conversation.ConversationInput,

homeassistant/components/conversation/default_agent.py

@@ -42,7 +42,6 @@ from homeassistant.components.homeassistant.exposed_entities import (
 from homeassistant.const import EVENT_STATE_CHANGED, MATCH_ALL
 from homeassistant.helpers import (
     area_registry as ar,
-    chat_session,
     device_registry as dr,
     entity_registry as er,
     floor_registry as fr,
@@ -56,7 +55,7 @@ from homeassistant.helpers.event import async_track_state_added_domain
 from homeassistant.util import language as language_util
 from homeassistant.util.json import JsonObjectType, json_loads_object
 
-from .chat_log import AssistantContent, async_get_chat_log
+from .chat_log import AssistantContent, ChatLog
 from .const import (
     DATA_DEFAULT_ENTITY,
     DEFAULT_EXPOSED_ATTRIBUTES,
@@ -332,19 +331,16 @@ class DefaultAgent(ConversationEntity):
 
         return result
 
-    async def async_process(self, user_input: ConversationInput) -> ConversationResult:
+    async def _async_handle_message(
-        """Process a sentence."""
+        self,
+        user_input: ConversationInput,
+        chat_log: ChatLog,
+    ) -> ConversationResult:
+        """Handle a message."""
         response: intent.IntentResponse | None = None
-        with (
+
-            chat_session.async_get_chat_session(
-                self.hass, user_input.conversation_id
-            ) as session,
-            async_get_chat_log(self.hass, session, user_input) as chat_log,
-        ):
         # Check if a trigger matched
-            if trigger_result := await self.async_recognize_sentence_trigger(
+        if trigger_result := await self.async_recognize_sentence_trigger(user_input):
-                user_input
-            ):
             # Process callbacks and get response
             response_text = await self._handle_trigger_result(
                 trigger_result, user_input
@@ -373,7 +369,7 @@ class DefaultAgent(ConversationEntity):
         )
 
         return ConversationResult(
-                response=response, conversation_id=session.conversation_id
+            response=response, conversation_id=chat_log.conversation_id
         )
 
     async def _async_process_intent_result(

homeassistant/components/conversation/entity.py

@@ -4,9 +4,11 @@ from abc import abstractmethod
 from typing import Literal, final
 
 from homeassistant.const import STATE_UNAVAILABLE, STATE_UNKNOWN
+from homeassistant.helpers.chat_session import async_get_chat_session
 from homeassistant.helpers.restore_state import RestoreEntity
 from homeassistant.util import dt as dt_util
 
+from .chat_log import ChatLog, async_get_chat_log
 from .const import ConversationEntityFeature
 from .models import ConversationInput, ConversationResult
 
@@ -51,9 +53,21 @@ class ConversationEntity(RestoreEntity):
     def supported_languages(self) -> list[str] | Literal["*"]:
         """Return a list of supported languages."""
 
-    @abstractmethod
     async def async_process(self, user_input: ConversationInput) -> ConversationResult:
         """Process a sentence."""
+        with (
+            async_get_chat_session(self.hass, user_input.conversation_id) as session,
+            async_get_chat_log(self.hass, session, user_input) as chat_log,
+        ):
+            return await self._async_handle_message(user_input, chat_log)
+
+    async def _async_handle_message(
+        self,
+        user_input: ConversationInput,
+        chat_log: ChatLog,
+    ) -> ConversationResult:
+        """Call the API."""
+        raise NotImplementedError
 
     async def async_prepare(self, language: str | None = None) -> None:
         """Load intents for a language."""

homeassistant/components/google_generative_ai_conversation/conversation.py

@@ -25,7 +25,7 @@ from homeassistant.config_entries import ConfigEntry
 from homeassistant.const import CONF_LLM_HASS_API, MATCH_ALL
 from homeassistant.core import HomeAssistant
 from homeassistant.exceptions import HomeAssistantError
-from homeassistant.helpers import chat_session, device_registry as dr, intent, llm
+from homeassistant.helpers import device_registry as dr, intent, llm
 from homeassistant.helpers.entity_platform import AddConfigEntryEntitiesCallback
 
 from .const import (
@@ -264,18 +264,6 @@ class GoogleGenerativeAIConversationEntity(
         conversation.async_unset_agent(self.hass, self.entry)
         await super().async_will_remove_from_hass()
 
-    async def async_process(
-        self, user_input: conversation.ConversationInput
-    ) -> conversation.ConversationResult:
-        """Process a sentence."""
-        with (
-            chat_session.async_get_chat_session(
-                self.hass, user_input.conversation_id
-            ) as session,
-            conversation.async_get_chat_log(self.hass, session, user_input) as chat_log,
-        ):
-            return await self._async_handle_message(user_input, chat_log)
-
     async def _async_handle_message(
         self,
         user_input: conversation.ConversationInput,

homeassistant/components/ollama/conversation.py

@@ -15,7 +15,7 @@ from homeassistant.config_entries import ConfigEntry
 from homeassistant.const import CONF_LLM_HASS_API, MATCH_ALL
 from homeassistant.core import HomeAssistant
 from homeassistant.exceptions import HomeAssistantError
-from homeassistant.helpers import chat_session, intent, llm
+from homeassistant.helpers import intent, llm
 from homeassistant.helpers.entity_platform import AddConfigEntryEntitiesCallback
 
 from .const import (
@@ -206,18 +206,6 @@ class OllamaConversationEntity(
         """Return a list of supported languages."""
         return MATCH_ALL
 
-    async def async_process(
-        self, user_input: conversation.ConversationInput
-    ) -> conversation.ConversationResult:
-        """Process a sentence."""
-        with (
-            chat_session.async_get_chat_session(
-                self.hass, user_input.conversation_id
-            ) as session,
-            conversation.async_get_chat_log(self.hass, session, user_input) as chat_log,
-        ):
-            return await self._async_handle_message(user_input, chat_log)
-
     async def _async_handle_message(
         self,
         user_input: conversation.ConversationInput,

homeassistant/components/openai_conversation/conversation.py

@@ -24,7 +24,7 @@ from homeassistant.config_entries import ConfigEntry
 from homeassistant.const import CONF_LLM_HASS_API, MATCH_ALL
 from homeassistant.core import HomeAssistant
 from homeassistant.exceptions import HomeAssistantError
-from homeassistant.helpers import chat_session, device_registry as dr, intent, llm
+from homeassistant.helpers import device_registry as dr, intent, llm
 from homeassistant.helpers.entity_platform import AddConfigEntryEntitiesCallback
 
 from . import OpenAIConfigEntry
@@ -223,18 +223,6 @@ class OpenAIConversationEntity(
         conversation.async_unset_agent(self.hass, self.entry)
         await super().async_will_remove_from_hass()
 
-    async def async_process(
-        self, user_input: conversation.ConversationInput
-    ) -> conversation.ConversationResult:
-        """Process a sentence."""
-        with (
-            chat_session.async_get_chat_session(
-                self.hass, user_input.conversation_id
-            ) as session,
-            conversation.async_get_chat_log(self.hass, session, user_input) as chat_log,
-        ):
-            return await self._async_handle_message(user_input, chat_log)
-
     async def _async_handle_message(
         self,
         user_input: conversation.ConversationInput,