Document for multiple speaker

[Kilerd]

Summary by CodeRabbit

Release Notes

• Documentation
  • Updated Text-to-Speech API documentation with revised multi-speaker guidance. Users should now use <|speaker:N|> token format (e.g., <|speaker:0|>, <|speaker:1|>) when specifying speakers in TTS requests.

[coderabbitai]

Caution

Review failed

The pull request is closed.

ℹ️ Recent review info

⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: c66f878d-ab09-40c8-a03a-b6a1bc413953

📥 Commits

Reviewing files that changed from the base of the PR and between 5f28366 and 5643504.

📒 Files selected for processing (1)

• api-reference/openapi.json

---

📝 Walkthrough

Walkthrough

The PR updates the TTSRequest schema in the OpenAPI specification to replace the multi-speaker tagging syntax. The old format using speaker reference_id and inline [0]/[1] tags is replaced with new <|speaker:N|> token syntax, along with updated example payloads to reflect this change.

Changes

Cohort / File(s)	Summary
OpenAPI Schema Updates api-reference/openapi.json	Updated TTSRequest schema description to reflect new multi-speaker tagging syntax using `<

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Possibly related PRs

• fix: improve docs for openapi.json, expose new params for tts #28: Modifies the same TTSRequest schema in api-reference/openapi.json to add/centralize schema fields while this PR updates its description, speaker-tag syntax, and examples.

Poem

🐰 A speaker's voice, now tagged with care,
New tokens dance through the schemas there,
From brackets old to <|speaker:N|> bright,
The API hops toward cleaner light! 🎤✨

✨ Finishing Touches

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Commit unit tests in branch document-for-multiple-speaker

📝 Coding Plan

• Generate coding plan for human review comments

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

Tip

CodeRabbit can use TruffleHog to scan for secrets in your code with verification capabilities.

Add a TruffleHog config file (e.g. trufflehog-config.yml, trufflehog.yml) to your project to customize detectors and scanning behavior. The tool runs only when a config file is present.