Mention the legacy tts.google_cloud_say #35218
Conversation
✅ Deploy Preview for home-assistant-docs ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
📝 WalkthroughWalkthroughThe changes involve updates to the Google Cloud integration documentation for Home Assistant. Two new sections have been added: "Action speak," which details the current usage of the Changes
Sequence Diagram(s)sequenceDiagram
participant User
participant HomeAssistant
participant GoogleCloudTTS
User->>HomeAssistant: Initiate TTS action
HomeAssistant->>GoogleCloudTTS: Call tts.speak with message
GoogleCloudTTS-->>HomeAssistant: Return speech audio
HomeAssistant-->>User: Play audio on media player
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 (
|
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Outside diff range and nitpick comments (1)
source/_integrations/google_cloud.markdown (1)
Line range hint
119-142: LGTM: Comprehensive YAML example fortts.speakservice call.The YAML example provides a clear and detailed reference for users implementing the
tts.speakaction. It demonstrates the use of various configuration options, which is very helpful.Consider adding a brief comment above the YAML example to explain that this is a comprehensive example showcasing multiple options, and users can adjust it based on their specific needs.
🧰 Tools
🪛 LanguageTool
[grammar] ~143-~143: There seems to be a noun/verb agreement error. Did you mean “says” or “said”?
Context: ... - wearable-class-device ``` ## Action say (legacy) Thetts.google_cloud_sayac...(SINGULAR_NOUN_VERB_AGREEMENT)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
📒 Files selected for processing (1)
- source/_integrations/google_cloud.markdown (2 hunks)
🧰 Additional context used
🪛 LanguageTool
source/_integrations/google_cloud.markdown
[grammar] ~143-~143: There seems to be a noun/verb agreement error. Did you mean “says” or “said”?
Context: ... - wearable-class-device ``` ## Action say (legacy) Thetts.google_cloud_sayac...(SINGULAR_NOUN_VERB_AGREEMENT)
🔇 Additional comments (1)
source/_integrations/google_cloud.markdown (1)
113-117: LGTM: Clear introduction to the newtts.speakaction.The new "Action speak" section provides a concise and informative introduction to the modern way of using Google Cloud TTS. The reference to the main TTS page for more options is helpful for users.
| ## Action say (legacy) | ||
|
|
||
| The `tts.google_cloud_say` action can be used when configuring the legacy `google_cloud` text-to-speech platform in `configuration.yaml`. We recommend new users to instead set up the integration in the UI and use the `tts.speak` action with the corresponding Google Cloud text-to-speech entity as target. If you are an existing user of `tts.google_cloud_say`, you can still use it but don't remove the legacy `google_cloud` text-to-speech platform in `configuration.yaml`. If you remove it, you will have to manually migrate to `tts.speak`. | ||
|
|
There was a problem hiding this comment.
Approve with minor grammatical correction: Clear guidance on legacy action usage.
The new "Action say (legacy)" section provides clear guidance for both new and existing users regarding the tts.google_cloud_say action. The explanation about potential manual migration if the legacy configuration is removed is particularly helpful.
There's a minor grammatical issue in the section title. Apply this change:
-## Action say (legacy)
+## Action "say" (legacy)This change ensures grammatical correctness by treating "say" as a verb in quotation marks.
📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| ## Action say (legacy) | |
| The `tts.google_cloud_say` action can be used when configuring the legacy `google_cloud` text-to-speech platform in `configuration.yaml`. We recommend new users to instead set up the integration in the UI and use the `tts.speak` action with the corresponding Google Cloud text-to-speech entity as target. If you are an existing user of `tts.google_cloud_say`, you can still use it but don't remove the legacy `google_cloud` text-to-speech platform in `configuration.yaml`. If you remove it, you will have to manually migrate to `tts.speak`. | |
| ## Action "say" (legacy) | |
| The `tts.google_cloud_say` action can be used when configuring the legacy `google_cloud` text-to-speech platform in `configuration.yaml`. We recommend new users to instead set up the integration in the UI and use the `tts.speak` action with the corresponding Google Cloud text-to-speech entity as target. If you are an existing user of `tts.google_cloud_say`, you can still use it but don't remove the legacy `google_cloud` text-to-speech platform in `configuration.yaml`. If you remove it, you will have to manually migrate to `tts.speak`. |
🧰 Tools
🪛 LanguageTool
[grammar] ~143-~143: There seems to be a noun/verb agreement error. Did you mean “says” or “said”?
Context: ... - wearable-class-device ``` ## Action say (legacy) Thetts.google_cloud_sayac...(SINGULAR_NOUN_VERB_AGREEMENT)
| @@ -136,6 +140,10 @@ data: | |||
| - wearable-class-device | |||
| ``` | |||
|
|
|||
| ## Action say (legacy) | |||
|
|
|||
| The `tts.google_cloud_say` action can be used when configuring the legacy `google_cloud` text-to-speech platform in `configuration.yaml`. We recommend new users to instead set up the integration in the UI and use the `tts.speak` action with the corresponding Google Cloud text-to-speech entity as target. If you are an existing user of `tts.google_cloud_say`, you can still use it but don't remove the legacy `google_cloud` text-to-speech platform in `configuration.yaml`. If you remove it, you will have to manually migrate to `tts.speak`. | |||
There was a problem hiding this comment.
I think we should rather mention this at the config part of the docs. The downside is that it's not deprecated so theoretically their way is still supported
There was a problem hiding this comment.
I'd rather have it here at the bottom since it only affects few old users. And I think it's more discoverable here in the google_cloud_say section. Few users read the documentation in general. They will mostly look at it whenever they will encounter an issue. If they manually remove the legacy TTS platform, their google_cloud_say calls will fail so they will search for that in the docs.
|
Also a general comment, we still use the word service in the docs here |
Oh you're right. Not sure why these weren't renamed. I can do it in a follow up PR to keep this PR focused. |
Proposed change
Mention the legacy tts.google_cloud_say and that old users shouldn't remove their google_cloud config from their YAML unless they migrate to the modern tts.speak.
Note a lot of the text is copied from https://www.home-assistant.io/integrations/google_translate
Type of change
currentbranch).currentbranch).nextbranch).nextbranch).Additional information
Checklist
currentbranch.nextbranch.Summary by CodeRabbit
New Features
tts.speakaction in Google Cloud Text-to-Speech.tts.google_cloud_sayaction.Documentation