Skip to content

docs: add the clarification of choosing the models#122

Merged
egenthon-cmd merged 8 commits into
mainfrom
docs/add-model-choice
Jun 9, 2026
Merged

docs: add the clarification of choosing the models#122
egenthon-cmd merged 8 commits into
mainfrom
docs/add-model-choice

Conversation

@egenthon-cmd

@egenthon-cmd egenthon-cmd commented Jun 8, 2026

Copy link
Copy Markdown
Contributor

Summary by CodeRabbit

  • Documentation
    • Added a model-selection UI and guidance across API reference and quickstart
    • Clarified supported transcription models and default fallback behavior
    • Updated examples to require an explicit model and a single-language setting for the new recommended model
    • Added a tip explaining model choices and language-config requirements for pre-recorded transcription

@mintlify

mintlify Bot commented Jun 8, 2026

Copy link
Copy Markdown
Contributor

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated (UTC)
gladia 🟢 Ready View Preview Jun 8, 2026, 6:19 PM

💡 Tip: Enable Workflows to automatically generate PRs for you.

Comment thread chapters/live-stt/quickstart.mdx Outdated
Comment thread chapters/live-stt/quickstart.mdx Outdated
Comment thread chapters/migrations/from-assembly.mdx Outdated
Comment thread chapters/migrations/from-deepgram.mdx
Comment thread snippets/choose-model.mdx Outdated
@coderabbitai

coderabbitai Bot commented Jun 8, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

Warning

Review limit reached

@egenthon-cmd, we couldn't start this review because you've reached your PR review rate limit.

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 @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

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 configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 63a67eb2-2c5e-4fa1-b69e-4e63ed155b22

📥 Commits

Reviewing files that changed from the base of the PR and between 18de140 and 7eecb59.

📒 Files selected for processing (2)
  • chapters/live-stt/quickstart.mdx
  • snippets/choose-model.mdx
📝 Walkthrough

Walkthrough

Adds 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 model: "solaria-3" with a single-language language_config.languages: ["fr"].

Changes

Pre-recorded STT model selection documentation

Layer / File(s) Summary
Model selection tip documentation
snippets/choose-model.mdx
New MDX <Tip> explaining how to pass model in pre-recorded requests, listing solaria-3 and solaria-1 and describing default fallback behavior.
API reference integration
api-reference/v2/pre-recorded/init.mdx
Imports and renders the ChooseModel component on the POST /v2/pre-recorded API reference page.
Quickstart integration and example updates
chapters/pre-recorded-stt/quickstart.mdx
Adds ChooseModel to both SDK and API Quickstart sections; updates JS/Python SDK "transcribe" and "create transcription job" examples and API fetch/cURL examples to include model: "solaria-3" and language_config.languages: ["fr"]; adds a note requiring exactly one language for solaria-3.

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~20 minutes

Possibly related PRs

  • gladiaio/docs#38: Related edits to language_config guidance and code-switching behavior.
  • gladiaio/docs#112: Prior Quickstart restructuring touching the same quickstart content.
  • gladiaio/docs#52: Related updates to pre-recorded STT language guidance and snippets.

Suggested reviewers

  • lrossillon-gladia
  • nmorel

Poem

🐰 Hopping through docs with tiny paws,

I plant a tip to clarify the laws,
Solaria chosen, one tongue to sing,
Examples updated — let the transcriptions ring!

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title 'docs: add the clarification of choosing the models' accurately describes the main change—adding model selection UI and documentation across documentation pages.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch docs/add-model-choice

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

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

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 2

♻️ Duplicate comments (1)
snippets/choose-model.mdx (1)

4-5: ⚠️ Potential issue | 🟠 Major | ⚡ Quick win

Clarify model capabilities more explicitly.

The current descriptions leave ambiguity about which model supports which features:

  1. Does solaria-3 support code switching? The phrasing "code switching" only appears next to solaria-1, but the quickstart examples use code_switching: true with solaria-3.
  2. Which specific EU languages does solaria-3 cover?
  3. Can solaria-1 handle 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

📥 Commits

Reviewing files that changed from the base of the PR and between 20dd057 and 57f126e.

📒 Files selected for processing (3)
  • api-reference/v2/pre-recorded/init.mdx
  • chapters/pre-recorded-stt/quickstart.mdx
  • snippets/choose-model.mdx

Comment thread chapters/pre-recorded-stt/quickstart.mdx
Comment thread snippets/choose-model.mdx Outdated
Comment thread chapters/pre-recorded-stt/quickstart.mdx Outdated
Comment thread chapters/pre-recorded-stt/quickstart.mdx Outdated
Comment thread chapters/pre-recorded-stt/quickstart.mdx Outdated
Comment thread snippets/choose-model.mdx Outdated
Comment thread snippets/choose-model.mdx Outdated
@egenthon-cmd egenthon-cmd merged commit 336ca00 into main Jun 9, 2026
8 checks passed
@egenthon-cmd egenthon-cmd deleted the docs/add-model-choice branch June 9, 2026 15:37
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants