Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add LLM explainer in the release notes 2024.6 #33091

Merged

Conversation

jlpouffier
Copy link
Contributor

@jlpouffier jlpouffier commented Jun 5, 2024

Proposed change

Add an explainer paragraph on the 2024.6 release note that explains a bit the magic behind LLMs. What they tap into, what data they have access to.

Type of change

  • Spelling, grammar or other readability improvements (current branch).
  • Adjusted missing or incorrect information in the current documentation (current branch).
  • Added documentation for a new integration I'm adding to Home Assistant (next branch).
  • Added documentation for a new feature I'm adding to Home Assistant (next branch).
  • Removed stale or deprecated documentation.

Additional information

  • Link to parent pull request in the codebase: NOT APPLICABLE
  • Link to parent pull request in the Brands repository: NOT APPLICABLE
  • This PR fixes or closes issue: NOT APPLICABLE

Checklist

  • This PR uses the correct branch, based on one of the following:
    • I made a change to the existing documentation and used the current branch.
    • I made a change that is related to an upcoming version of Home Assistant and used the next branch.
  • The documentation follows the Home Assistant documentation standards.

Summary by CodeRabbit

  • New Features

    • Introduced a new setting for LLM-based conversation agents to use the intent system, enhancing their ability to understand complex commands and reasoning.
    • Enabled custom integrations and user-defined intents, allowing users to guide agents beyond default functionalities.
  • Improvements

    • Updated OpenAI and Google AI integrations with recommended model settings for better accuracy, speed, and cost-effectiveness.
    • Added a sample custom intent configuration to help users define specific actions for agents.
  • Upcoming

    • A blog post will be released to explore the research behind the recommended model settings and their performance benefits.

@home-assistant
Copy link

home-assistant bot commented Jun 5, 2024

It seems that this PR is targeted against an incorrect branch. Documentation updates which apply to our current stable release should target the current branch. Please change the target branch of this PR to current and rebase if needed. If this is documentation for a new feature, please add a link to that PR in your description.

@home-assistant home-assistant bot added in-progress This PR/Issue is currently being worked on needs-rebase The PR has been branched of the wrong base branch or targets an incorrect target branch rc This PR is against the RC branch labels Jun 5, 2024
@jlpouffier jlpouffier marked this pull request as draft June 5, 2024 11:48
Copy link
Contributor

coderabbitai bot commented Jun 5, 2024

Warning

Review failed

The pull request is closed.

Walkthrough

The latest update enhances LLM-based conversation agents by integrating them with the intent system powering Assist, allowing for more sophisticated commands and reasoning capabilities. It introduces extensibility for custom integrations and user-defined intents, improving functionality beyond default commands. Additionally, recommended model settings for OpenAI and Google AI integrations have been updated for better performance, accuracy, speed, and cost-effectiveness. A sample custom intent configuration in YAML format is included to guide users.

Changes

File(s) Change Summary
source/_posts/2024-06-05-release-20246... Added a new setting for LLM-based agents to use the intent system of Assist for advanced commands.
... Introduced extensibility to intent system for custom integrations and user-defined intents.
... Included a sample custom intent configuration in YAML format.
... Updated OpenAI and Google AI integrations with recommended model settings for improved performance.
... Detailed the performance and cost-effectiveness of recommended model settings for voice assistant tasks.

Sequence Diagram(s) (Beta)

sequenceDiagram
    participant User
    participant LLM_Agent
    participant Intent_System
    participant Custom_Integration

    User->>LLM_Agent: Issue Command
    LLM_Agent->>Intent_System: Process Command
    Intent_System->>Custom_Integration: Trigger Custom Intent
    Custom_Integration-->>Intent_System: Execute Action
    Intent_System-->>LLM_Agent: Return Result
    LLM_Agent-->>User: Provide Response
Loading

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?

Share
Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai generate interesting stats about this repository and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

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 as PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Copy link

netlify bot commented Jun 5, 2024

Deploy Preview for home-assistant-docs ready!

Name Link
🔨 Latest commit b410075
🔍 Latest deploy log https://app.netlify.com/sites/home-assistant-docs/deploys/66605adf59fc9100080fc0ce
😎 Deploy Preview https://deploy-preview-33091--home-assistant-docs.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 3

Outside diff range comments (6)
source/_posts/2024-06-05-release-20246.markdown (6)

Line range hint 162-162: Ensure sentences start with a capital letter.

- it is available directly in the section configuration, in the visibility tab
+ It is available directly in the section configuration, in the visibility tab

This change corrects the sentence to start with a capital letter, following proper grammar rules.

Tools
LanguageTool

[misspelling] ~91-~91: Only proper nouns start with an uppercase character (there are exceptions for headlines). (EN_UPPER_CASE_NGRAM)
Context: ...our intent system, which is what powers Assist. They also get access to every entity e...


[misspelling] ~91-~91: Only proper nouns start with an uppercase character (there are exceptions for headlines). (EN_UPPER_CASE_NGRAM)
Context: ...o get access to every entity exposed to Assist. That way, you can control what you giv...


[style] ~91-~91: Try using a synonym here to strengthen your writing. (GIVE_PROVIDE)
Context: ...ist. That way, you can control what you give access to your assistants. Tapping int...


[misspelling] ~94-~94: Only proper nouns start with an uppercase character (there are exceptions for headlines). (EN_UPPER_CASE_NGRAM)
Context: ...t works out of the box. Everything that Assist can do, LLM-based conversation agents c...


[style] ~94-~94: Consider using “incapable” to avoid wordiness. (NOT_ABLE_PREMIUM)
Context: ...nd words, which is something Assist was not capable of doing. For example, if you have a li...


[typographical] ~97-~97: This sentence does not start with an uppercase letter. (UPPERCASE_SENTENCE_START)
Context: ... built from the start to be extensible. custom integration and users can register thei...


[style] ~116-~116: Consider an alternative for the overused word “exactly”. (EXACTLY_PRECISELY)
Context: ...ll run my leave_home script, which is exactly what I want it to do. This release mak...


[misspelling] ~118-~118: Possible spelling mistake found. (MORFOLOGIK_RULE_EN_US)
Context: ...lease makes it available for our OpenAI and [Google AI](/compone...


[uncategorized] ~118-~118: For abbreviations such as ‘artificial intelligence’, use all capital letters. The rare word ‘ai’ is a synonym for ‘three-toed sloth’. (AI)
Context: ...nts/openai_conversation/) and Google AI integrations. To make it...

Markdownlint

98-98: Expected: 0 or 2; Actual: 1 (MD009, no-trailing-spaces)
Trailing spaces


Line range hint 172-172: Use "a" instead of "an" before words that start with a consonant sound.

- [@Nezz] contributed an great new feature to our dashboarding UI: The ability to set an background image for your dashboard!
+ [@Nezz] contributed a great new feature to our dashboarding UI: The ability to set a background image for your dashboard!

This correction fixes the misuse of "an" before words that begin with a consonant sound.

Tools
LanguageTool

[misspelling] ~91-~91: Only proper nouns start with an uppercase character (there are exceptions for headlines). (EN_UPPER_CASE_NGRAM)
Context: ...our intent system, which is what powers Assist. They also get access to every entity e...


[misspelling] ~91-~91: Only proper nouns start with an uppercase character (there are exceptions for headlines). (EN_UPPER_CASE_NGRAM)
Context: ...o get access to every entity exposed to Assist. That way, you can control what you giv...


[style] ~91-~91: Try using a synonym here to strengthen your writing. (GIVE_PROVIDE)
Context: ...ist. That way, you can control what you give access to your assistants. Tapping int...


[misspelling] ~94-~94: Only proper nouns start with an uppercase character (there are exceptions for headlines). (EN_UPPER_CASE_NGRAM)
Context: ...t works out of the box. Everything that Assist can do, LLM-based conversation agents c...


[style] ~94-~94: Consider using “incapable” to avoid wordiness. (NOT_ABLE_PREMIUM)
Context: ...nd words, which is something Assist was not capable of doing. For example, if you have a li...


[typographical] ~97-~97: This sentence does not start with an uppercase letter. (UPPERCASE_SENTENCE_START)
Context: ... built from the start to be extensible. custom integration and users can register thei...


[style] ~116-~116: Consider an alternative for the overused word “exactly”. (EXACTLY_PRECISELY)
Context: ...ll run my leave_home script, which is exactly what I want it to do. This release mak...


[misspelling] ~118-~118: Possible spelling mistake found. (MORFOLOGIK_RULE_EN_US)
Context: ...lease makes it available for our OpenAI and [Google AI](/compone...


[uncategorized] ~118-~118: For abbreviations such as ‘artificial intelligence’, use all capital letters. The rare word ‘ai’ is a synonym for ‘three-toed sloth’. (AI)
Context: ...nts/openai_conversation/) and Google AI integrations. To make it...

Markdownlint

98-98: Expected: 0 or 2; Actual: 1 (MD009, no-trailing-spaces)
Trailing spaces


Line range hint 175-175: Correct the spelling of "editing".

- Previously, this was only possible by editting YAML, but now you can do it directly from the UI.
+ Previously, this was only possible by editing YAML, but now you can do it directly from the UI.

This change corrects a spelling mistake to maintain professionalism in the documentation.

Tools
LanguageTool

[misspelling] ~91-~91: Only proper nouns start with an uppercase character (there are exceptions for headlines). (EN_UPPER_CASE_NGRAM)
Context: ...our intent system, which is what powers Assist. They also get access to every entity e...


[misspelling] ~91-~91: Only proper nouns start with an uppercase character (there are exceptions for headlines). (EN_UPPER_CASE_NGRAM)
Context: ...o get access to every entity exposed to Assist. That way, you can control what you giv...


[style] ~91-~91: Try using a synonym here to strengthen your writing. (GIVE_PROVIDE)
Context: ...ist. That way, you can control what you give access to your assistants. Tapping int...


[misspelling] ~94-~94: Only proper nouns start with an uppercase character (there are exceptions for headlines). (EN_UPPER_CASE_NGRAM)
Context: ...t works out of the box. Everything that Assist can do, LLM-based conversation agents c...


[style] ~94-~94: Consider using “incapable” to avoid wordiness. (NOT_ABLE_PREMIUM)
Context: ...nd words, which is something Assist was not capable of doing. For example, if you have a li...


[typographical] ~97-~97: This sentence does not start with an uppercase letter. (UPPERCASE_SENTENCE_START)
Context: ... built from the start to be extensible. custom integration and users can register thei...


[style] ~116-~116: Consider an alternative for the overused word “exactly”. (EXACTLY_PRECISELY)
Context: ...ll run my leave_home script, which is exactly what I want it to do. This release mak...


[misspelling] ~118-~118: Possible spelling mistake found. (MORFOLOGIK_RULE_EN_US)
Context: ...lease makes it available for our OpenAI and [Google AI](/compone...


[uncategorized] ~118-~118: For abbreviations such as ‘artificial intelligence’, use all capital letters. The rare word ‘ai’ is a synonym for ‘three-toed sloth’. (AI)
Context: ...nts/openai_conversation/) and Google AI integrations. To make it...

Markdownlint

98-98: Expected: 0 or 2; Actual: 1 (MD009, no-trailing-spaces)
Trailing spaces


Line range hint 399-399: Use the past tense "introduced" instead of "introduce".

- A few releases ago we introduce the automatic expiration of logins.
+ A few releases ago we introduced the automatic expiration of logins.

This correction ensures the sentence is grammatically correct by using the appropriate tense.

Tools
LanguageTool

[misspelling] ~91-~91: Only proper nouns start with an uppercase character (there are exceptions for headlines). (EN_UPPER_CASE_NGRAM)
Context: ...our intent system, which is what powers Assist. They also get access to every entity e...


[misspelling] ~91-~91: Only proper nouns start with an uppercase character (there are exceptions for headlines). (EN_UPPER_CASE_NGRAM)
Context: ...o get access to every entity exposed to Assist. That way, you can control what you giv...


[style] ~91-~91: Try using a synonym here to strengthen your writing. (GIVE_PROVIDE)
Context: ...ist. That way, you can control what you give access to your assistants. Tapping int...


[misspelling] ~94-~94: Only proper nouns start with an uppercase character (there are exceptions for headlines). (EN_UPPER_CASE_NGRAM)
Context: ...t works out of the box. Everything that Assist can do, LLM-based conversation agents c...


[style] ~94-~94: Consider using “incapable” to avoid wordiness. (NOT_ABLE_PREMIUM)
Context: ...nd words, which is something Assist was not capable of doing. For example, if you have a li...


[typographical] ~97-~97: This sentence does not start with an uppercase letter. (UPPERCASE_SENTENCE_START)
Context: ... built from the start to be extensible. custom integration and users can register thei...


[style] ~116-~116: Consider an alternative for the overused word “exactly”. (EXACTLY_PRECISELY)
Context: ...ll run my leave_home script, which is exactly what I want it to do. This release mak...


[misspelling] ~118-~118: Possible spelling mistake found. (MORFOLOGIK_RULE_EN_US)
Context: ...lease makes it available for our OpenAI and [Google AI](/compone...


[uncategorized] ~118-~118: For abbreviations such as ‘artificial intelligence’, use all capital letters. The rare word ‘ai’ is a synonym for ‘three-toed sloth’. (AI)
Context: ...nts/openai_conversation/) and Google AI integrations. To make it...

Markdownlint

98-98: Expected: 0 or 2; Actual: 1 (MD009, no-trailing-spaces)
Trailing spaces


Line range hint 409-409: Use consistent terminology for collapsible elements.

- ### Collapsable sections for blueprints!
+ ### Collapsible sections for blueprints!

This change aligns the terminology used in the document, ensuring consistency and clarity.

Tools
LanguageTool

[misspelling] ~91-~91: Only proper nouns start with an uppercase character (there are exceptions for headlines). (EN_UPPER_CASE_NGRAM)
Context: ...our intent system, which is what powers Assist. They also get access to every entity e...


[misspelling] ~91-~91: Only proper nouns start with an uppercase character (there are exceptions for headlines). (EN_UPPER_CASE_NGRAM)
Context: ...o get access to every entity exposed to Assist. That way, you can control what you giv...


[style] ~91-~91: Try using a synonym here to strengthen your writing. (GIVE_PROVIDE)
Context: ...ist. That way, you can control what you give access to your assistants. Tapping int...


[misspelling] ~94-~94: Only proper nouns start with an uppercase character (there are exceptions for headlines). (EN_UPPER_CASE_NGRAM)
Context: ...t works out of the box. Everything that Assist can do, LLM-based conversation agents c...


[style] ~94-~94: Consider using “incapable” to avoid wordiness. (NOT_ABLE_PREMIUM)
Context: ...nd words, which is something Assist was not capable of doing. For example, if you have a li...


[typographical] ~97-~97: This sentence does not start with an uppercase letter. (UPPERCASE_SENTENCE_START)
Context: ... built from the start to be extensible. custom integration and users can register thei...


[style] ~116-~116: Consider an alternative for the overused word “exactly”. (EXACTLY_PRECISELY)
Context: ...ll run my leave_home script, which is exactly what I want it to do. This release mak...


[misspelling] ~118-~118: Possible spelling mistake found. (MORFOLOGIK_RULE_EN_US)
Context: ...lease makes it available for our OpenAI and [Google AI](/compone...


[uncategorized] ~118-~118: For abbreviations such as ‘artificial intelligence’, use all capital letters. The rare word ‘ai’ is a synonym for ‘three-toed sloth’. (AI)
Context: ...nts/openai_conversation/) and Google AI integrations. To make it...

Markdownlint

98-98: Expected: 0 or 2; Actual: 1 (MD009, no-trailing-spaces)
Trailing spaces


Line range hint 540-540: Clarify the use of "sane" in this context.

- The timeout is set static to a sane value of 30 seconds.
+ The timeout is set statically to a reasonable value of 30 seconds.

This correction clarifies the meaning and improves the readability of the sentence.

Tools
LanguageTool

[misspelling] ~91-~91: Only proper nouns start with an uppercase character (there are exceptions for headlines). (EN_UPPER_CASE_NGRAM)
Context: ...our intent system, which is what powers Assist. They also get access to every entity e...


[misspelling] ~91-~91: Only proper nouns start with an uppercase character (there are exceptions for headlines). (EN_UPPER_CASE_NGRAM)
Context: ...o get access to every entity exposed to Assist. That way, you can control what you giv...


[style] ~91-~91: Try using a synonym here to strengthen your writing. (GIVE_PROVIDE)
Context: ...ist. That way, you can control what you give access to your assistants. Tapping int...


[misspelling] ~94-~94: Only proper nouns start with an uppercase character (there are exceptions for headlines). (EN_UPPER_CASE_NGRAM)
Context: ...t works out of the box. Everything that Assist can do, LLM-based conversation agents c...


[style] ~94-~94: Consider using “incapable” to avoid wordiness. (NOT_ABLE_PREMIUM)
Context: ...nd words, which is something Assist was not capable of doing. For example, if you have a li...


[typographical] ~97-~97: This sentence does not start with an uppercase letter. (UPPERCASE_SENTENCE_START)
Context: ... built from the start to be extensible. custom integration and users can register thei...


[style] ~116-~116: Consider an alternative for the overused word “exactly”. (EXACTLY_PRECISELY)
Context: ...ll run my leave_home script, which is exactly what I want it to do. This release mak...


[misspelling] ~118-~118: Possible spelling mistake found. (MORFOLOGIK_RULE_EN_US)
Context: ...lease makes it available for our OpenAI and [Google AI](/compone...


[uncategorized] ~118-~118: For abbreviations such as ‘artificial intelligence’, use all capital letters. The rare word ‘ai’ is a synonym for ‘three-toed sloth’. (AI)
Context: ...nts/openai_conversation/) and Google AI integrations. To make it...

Markdownlint

98-98: Expected: 0 or 2; Actual: 1 (MD009, no-trailing-spaces)
Trailing spaces

source/_posts/2024-06-05-release-20246.markdown Outdated Show resolved Hide resolved
source/_posts/2024-06-05-release-20246.markdown Outdated Show resolved Hide resolved
source/_posts/2024-06-05-release-20246.markdown Outdated Show resolved Hide resolved
@jlpouffier jlpouffier marked this pull request as ready for review June 5, 2024 12:34
Copy link
Member

@frenck frenck left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks, @jlpouffier 👍

../Frenck

@frenck frenck merged commit 78692df into home-assistant:rc Jun 5, 2024
6 checks passed
@home-assistant home-assistant bot removed needs-rebase The PR has been branched of the wrong base branch or targets an incorrect target branch in-progress This PR/Issue is currently being worked on labels Jun 5, 2024
@github-actions github-actions bot locked and limited conversation to collaborators Jun 6, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
rc This PR is against the RC branch
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants