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

Ensure trigger sentences do not contain punctuation #95633

Merged
merged 2 commits into from
Jun 30, 2023

Conversation

synesthesiam
Copy link
Contributor

@synesthesiam synesthesiam commented Jun 30, 2023

Breaking change

Proposed change

This PR adds validation to the sentence trigger to ensure that punctuation is not present. A soft warning in the frontend is also being worked on: home-assistant/frontend#17119

Every character in a sentence template must match unless it's marked optional. hassil automatically strips punctuation from the input text during matching, so the templates should not require it.

Note that this can lead to some non-intuitive templates: for example, matching the phrases "It's 4 a.m." or "It's 4am". Whisper returns the text "It's 4:00 AM." for the spoken phrase, but the colon is considered punctuation! Periods are also punctuation (even in abbreviations), so the template it's 4[00][ ]am is needed to cover all of the cases.

Type of change

  • Dependency upgrade
  • Bugfix (non-breaking change which fixes an issue)
  • New integration (thank you!)
  • New feature (which adds functionality to an existing integration)
  • Deprecation (breaking change to happen in the future)
  • Breaking change (fix/feature causing existing functionality to break)
  • Code quality improvements to existing code or addition of tests

Additional information

  • This PR fixes or closes issue: fixes #
  • This PR is related to issue:
  • Link to documentation pull request:

Checklist

  • The code change is tested and works locally.
  • Local tests pass. Your PR cannot be merged unless tests pass
  • There is no commented out code in this PR.
  • I have followed the development checklist
  • I have followed the perfect PR recommendations
  • The code has been formatted using Black (black --fast homeassistant tests)
  • Tests have been added to verify that the new code works.

If user exposed functionality or configuration variables are added/changed:

If the code communicates with devices, web services, or third-party tools:

  • The manifest file has all fields filled out correctly.
    Updated and included derived files by running: python3 -m script.hassfest.
  • New or updated dependencies have been added to requirements_all.txt.
    Updated by running python3 -m script.gen_requirements_all.
  • For the updated dependencies - a link to the changelog, or at minimum a diff between library versions is added to the PR description.
  • Untested files have been added to .coveragerc.

To help with the load of incoming pull requests:

@home-assistant
Copy link

Hey there @home-assistant/core, mind taking a look at this pull request as it has been labeled with an integration (conversation) you are listed as a code owner for? Thanks!

Code owner commands

Code owners of conversation can trigger bot actions by commenting:

  • @home-assistant close Closes the pull request.
  • @home-assistant rename Awesome new title Renames the pull request.
  • @home-assistant reopen Reopen the pull request.
  • @home-assistant unassign conversation Removes the current integration label and assignees on the pull request, add the integration domain after the command.

@synesthesiam synesthesiam marked this pull request as ready for review June 30, 2023 16:11
@synesthesiam synesthesiam requested a review from a team as a code owner June 30, 2023 16:11
Co-authored-by: Paulus Schoutsen <balloob@gmail.com>
@synesthesiam synesthesiam merged commit 6b8ae0e into dev Jun 30, 2023
@synesthesiam synesthesiam deleted the sentence-trigger-punctuation branch June 30, 2023 18:06
@github-actions github-actions bot locked and limited conversation to collaborators Jul 1, 2023
@frenck
Copy link
Member

frenck commented Jul 3, 2023

Shouldn't this PR go into the current beta release?

../Frenck

@synesthesiam
Copy link
Contributor Author

Yes, it should 👍

@frenck frenck added this to the 2023.7.0 milestone Jul 3, 2023
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants