docs: add the clarification of choosing the models#122
Conversation
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Workflows to automatically generate PRs for you. |
|
Warning Review limit reached
More reviews will be available in 29 minutes and 52 seconds. Learn how PR review limits work. Your organization has run out of usage credits. Purchase more in the billing tab. ⌛ How to resolve this issue?After more reviews become available, a review can be triggered using the We recommend that you space out your commits to avoid hitting the rate limit. 🚦 How do rate limits work?CodeRabbit enforces hourly rate limits for each developer per organization. Our paid plans include higher PR review limits than trial, open-source, and free plans. In all cases, reviews become available again over time. During sustained high-volume PR review activity, CodeRabbit may temporarily slow when the next review becomes available. Please see our Fair Usage Limits Policy for further information. ℹ️ Review info⚙️ Run configurationConfiguration used: defaults Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (2)
📝 WalkthroughWalkthroughAdds a reusable ChooseModel MDX tip, integrates it into the POST /v2/pre-recorded API reference and the pre-recorded STT Quickstart, and updates JavaScript/Python and API examples to set ChangesPre-recorded STT model selection documentation
Estimated code review effort🎯 3 (Moderate) | ⏱️ ~20 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)
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. Comment |
There was a problem hiding this comment.
Actionable comments posted: 2
♻️ Duplicate comments (1)
snippets/choose-model.mdx (1)
4-5:⚠️ Potential issue | 🟠 Major | ⚡ Quick winClarify model capabilities more explicitly.
The current descriptions leave ambiguity about which model supports which features:
- Does
solaria-3support code switching? The phrasing "code switching" only appears next tosolaria-1, but the quickstart examples usecode_switching: truewithsolaria-3.- Which specific EU languages does
solaria-3cover?- Can
solaria-1handle EU languages effectively?A previous review comment from karamouche raised similar concerns about making language availability and code switching support more explicit.
Consider restructuring to clearly state what each model supports, for example:
- "solaria-3 — our latest model (best-in-class for EU languages: en, fr, de, es, it...)"
- "solaria-1 — our generalist model (100+ languages, code-switching support)"
Or explicitly note capabilities for both models if they share features.
🤖 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 `@snippets/choose-model.mdx` around lines 4 - 5, Update the model descriptions to explicitly state capabilities for each model: for "solaria-3" and "solaria-1" indicate whether they support code-switching (referencing the quickstart key code_switching), list representative EU languages supported by "solaria-3" (e.g., en, fr, de, es, it) or say "major EU languages" if exhaustive list isn't available, and clarify that "solaria-1" is a generalist model supporting 100+ languages and code-switching; replace ambiguous phrases in the existing lines for "solaria-3" and "solaria-1" with these explicit capability statements so readers know language coverage and code-switching support for each model.
🤖 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 `@chapters/pre-recorded-stt/quickstart.mdx`:
- Line 79: The documentation has mismatched model and code_switching flags:
instances where model: "solaria-3" are paired with code_switching: true; update
those SDK snippet blocks so they are consistent by either changing model:
"solaria-3" to model: "solaria-1" when code_switching: true, or change
code_switching: true to code_switching: false when keeping model: "solaria-3";
search for occurrences of model: "solaria-3" together with code_switching and
update the examples in quickstart.mdx to match the choose-model guidance.
In `@snippets/choose-model.mdx`:
- Around line 4-5: Update the compound modifiers in the model descriptions:
change the phrase "best-in class" in the `"solaria-3"` description to
"best-in-class" and change "code switching" in the `"solaria-1"` description to
"code-switching" so both compound adjectives are correctly hyphenated when used
before the noun.
---
Duplicate comments:
In `@snippets/choose-model.mdx`:
- Around line 4-5: Update the model descriptions to explicitly state
capabilities for each model: for "solaria-3" and "solaria-1" indicate whether
they support code-switching (referencing the quickstart key code_switching),
list representative EU languages supported by "solaria-3" (e.g., en, fr, de, es,
it) or say "major EU languages" if exhaustive list isn't available, and clarify
that "solaria-1" is a generalist model supporting 100+ languages and
code-switching; replace ambiguous phrases in the existing lines for "solaria-3"
and "solaria-1" with these explicit capability statements so readers know
language coverage and code-switching support for each model.
🪄 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: 486187a9-9630-4fe4-ab99-c3e26a0b7ef9
📒 Files selected for processing (3)
api-reference/v2/pre-recorded/init.mdxchapters/pre-recorded-stt/quickstart.mdxsnippets/choose-model.mdx
Summary by CodeRabbit