Add elevenlabs integration docs #32322

sorgfresser · 2024-04-15T12:33:14Z

Proposed change

Add docs for the ElevenLabs integration - this should be merged together with the corresponding integration at core.

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: Add ElevenLabs text-to-speech integration core#115645
Link to parent pull request in the Brands repository: Added ElevenLabs as brand. brands#4118, Copy ElevenLabs to core brands#5726
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

New Features
- Introduced ElevenLabs text-to-speech integration for Home Assistant, enabling natural-sounding voice synthesis.
- Added detailed setup instructions and configuration guidance for users to implement TTS functionality easily.
- Included examples for invoking the text-to-speech service, enhancing user experience and understanding.

home-assistant · 2024-04-15T12:33:18Z

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.

netlify · 2024-04-15T12:33:30Z

✅ Deploy Preview for home-assistant-docs ready!

Name	Link
🔨 Latest commit	`8e8791f`
🔍 Latest deploy log	https://app.netlify.com/sites/home-assistant-docs/deploys/66af384487a7fa000889d3e2
😎 Deploy Preview	https://deploy-preview-32322--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 · 2024-07-31T19:31:32Z

Walkthrough

The integration of ElevenLabs text-to-speech (TTS) into Home Assistant introduces a new capability for converting text into natural-sounding speech. The elevenlabs.markdown file provides comprehensive setup instructions, configuration examples, and external resources, enabling users to easily implement TTS in their smart home environments.

Changes

File Path	Change Summary
`source/_integrations/elevenlabs.markdown`	New integration `elevenlabstts` added with attributes including title, description, release version, and configuration flow instructions for TTS functionality.

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

joostlek · 2024-07-31T19:31:49Z

@sorgfresser There is a PR missing for the brands repo, can you take a look?

coderabbitai

Actionable comments posted: 0

Outside diff range, codebase verification and nitpick comments (2)

source/_integrations/elevenlabs.markdown (2)
19-19: Possible missing preposition.

Consider adding "of" for clarity.
- Check the [complete list of supported languages](https://elevenlabs.io/languages) for an overview which languages can be used.
+ Check the [complete list of supported languages](https://elevenlabs.io/languages) for an overview of which languages can be used.
Tools

LanguageTool

[uncategorized] ~19-~19: Possible missing preposition found.
Context: ...levenlabs.io/languages) for an overview which languages can be used. Check your Voic...

(AI_EN_LECTOR_MISSING_PREPOSITION)

21-21: Preposition usage improvement.

Consider using "of" for clarity.
- Check your VoiceLab voices for a description on which voices are available for use.
+ Check your VoiceLab voices for a description of which voices are available for use.
Tools

LanguageTool

[uncategorized] ~21-~21: The preposition “of” seems more likely in this position.
Context: ... your VoiceLab voices for a description on which voices are available for use. Ch...

(AI_EN_LECTOR_REPLACEMENT_PREPOSITION)

joostlek · 2024-07-31T19:33:43Z

source/_integrations/elevenlabs.markdown

+description: Instructions on how to setup ElevenLabs text-to-speech with Home Assistant.
+ha_category:
+  - Text-to-speech
+ha_release: 2024.4.3


Suggested change

ha_release: 2024.4.3

ha_release: 2024.8

joostlek · 2024-07-31T19:33:58Z

source/_integrations/elevenlabs.markdown

+ha_integration_type: integration
+---
+
+The `elevenlabstts` text-to-speech platform uses the official [ElevenLabs SDK](https://github.com/elevenlabs/elevenlabs-python) to read a text with natural sounding voices.


It's an integration not a platform

joostlek · 2024-07-31T19:34:11Z

source/_integrations/elevenlabs.markdown

+ha_integration_type: integration
+---
+
+The `elevenlabstts` text-to-speech platform uses the official [ElevenLabs SDK](https://github.com/elevenlabs/elevenlabs-python) to read a text with natural sounding voices.


Not sure why it's relevant it's using the official SDK

Should I just remove the whole line then?
Edit: Done

joostlek · 2024-07-31T19:34:30Z

source/_integrations/elevenlabs.markdown

+
+## Service speak
+
+The `tts.speak` service is the modern way to use TTS. Add the `speak` action, select the entity for your ElevenLabs TTS (it's named for the model and voice you created it with), select the media player entity or group to send the TTS audio to, and enter the message to speak.


We have a new way of naming services

The DeviceInfo we added? Otherwise I would be glad if you could tell me what exactly you are referring to.

home-assistant · 2024-07-31T19:34:42Z

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.

sorgfresser · 2024-07-31T21:20:40Z

@joostlek I felt like I do not need the Brands-Pr due to home-assistant/brands#4118

Could you tell me whether this suffices?

Add elevenlabs integration docs

joostlek · 2024-07-31T22:40:32Z

@joostlek I felt like I do not need the Brands-Pr due to home-assistant/brands#4118

Could you tell me whether this suffices?

Custom_integration

It should be moved to the core integration folder

source/_integrations/elevenlabs.markdown

c0ffeeca7 · 2024-08-01T07:28:00Z

source/_integrations/elevenlabs.markdown

+ha_integration_type: integration
+---
+
+The **ElevenLabs** text-to-speech {% term integrations %} adds support for [ElevenLabs](https://elevenlabs.io/) as text-to-speech to read a text with natural sounding voices.


Are there any prerequisites? Do I need to have something before I can add the integration? an ElevenLabs account, credentials, API key?

Added a draft for prerequisites

sorgfresser · 2024-08-02T19:17:22Z

@joostlek see home-assistant/brands#5726

source/_integrations/elevenlabs.markdown

c0ffeeca7

Thank you, @sorgfresser 👍

sorgfresser · 2024-08-03T10:24:37Z

Thanks for the corrections @c0ffeeca7!

c0ffeeca7 · 2024-08-03T10:27:11Z

are you good with the changes, @joostlek ?

source/_integrations/elevenlabs.markdown

joostlek · 2024-08-03T10:32:55Z

Last question I have, Furthermore looks good

Co-authored-by: Simon <80467011+sorgfresser@users.noreply.github.com>

sorgfresser · 2024-08-04T21:58:24Z

Thanks @joostlek and @c0ffeeca7 for the reviews and the improvements! :)

home-assistant bot assigned sorgfresser Apr 15, 2024

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 labels Apr 15, 2024

home-assistant bot added the next This PR goes into the next branch label Apr 15, 2024

sorgfresser mentioned this pull request Apr 15, 2024

Add ElevenLabs text-to-speech integration home-assistant/core#115645

Merged

20 tasks

home-assistant bot added has-parent This PR has a parent PR in a other repo and removed needs-rebase The PR has been branched of the wrong base branch or targets an incorrect target branch labels Apr 15, 2024

home-assistant bot unassigned sorgfresser Apr 15, 2024

sorgfresser force-pushed the add-elevenlabs branch from 59d65bf to 1fd4df8 Compare April 20, 2024 17:25

sorgfresser marked this pull request as ready for review April 20, 2024 17:27

joostlek added the parent-merged The parent PR has been merged already label Jul 31, 2024

coderabbitai bot reviewed Jul 31, 2024

View reviewed changes

joostlek requested changes Jul 31, 2024

View reviewed changes

home-assistant bot marked this pull request as draft July 31, 2024 19:34

frenck added this to the 2024.8 milestone Jul 31, 2024

sorgfresser force-pushed the add-elevenlabs branch 2 times, most recently from 2d71391 to 1716789 Compare July 31, 2024 21:26

Add elevenlabs integration docs

89798c0

Add elevenlabs integration docs

sorgfresser force-pushed the add-elevenlabs branch from 1716789 to 89798c0 Compare July 31, 2024 21:27

c0ffeeca7 added the new-integration This PR adds documentation for a new Home Assistant integration label Aug 1, 2024

c0ffeeca7 reviewed Aug 1, 2024

View reviewed changes

Tiny style tweaks

9e33fb9

c0ffeeca7 reviewed Aug 1, 2024

View reviewed changes

sorgfresser mentioned this pull request Aug 2, 2024

Copy ElevenLabs to core home-assistant/brands#5726

Merged

13 tasks

Add prerequisites

f699171

c0ffeeca7 reviewed Aug 3, 2024

View reviewed changes

source/_integrations/elevenlabs.markdown Outdated Show resolved Hide resolved

Tiny tweak

5540be4

c0ffeeca7 previously approved these changes Aug 3, 2024

View reviewed changes

sorgfresser marked this pull request as ready for review August 3, 2024 10:24

home-assistant bot requested a review from joostlek August 3, 2024 10:24

joostlek reviewed Aug 3, 2024

View reviewed changes

source/_integrations/elevenlabs.markdown Outdated Show resolved Hide resolved

Update source/_integrations/elevenlabs.markdown

8e8791f

Co-authored-by: Simon <80467011+sorgfresser@users.noreply.github.com>

joostlek dismissed c0ffeeca7’s stale review via 8e8791f August 4, 2024 08:13

joostlek approved these changes Aug 4, 2024

View reviewed changes

joostlek merged commit f4f5244 into home-assistant:next Aug 4, 2024
6 checks passed

home-assistant bot removed parent-merged The parent PR has been merged already in-progress This PR/Issue is currently being worked on labels Aug 4, 2024

github-actions bot locked and limited conversation to collaborators Aug 5, 2024

frenck added the cherry-picked This PR has been manually picked and merged into the current branch label Aug 6, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add elevenlabs integration docs #32322

Add elevenlabs integration docs #32322

sorgfresser commented Apr 15, 2024 •

edited by c0ffeeca7

Loading

home-assistant bot commented Apr 15, 2024

netlify bot commented Apr 15, 2024 •

edited

Loading

coderabbitai bot commented Jul 31, 2024 •

edited

Loading

Walkthrough

Changes

Chat

CodeRabbit Commands (invoked as PR comments)

CodeRabbit Configuration File (`.coderabbit.yaml`)

Documentation and Community

joostlek commented Jul 31, 2024

coderabbitai bot left a comment

joostlek Jul 31, 2024

joostlek Jul 31, 2024

joostlek Jul 31, 2024

sorgfresser Jul 31, 2024 •

edited

Loading

joostlek Jul 31, 2024

sorgfresser Jul 31, 2024

home-assistant bot commented Jul 31, 2024

sorgfresser commented Jul 31, 2024

joostlek commented Jul 31, 2024

c0ffeeca7 Aug 1, 2024

sorgfresser Aug 2, 2024

sorgfresser commented Aug 2, 2024

c0ffeeca7 left a comment

sorgfresser commented Aug 3, 2024

c0ffeeca7 commented Aug 3, 2024

joostlek commented Aug 3, 2024

sorgfresser commented Aug 4, 2024


		## Service speak

		The `tts.speak` service is the modern way to use TTS. Add the `speak` action, select the entity for your ElevenLabs TTS (it's named for the model and voice you created it with), select the media player entity or group to send the TTS audio to, and enter the message to speak.

Add elevenlabs integration docs #32322

Add elevenlabs integration docs #32322

Conversation

sorgfresser commented Apr 15, 2024 • edited by c0ffeeca7 Loading

Proposed change

Type of change

Additional information

Checklist

Summary by CodeRabbit

home-assistant bot commented Apr 15, 2024

netlify bot commented Apr 15, 2024 • edited Loading

✅ Deploy Preview for home-assistant-docs ready!

coderabbitai bot commented Jul 31, 2024 • edited Loading

Walkthrough

Changes

Chat

CodeRabbit Commands (invoked as PR comments)

CodeRabbit Configuration File (.coderabbit.yaml)

Documentation and Community

joostlek commented Jul 31, 2024

coderabbitai bot left a comment

Choose a reason for hiding this comment

joostlek Jul 31, 2024

Choose a reason for hiding this comment

joostlek Jul 31, 2024

Choose a reason for hiding this comment

joostlek Jul 31, 2024

Choose a reason for hiding this comment

sorgfresser Jul 31, 2024 • edited Loading

Choose a reason for hiding this comment

joostlek Jul 31, 2024

Choose a reason for hiding this comment

sorgfresser Jul 31, 2024

Choose a reason for hiding this comment

home-assistant bot commented Jul 31, 2024

sorgfresser commented Jul 31, 2024

joostlek commented Jul 31, 2024

c0ffeeca7 Aug 1, 2024

Choose a reason for hiding this comment

sorgfresser Aug 2, 2024

Choose a reason for hiding this comment

sorgfresser commented Aug 2, 2024

c0ffeeca7 left a comment

Choose a reason for hiding this comment

sorgfresser commented Aug 3, 2024

c0ffeeca7 commented Aug 3, 2024

joostlek commented Aug 3, 2024

sorgfresser commented Aug 4, 2024

sorgfresser commented Apr 15, 2024 •

edited by c0ffeeca7

Loading

netlify bot commented Apr 15, 2024 •

edited

Loading

coderabbitai bot commented Jul 31, 2024 •

edited

Loading

CodeRabbit Configuration File (`.coderabbit.yaml`)

sorgfresser Jul 31, 2024 •

edited

Loading