Add support for Amazon Polly generative engine

[jschlyter]

Proposed change

Add documentation for home-assistant/core#120226

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).
  • I've opened up a PR to add logos and icons in Brands repository.
• 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: Support setting Amazon Polly engine in service call core#120226
• Link to parent pull request in the Brands repository:
• This PR fixes or closes issue: fixes #

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

• Documentation
  • Simplified configuration for the Amazon Polly integration by changing region_name to a single string value.
  • Expanded engine options to include long-form and generative in the documentation.
  • Added new YAML configuration examples to enhance user guidance on using the service effectively.

[netlify]

✅ Deploy Preview for home-assistant-docs ready!

Name	Link
🔨 Latest commit	0b6bf86
🔍 Latest deploy log	https://app.netlify.com/sites/home-assistant-docs/deploys/66c73f57e01e0b0008fd2515
😎 Deploy Preview	https://deploy-preview-32725--home-assistant-docs.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

---

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

[coderabbitai]

Walkthrough

Walkthrough

The update modifies the Amazon Polly integration documentation, specifically the region_name type, which is now a simple string instead of a union type. The engine description has been expanded to include new options: long-form and generative, alongside the existing standard and neural. Additionally, new YAML configuration examples have been added to enhance user guidance on implementation.

Changes

File	Change Summary
source/_integrations/amazon_polly.markdown	region_name type changed from [string, list] to string; engine description updated to include long-form and generative options; new YAML configuration examples added.

---

Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 8a429d4 and 0b6bf86.

Files selected for processing (1)

• source/_integrations/amazon_polly.markdown (3 hunks)

Additional context used

LanguageTool

source/_integrations/amazon_polly.markdown

[style] ~79-~79: To form a complete sentence, be sure to include a subject or ‘there’.
Context: ...cription: "Override the default engine. Can be either of [standard](https://docs....

(MISSING_IT_THERE)

Markdownlint

source/_integrations/amazon_polly.markdown

144-144: Expected: 1; Actual: 2
Multiple consecutive blank lines

(MD012, no-multiple-blanks)

Additional comments not posted (3)

source/_integrations/amazon_polly.markdown (3)

131-142: New YAML configuration example looks good!

The addition of a new YAML configuration example enhances the documentation by providing practical usage scenarios.

---

57-57: Verify the impact of changing region_name type.

The change from a union type to a singular string simplifies the configuration but may affect existing users who used a list. Ensure that this change is clearly communicated in the release notes or migration guide.

Run the following script to check for any documentation or migration guides related to this change:

---

79-79: Verify availability of new engine options.

The engine description now includes long-form and generative options. Ensure these options are supported in the core codebase and are documented in the release notes.

Run the following script to check for any references to these options in the core codebase:

Tools

LanguageTool

[style] ~79-~79: To form a complete sentence, be sure to include a subject or ‘there’.
Context: ...cription: "Override the default engine. Can be either of [standard](https://docs....

(MISSING_IT_THERE)

---

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

• X
• Mastodon
• Reddit
• LinkedIn

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

[c0ffeeca7]

Thank you, @jschlyter 👍