jeans/developers.home-assistant
jeans/developers.home-assistant
1
0
Fork 0
mirror of https://github.com/home-assistant/developers.home-assistant.git synced 2025-07-12 20:06:28 +00:00
Code Issues Packages Projects Releases Wiki Activity

Document conversation handle_message method (#2593)

Browse Source 
* Document converstion handle_message method

* Update docs/core/entity/conversation.md

Co-authored-by: Abílio Costa <abmantis@users.noreply.github.com>

* Update conversation.md

---------

Co-authored-by: Abílio Costa <abmantis@users.noreply.github.com>
This commit is contained in:
Paulus Schoutsen 2025-03-10 15:21:37 -04:00 committed by GitHub
parent bb3ca2c5fe
commit 4079f7f67d
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 22 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

27
docs/core/entity/conversation.md
View File

@ -28,21 +28,35 @@ and are combined using the bitwise or (`|`) operator.
## Methods
### Process
### Handle Message
This method is used to process an incoming chat message.
This method is used to handle an incoming chat message.
```python
from homeassistant.components.conversation import ChatLog, ConversationEntity
class MyConversationEntity(ConversationEntity):
"""Represent a conversation entity."""
async def async_process(self, user_input: ConversationInput) -> ConversationResult:
"""Process a sentence."""
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
response=response,
continue_conversation=False,
)
```
@ -54,6 +68,9 @@ A `ConversationInput` object contains the following data:
| `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._
### Prepare