Document HostedVoiceCloneConfig for pipecat and livekit plugins - #26
Open
serhatzx wants to merge 2 commits into
Open
Document HostedVoiceCloneConfig for pipecat and livekit plugins#26serhatzx wants to merge 2 commits into
serhatzx wants to merge 2 commits into
Conversation
Contributor
📝 WalkthroughWalkthroughThis PR adds documentation for the new ChangesVoice Cloning Configuration Documentation
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~3 minutes Possibly related PRs
Suggested reviewers
Poem
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Comment |
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Workflows to automatically generate PRs for you. |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
Contributor
There was a problem hiding this comment.
Actionable comments posted: 2
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@livekit.mdx`:
- Line 153: The documented duration for the HostedVoiceClone audio sample is
incorrect; update the `audio_data` field description (the table entry currently
saying "10 to 15 seconds of speech") to "20 to 25 seconds of speech" in both
places it appears (the occurrences around the HostedVoiceClone/audio_data
examples), and ensure any sample snippets or examples referencing "10 to 15
seconds" are changed to "20 to 25 seconds" so the docs match the upstream schema
and avoid untested example misconfiguration.
In `@pipecat.mdx`:
- Line 185: Update the documented required duration for the `audio_data`
clone-sample from "10 to 15 seconds" to "20 to 25 seconds" in both places where
it appears (the two entries describing `audio_data` in the clone-sample/hosted
clone schema) so the docs match the hosted clone schema; do not add any example
code snippets that are untested while making this text change.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
Contributor
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@api-reference/realtime.mdx`:
- Line 620: The documentation changes at lines 620 and 661 in
api-reference/realtime.mdx now specify "10 to 15 seconds" for
HostedVoiceCloneV1.audio_data, but the HostedVoiceCloneV1.audio_data field
definition in api-reference/realtime.proto still documents "20 to 25 seconds".
Resolve this contract mismatch by choosing one as the source of truth: either
update the protobuf schema specification for HostedVoiceCloneV1.audio_data in
api-reference/realtime.proto to "10 to 15 seconds" to match the documentation,
or revert the documentation changes at lines 620 and 661 back to "20 to 25
seconds" to match the proto specification. Ensure all references across both
files use the same duration range consistently.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: defaults
Review profile: CHILL
Plan: Pro
Run ID: 0b2a0305-fe16-4810-a9d6-79bddaa9a566
📒 Files selected for processing (1)
api-reference/realtime.mdx
|
|
||
| <Note> | ||
| Use 20 to 25 seconds of clean speech for `voice_clone_v1.audio_data`. In JSON, protobuf `bytes` fields are base64-encoded; binary protobuf clients send the raw audio bytes. | ||
| Use 10 to 15 seconds of clean speech for `voice_clone_v1.audio_data`. In JSON, protobuf `bytes` fields are base64-encoded; binary protobuf clients send the raw audio bytes. |
Contributor
There was a problem hiding this comment.
Align HostedVoiceCloneV1.audio_data duration with the protobuf contract.
Line 620 and Line 661 now document 10–15 seconds, but api-reference/realtime.proto for HostedVoiceCloneV1.audio_data still specifies 20–25 seconds. This creates a contract mismatch between API reference and schema for the same field.
Please make one source of truth and update the other side in the same change (either docs back to 20–25 or proto+related docs to 10–15 consistently).
Also applies to: 661-661
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In `@api-reference/realtime.mdx` at line 620, The documentation changes at lines
620 and 661 in api-reference/realtime.mdx now specify "10 to 15 seconds" for
HostedVoiceCloneV1.audio_data, but the HostedVoiceCloneV1.audio_data field
definition in api-reference/realtime.proto still documents "20 to 25 seconds".
Resolve this contract mismatch by choosing one as the source of truth: either
update the protobuf schema specification for HostedVoiceCloneV1.audio_data in
api-reference/realtime.proto to "10 to 15 seconds" to match the documentation,
or revert the documentation changes at lines 620 and 661 back to "20 to 25
seconds" to match the proto specification. Ensure all references across both
files use the same duration range consistently.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary by CodeRabbit
tts_configsupport, including hosted voice cloning viaHostedVoiceCloneConfig.