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

[EN] HassGetState optimizations #2224

Draft
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

tetele
Copy link
Contributor

@tetele tetele commented Jun 7, 2024

Apart from optimizing the sentences for HassGetState a bit, I've also introduced a new set of sentences specifically for querying lights.

Is the light off in the kitchen usually means asking if all of the lights are off.

Inspired by #2218

Summary by CodeRabbit

  • New Features

    • Enhanced querying capabilities for Home Assistant entity states, including specific areas like the bedroom and kitchen.
    • Added new sentence structures for more detailed and varied queries.
  • Refactor

    • Improved clarity and coverage of existing sentence structures for querying entity states.
  • Tests

    • Added and refined test queries for specific devices and areas to ensure accurate responses.

@tetele tetele requested review from jlpouffier and TheFes June 7, 2024 10:33
@tetele tetele marked this pull request as draft June 7, 2024 10:40
Copy link

coderabbitai bot commented Jun 7, 2024

Warning

Rate limit exceeded

@frenck has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 18 minutes and 25 seconds before requesting another review.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

📥 Commits

Files that changed from the base of the PR and between d40f394 and fdb2010.

📝 Walkthrough

Walkthrough

The recent updates to the Home Assistant HassGetState intent involve enhancing the sentence structures and responses for querying the state of various entities. The changes focus on improving the clarity and coverage of queries related to specific devices in different areas, such as the bedroom and kitchen. This includes refined queries for specific devices and detailed responses based on the state of the queried entities.

Changes

File Path Change Summary
sentences/en/homeassistant_HassGetState.yaml Added new sentence structures for querying entity states, modified responses, updated slots, and refactored existing structures.
tests/en/homeassistant_HassGetState.yaml Added and refined queries for specific devices and areas, enhanced responses for state queries.

Sequence Diagram(s) (Beta)

No sequence diagrams are necessary for these changes, as they primarily involve updates to sentence structures and responses without altering control flows or introducing new features.


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>, please review it.
    • 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 gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @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 using 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.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai or @coderabbitai title anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration 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.

@tetele tetele marked this pull request as ready for review June 7, 2024 10:52
@ViViDboarder
Copy link
Contributor

I have a branch where I'm looking to condense some of these common patterns in _common.yaml. For example (is|are [there]) is something that is likely useful for any any query. If more is added in common expansions and they are used more, every intent will benefit from expanded sentence structures.

I can rebase my proposal on this regardless and submit that elsewhere, but I thought I'd at least float it since you're making a bigger change to this file anyway.

@tetele
Copy link
Contributor Author

tetele commented Jun 7, 2024

There are other HassGetState files where your modification would be needed (e.g. binary_sensor_HassGetState), so that's probably a good starting point for a refactoring PR that is not directly tied to this.

@frenck frenck force-pushed the en-light-getstate branch from d40f394 to fdb2010 Compare October 26, 2024 13:45
Comment on lines +6 to +8
- (is|are)[ there] any {on_off_domains:domain} {on_off_states:state}
- (is|are)[ there] any {on_off_domains:domain} ({on_off_states:state};in <area>)
- (is|are)[ there] any <area> {on_off_domains:domain} {on_off_states:state}
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
- (is|are)[ there] any {on_off_domains:domain} {on_off_states:state}
- (is|are)[ there] any {on_off_domains:domain} ({on_off_states:state};in <area>)
- (is|are)[ there] any <area> {on_off_domains:domain} {on_off_states:state}
- <are_any> {on_off_domains:domain} {on_off_states:state} [<in_area_floor>]
- <are_any> {on_off_domains:domain} <in_area_floor> {on_off_states:state}
- <are_any> <area> {on_off_domains:domain} {on_off_states:state}
- <is> <area> {on_off_domains:domain} on

Use the new <are_any> and <is> expansions as well as <in_area_floor>. Additionally, I think it's easier to parse the optional area suffix on the first sentence than the (foo;bar) syntax, so that's split among the two lines.

Final suggestion is to add an is area domain on? here and leave is area domain off? in the all sentences.

Not sure if there is a way for us to only reference on from on_off_states:state. It may be useful to do that because we could add [(switched|turned|set [to])] on into the common on_off_states.

Comment on lines +9 to +11
- (do you know|tell me) if there are any {on_off_domains:domain} {on_off_states:state}
- (do you know|tell me) if there are any {on_off_domains:domain} ({on_off_states:state};in <area>)
- (do you know|tell me) if there are any <area> {on_off_domains:domain} {on_off_states:state}
Copy link
Contributor

Choose a reason for hiding this comment

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

I think it might be easier to read if we add [(do you know|tell me) if there] as an optional prefix in the above sentences.

Comment on lines +15 to +17
- are [all ][[of ]the ]{on_off_domains:domain} [(switched|turned|set[ to]) ]{on_off_states:state}
- are [all ][of ]<area> {on_off_domains:domain} [(switched|turned|set[ to]) ]{on_off_states:state}
- are [all ][[of ]the ]{on_off_domains:domain} ([(switched|turned|set[ to]) ]{on_off_states:state};in <area>)
Copy link
Contributor

Choose a reason for hiding this comment

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

Use <are_all> to match up to are all of the. I also again think it is easier to read if we split out the (foo;bar) expansion again. Also, adding the area off query here.

Suggested change
- are [all ][[of ]the ]{on_off_domains:domain} [(switched|turned|set[ to]) ]{on_off_states:state}
- are [all ][of ]<area> {on_off_domains:domain} [(switched|turned|set[ to]) ]{on_off_states:state}
- are [all ][[of ]the ]{on_off_domains:domain} ([(switched|turned|set[ to]) ]{on_off_states:state};in <area>)
- <are_all> {on_off_domains:domain} [(switched|turned|set [to])] {on_off_states:state} [<in_area_floor>]
- <are_all> <area_floor> {on_off_domains:domain} [(switched|turned|set [to])] {on_off_states:state}
- <are_all> {on_off_domains:domain} ([(switched|turned|set [to])] <in_area_floor> {on_off_states:state}
- <is> <area> {on_off_domains:domain} off

Comment on lines 20 to 27
- sentences:
- are all [the] {on_off_domains:domain} [(switched|turned|set[ to])] {on_off_states:state} [in <area>]
- are all [the] {on_off_domains:domain} in <area> [(switched|turned|set[ to])] {on_off_states:state}
- is the light [(switched|turned|set[ to]) ]{on_off_states:state}
- is the light ([(switched|turned|set[ to]) ]{on_off_states:state};in <area>)
- is <area> light [(switched|turned|set[ to]) ]{on_off_states:state}
slots:
domain: light
response: all

Copy link
Contributor

Choose a reason for hiding this comment

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

This could then be deleted

Comment on lines +29 to +31
- "[do you know ](which|what) {on_off_domains:domain} (is|are) {on_off_states:state}"
- "[do you know ](which|what) {on_off_domains:domain} ((is|are) {on_off_states:state};in <area>)"
- "[do you know ](which|what) <area> {on_off_domains:domain} (is|are) {on_off_states:state}"
Copy link
Contributor

Choose a reason for hiding this comment

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

Maybe do you know should be added to the skip words. They seem redundant in any kind of query sentence. Same with tell me as we have below.

You can also replace (which|what) with <which> and (is|are) with <is>. I'd also suggest a similar removal of the (foo;bar) as above.

Comment on lines +35 to +37
- "[tell me ]how many {on_off_domains:domain} (is|are) {on_off_states:state}"
- "[tell me ]how many {on_off_domains:domain} ((is|are) {on_off_states:state};in <area>)"
- "[tell me ]how many <area> {on_off_domains:domain} (is|are) {on_off_states:state}"
Copy link
Contributor

Choose a reason for hiding this comment

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

As above, consider moving tell me to skip words. Replace how many with <how_many> and (is|are) with <is>, and break up the (foo;bar).

response: how_many

- sentences:
- (do you know|tell me|<what_is>) [the [current ](state|value) of ]<name>[ in <area>]
Copy link
Contributor

Choose a reason for hiding this comment

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

Probably use <in_area_floor>. Also, [current] (state|value) should be replaced by <state>, but will need you to add value to the state expansion.

Comment on lines +48 to +49
- is [the ][state of ]<name> {on_off_states:state}
- is [the ][state of ]<name> (({on_off_states:state};in <area>))
Copy link
Contributor

Choose a reason for hiding this comment

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

is [the] can be replaced by <is>. Also remove the permutation as shown above.

response: one_yesno
excludes_context:
domain:
- cover
Copy link
Contributor

Choose a reason for hiding this comment

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

Why is this excluded? Because there is a collision with a different response there?

- sentences:
- "are all the lights on in the kitchen"
- "are all lights turned on in the kitchen?"
- "are all lights in the kitchen on?"
- "is the kitchen light on?"
Copy link
Contributor

Choose a reason for hiding this comment

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

If we make the suggested changes, this should move to an "any" response and not all.

@home-assistant home-assistant bot marked this pull request as draft December 4, 2024 19:34
@home-assistant
Copy link

home-assistant bot commented Dec 4, 2024

Please take a look at the requested changes, and use the Ready for review button when you are done, thanks 👍

Learn more about our pull request process.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants