Update Assist section for 2024.12 release #36045
Conversation
home-assistant
bot
added
in-progress
|
It seems that this PR is targeted against an incorrect branch. Documentation updates which apply to our current stable release should target the |
✅ Deploy Preview for home-assistant-docs ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
📝 WalkthroughWalkthroughThe changes in this pull request involve updates to the beta release notes for Home Assistant version 2024.12. Key additions include a new section on contributions from language leaders to voice assistant capabilities, rephrased content in the "Voice" section for clarity, and refinements in the "A faster voice experience" section regarding the HASSIL intent parser. The "Revised Integration Quality Scale" section has been clarified, and minor formatting adjustments have been made throughout the document to enhance readability. Changes
Sequence Diagram(s)sequenceDiagram
participant User
participant VoiceAssistant
participant LLM
participant HASSILParser
User->>VoiceAssistant: Issue voice command
VoiceAssistant->>HASSILParser: Process command locally
HASSILParser-->>VoiceAssistant: Return processed command
VoiceAssistant->>LLM: Forward complex queries
LLM-->>VoiceAssistant: Return response
VoiceAssistant-->>User: Provide feedback
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Outside diff range and nitpick comments (3)
source/_posts/2024-12-04-release-202412.markdown (3)
131-144: Grammar and clarity improvements neededSeveral grammatical issues need to be addressed:
- Line 138: "set-up" should be "set up" when used as a verb
- Line 141: "This allow" should be "This allows"
- Line 142: "non" should be "none"
-This choice was an interesting first step. LLMs are generally much smarter and knowledgeable about the world than our built-in intents. However, they are often slow and/or expensive. And let's face it, even if the demos are cool, 90% of the commands we say in our homes are simple _"Turn this on"_, _"Turn that off"_. +This was an important first step. While LLMs are more versatile and knowledgeable than our built-in intents, they can be slow and expensive. In practice, most voice commands in our homes are simple, like _"Turn this on"_ or _"Turn that off"_. -Starting from this release, you can set-up a voice assistant in a way that will target our fast, community driven, built-in intents first, and only fallback to a LLM-based agent if no matches were found. +Starting from this release, you can set up a voice assistant to use our fast, community-driven, built-in intents first, and only fall back to a LLM-based agent if no matches are found. -This allow you to mix the pros of both worlds with almost non of the cons. +This allows you to combine the best of both worlds with almost none of the drawbacks.🧰 Tools
🪛 LanguageTool
[grammar] ~138-~138: The word “set-up” is a noun. The verb is spelled with a space.
Context: ...ds. Starting from this release, you can set-up a voice assistant in a way that will ta...(NOUN_VERB_CONFUSION)
[grammar] ~141-~141: Possible subject-verb agreement error detected.
Context: .../images/blog/2024-12/llm-fallback.png) This allow you to mix the pros of both worlds with...(THIS_THAT_AGR)
[misspelling] ~142-~142: Did you mean “none”?
Context: ...mix the pros of both worlds with almost non of the cons. Specific known commands w...(NON_NONE)
[style] ~144-~144: Consider replacing ‘only’ with a different word to let your writing stand out.
Context: ...emely fast, and the power of a LLM will only be used for more complex queries that H...(ONLY_EXCLUSIVELY_STYLE)
150-161: Improve wording and grammar in language leaders sectionThe section needs refinement in its wording:
- Line 154: "amount of contributions" should be "number of contributions"
- Line 154: "contributions on our" should be "contributions to our"
-The amount of contributions on our [intents repository] (where we store the supported sentences) skyrocketed during the last month. +The number of contributions to our [intents repository] (where we store the supported sentences) has skyrocketed over the last month. -More and more language are becoming usable, or even complete! +More and more languages are becoming usable, or even complete!🧰 Tools
🪛 LanguageTool
[uncategorized] ~154-~154: ‘Amount of’ should usually only be used with uncountable or mass nouns. Consider using “number” if this is not the case.
Context: ...mely hard to polish their language. The amount of contributions on our [intents reposi...(AMOUNTOF_TO_NUMBEROF)
[grammar] ~154-~154: The usual preposition for “contribution” is “to”. Did you mean “contributions to”?
Context: ...to polish their language. The amount of contributions on our [intents repository] (where we stor...(ON_THE_NOVEL)
Line range hint
1-24: Address remaining TODO commentsSeveral TODO items need to be addressed before the final release:
- Introduction paragraph in the Voice section
- Demonstration videos in multiple sections
- Processing of potential changes (noted in the "Potential changes to process" section)
Would you like me to help create GitHub issues to track these remaining tasks?
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
⛔ Files ignored due to path filters (1)
source/images/blog/2024-12/llm-fallback.pngis excluded by!**/*.png
📒 Files selected for processing (1)
source/_posts/2024-12-04-release-202412.markdown(2 hunks)
🧰 Additional context used
🪛 LanguageTool
source/_posts/2024-12-04-release-202412.markdown
[grammar] ~138-~138: The word “set-up” is a noun. The verb is spelled with a space.
Context: ...ds. Starting from this release, you can set-up a voice assistant in a way that will ta...
(NOUN_VERB_CONFUSION)
[grammar] ~141-~141: Possible subject-verb agreement error detected.
Context: .../images/blog/2024-12/llm-fallback.png) This allow you to mix the pros of both worlds with...
(THIS_THAT_AGR)
[misspelling] ~142-~142: Did you mean “none”?
Context: ...mix the pros of both worlds with almost non of the cons. Specific known commands w...
(NON_NONE)
[style] ~144-~144: Consider replacing ‘only’ with a different word to let your writing stand out.
Context: ...emely fast, and the power of a LLM will only be used for more complex queries that H...
(ONLY_EXCLUSIVELY_STYLE)
[uncategorized] ~154-~154: ‘Amount of’ should usually only be used with uncountable or mass nouns. Consider using “number” if this is not the case.
Context: ...mely hard to polish their language. The amount of contributions on our [intents reposi...
(AMOUNTOF_TO_NUMBEROF)
[grammar] ~154-~154: The usual preposition for “contribution” is “to”. Did you mean “contributions to”?
Context: ...to polish their language. The amount of contributions on our [intents repository] (where we stor...
(ON_THE_NOVEL)
[style] ~170-~170: ‘On top of that’ might be wordy. Consider a shorter alternative.
Context: ...ered the way we are matching sentences. On top of that, language leaders spent some time reduc...
(EN_WORDINESS_PREMIUM_ON_TOP_OF_THAT)
🔇 Additional comments (1)
source/_posts/2024-12-04-release-202412.markdown (1)
165-173: Add specific performance metrics and demonstration video
The section would benefit from:
- Specific performance metrics showing the improvement (e.g., "Processing time reduced from X to Y seconds")
- The demonstration video needs to be added (TODO on line 175)
Would you like me to help create a GitHub issue to track the addition of the demonstration video?
🧰 Tools
🪛 LanguageTool
[style] ~170-~170: ‘On top of that’ might be wordy. Consider a shorter alternative.
Context: ...ered the way we are matching sentences. On top of that, language leaders spent some time reduc...
(EN_WORDINESS_PREMIUM_ON_TOP_OF_THAT)
Co-authored-by: Michael Hansen <[email protected]>
Co-authored-by: Michael Hansen <[email protected]>
Co-authored-by: Michael Hansen <[email protected]>
Co-authored-by: Michael Hansen <[email protected]>
Co-authored-by: Michael Hansen <[email protected]>
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Outside diff range and nitpick comments (4)
source/_posts/2024-12-04-release-202412.markdown (4)
138-138: Fix grammar: "set-up" should be "set up" when used as a verbThe word "set-up" is a noun, while "set up" is the correct verb form.
-Starting from this release, you can set-up a voice assistant +Starting from this release, you can set up a voice assistant🧰 Tools
🪛 LanguageTool
[grammar] ~138-~138: The word “set-up” is a noun. The verb is spelled with a space.
Context: ...ds. Starting from this release, you can set-up a voice assistant in a way that will ta...(NOUN_VERB_CONFUSION)
142-142: Fix subject-verb agreementThe singular subject "This" requires the verb "allows".
-This allow you to mix the pros of both worlds +This allows you to mix the pros of both worlds
154-154: Improve word choice and preposition usageTwo improvements needed:
- Use "number of" instead of "amount of" when referring to countable items
- Use "contributions to" instead of "contributions on"
-The amount of contributions on our [intents repository] +The number of contributions to our [intents repository]🧰 Tools
🪛 LanguageTool
[uncategorized] ~154-~154: ‘Amount of’ should usually only be used with uncountable or mass nouns. Consider using “number” if this is not the case.
Context: ...mely hard to polish their language. The amount of contributions on our [intents reposi...(AMOUNTOF_TO_NUMBEROF)
[grammar] ~154-~154: The usual preposition for “contribution” is “to”. Did you mean “contributions to”?
Context: ...to polish their language. The amount of contributions on our [intents repository] (where we stor...(ON_THE_NOVEL)
144-144: Address remaining TODO placeholdersThe following TODO items need to be completed before the final release:
- Video demonstration for LLM fallback feature
- Video demonstration for faster voice experience
Would you like me to help create a structured outline for these demonstration videos?
Also applies to: 177-177
🧰 Tools
🪛 LanguageTool
[style] ~144-~144: Consider replacing ‘only’ with a different word to let your writing stand out.
Context: ...emely fast, and the power of a LLM will only be used for more complex queries that H...(ONLY_EXCLUSIVELY_STYLE)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
📒 Files selected for processing (1)
source/_posts/2024-12-04-release-202412.markdown(2 hunks)
🧰 Additional context used
🪛 LanguageTool
source/_posts/2024-12-04-release-202412.markdown
[grammar] ~138-~138: The word “set-up” is a noun. The verb is spelled with a space.
Context: ...ds. Starting from this release, you can set-up a voice assistant in a way that will ta...
(NOUN_VERB_CONFUSION)
[grammar] ~141-~141: Possible subject-verb agreement error detected.
Context: .../images/blog/2024-12/llm-fallback.png) This allow you to mix the pros of both worlds with...
(THIS_THAT_AGR)
[style] ~144-~144: Consider replacing ‘only’ with a different word to let your writing stand out.
Context: ...emely fast, and the power of a LLM will only be used for more complex queries that H...
(ONLY_EXCLUSIVELY_STYLE)
[uncategorized] ~154-~154: ‘Amount of’ should usually only be used with uncountable or mass nouns. Consider using “number” if this is not the case.
Context: ...mely hard to polish their language. The amount of contributions on our [intents reposi...
(AMOUNTOF_TO_NUMBEROF)
[grammar] ~154-~154: The usual preposition for “contribution” is “to”. Did you mean “contributions to”?
Context: ...to polish their language. The amount of contributions on our [intents repository] (where we stor...
(ON_THE_NOVEL)
[uncategorized] ~170-~170: This verb may not be in the correct tense. Consider changing the tense to fit the context better.
Context: ..., we completely reengineered the way we are matching sentences. On top of that, language lea...
(AI_EN_LECTOR_REPLACEMENT_VERB_TENSE)
[style] ~170-~170: ‘On top of that’ might be wordy. Consider a shorter alternative.
Context: ...ered the way we are matching sentences. On top of that, language leaders spent some time reduc...
(EN_WORDINESS_PREMIUM_ON_TOP_OF_THAT)
🔇 Additional comments (2)
source/_posts/2024-12-04-release-202412.markdown (2)
170-171: Improve technical clarity and grammar
Two improvements needed:
- Fix verb tense
- Consider adding specific performance metrics
-we completely reengineered the way we are matching sentences.
+we completely reengineered the way we match sentences.Could you provide specific performance metrics for the sentence matching improvements? This would help users understand the magnitude of the optimization.
🧰 Tools
🪛 LanguageTool
[uncategorized] ~170-~170: This verb may not be in the correct tense. Consider changing the tense to fit the context better.
Context: ..., we completely reengineered the way we are matching sentences. On top of that, language lea...
(AI_EN_LECTOR_REPLACEMENT_VERB_TENSE)
[style] ~170-~170: ‘On top of that’ might be wordy. Consider a shorter alternative.
Context: ...ered the way we are matching sentences. On top of that, language leaders spent some time reduc...
(EN_WORDINESS_PREMIUM_ON_TOP_OF_THAT)
152-152: Consider rephrasing the hardware announcement
The current phrasing about hardware coming "very soon" might set specific expectations. Consider a more general statement unless there's a confirmed release date.
✅ Verification successful
Based on the extensive search results, I can see that this line is part of a blog post announcing upcoming hardware, specifically voice assistant hardware. The context shows that Home Assistant has been working on voice capabilities throughout 2023 (Year of the Voice) and into 2024, with multiple "chapters" of voice-related features and improvements. The hardware announcement appears to be intentional and part of a planned rollout.
The hardware announcement is appropriate to keep
The current phrasing about hardware coming "very soon" is actually accurate and intentional, as evidenced by:
- Multiple references in the search results about upcoming voice hardware
- A teaser image shown in the 2024 H2 roadmap post
- Consistent messaging about voice hardware development throughout the codebase
- The announcement being part of an official release notes post
🏁 Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash
# Check if there are any official announcements or confirmed dates
gh issue list -R home-assistant/core -l "hardware" --json title,body -q '.[].title'
Length of output: 83
Script:
#!/bin/bash
# Let's check the blog post content for any other mentions of hardware announcements
rg -i "hardware" "source/_posts/2024-12-04-release-202412.markdown"
# Also check recent blog posts for hardware-related announcements
fd "202[34].*\.markdown$" source/_posts/ -x rg -i "hardware|voice" {}
Length of output: 108892
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Outside diff range and nitpick comments (3)
source/_posts/2024-12-04-release-202412.markdown (3)
128-129: Fix grammar issues in the Voice sectionSeveral grammar issues need to be addressed:
- Lines 128-129: Replace "let" with "allow" for better clarity
- Line 138: "set-up" should be "set up" when used as a verb
- Line 142: "allow" should be "allows" to agree with the singular subject "This"
-wonderful (and scary) world of LLMs. We allowed you to let an LLM agent control +wonderful (and scary) world of LLMs. We allowed you to allow an LLM agent to control -Starting from this release, you can set-up a voice assistant +Starting from this release, you can set up a voice assistant -This allow you to mix the pros of both worlds +This allows you to mix the pros of both worldsAlso applies to: 138-138, 142-142
154-154: Improve technical writing in the Language leaders sectionThe sentence structure needs improvement:
- Use "number of" instead of "amount of" when referring to countable contributions
- Use "to" instead of "on" when referring to contributions to a repository
-The amount of contributions on our [intents repository] +The number of contributions to our [intents repository]🧰 Tools
🪛 LanguageTool
[uncategorized] ~154-~154: ‘Amount of’ should usually only be used with uncountable or mass nouns. Consider using “number” if this is not the case.
Context: ...mely hard to polish their language. The amount of contributions on our [intents reposi...(AMOUNTOF_TO_NUMBEROF)
[grammar] ~154-~154: The usual preposition for “contribution” is “to”. Did you mean “contributions to”?
Context: ...to polish their language. The amount of contributions on our [intents repository] (where we stor...(ON_THE_NOVEL)
170-171: Improve technical clarity in the HASSIL sectionThe description could be more concise and technically precise:
-This release adds a lot of love to HASSIL, we completely reengineered the way we are matching sentences. -On top of that, language leaders spent some time reducing the complexity of their sentences, +This release significantly improves HASSIL's performance through a complete reengineering of sentence matching. +Additionally, language leaders optimized sentence patterns,🧰 Tools
🪛 LanguageTool
[style] ~170-~170: ‘On top of that’ might be wordy. Consider a shorter alternative.
Context: ...ered the way we are matching sentences. On top of that, language leaders spent some time reduc...(EN_WORDINESS_PREMIUM_ON_TOP_OF_THAT)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
📒 Files selected for processing (1)
source/_posts/2024-12-04-release-202412.markdown(2 hunks)
🧰 Additional context used
🪛 LanguageTool
source/_posts/2024-12-04-release-202412.markdown
[grammar] ~138-~138: The word “set-up” is a noun. The verb is spelled with a space.
Context: ...ds. Starting from this release, you can set-up a voice assistant in a way that will ta...
(NOUN_VERB_CONFUSION)
[grammar] ~141-~141: Possible subject-verb agreement error detected.
Context: .../images/blog/2024-12/llm-fallback.png) This allow you to mix the pros of both worlds with...
(THIS_THAT_AGR)
[style] ~144-~144: Consider replacing ‘only’ with a different word to let your writing stand out.
Context: ...mely fast, and the power of an LLM will only be used for more complex queries that H...
(ONLY_EXCLUSIVELY_STYLE)
[uncategorized] ~154-~154: ‘Amount of’ should usually only be used with uncountable or mass nouns. Consider using “number” if this is not the case.
Context: ...mely hard to polish their language. The amount of contributions on our [intents reposi...
(AMOUNTOF_TO_NUMBEROF)
[grammar] ~154-~154: The usual preposition for “contribution” is “to”. Did you mean “contributions to”?
Context: ...to polish their language. The amount of contributions on our [intents repository] (where we stor...
(ON_THE_NOVEL)
[style] ~170-~170: ‘On top of that’ might be wordy. Consider a shorter alternative.
Context: ...ered the way we are matching sentences. On top of that, language leaders spent some time reduc...
(EN_WORDINESS_PREMIUM_ON_TOP_OF_THAT)
Proposed change
Update the Assist section on the 2024.12 release notes.
Type of change
currentbranch).currentbranch).nextbranch).nextbranch).Additional information
Checklist
currentbranch.nextbranch.Summary by CodeRabbit
New Features
Improvements
Documentation