Update Bhashini Integrations.md

[tanuprasad530]

• Changed the screenshot + step in the steps of 'Using open_ai for TTS' with corrected syntax of using the speech engine.

• Added a line clarifying the current limitation that this can only be used when the source and target languages are the same.

• Corrected step reference from Speech-to-Text to Text-to-Speech.

/close #532

Summary by CodeRabbit

• Documentation
  • Updated Bhashini integration guide with clarifications on OpenAI-based text-to-speech setup.
  • Added note that OpenAI TTS requires source and target languages to match.
  • Refreshed documentation visuals for improved clarity.

_{✏️ Tip: You can customize this high-level summary in your review settings.}

[coderabbitai]

📝 Walkthrough

Walkthrough

Documentation update to the Bhashini Integrations guide corrects the OpenAI speech engine parameter from open-ai to open_ai, adds a language parity requirement note, and updates the associated image reference with new URL and dimensions.

Changes

Cohort / File(s)	Summary
Documentation Update docs/5. Integrations/Bhashini Integrations.md	Corrects speech engine value from open-ai to open_ai in OpenAI TTS setup example; adds note clarifying language parity requirement; updates image URL and dimensions

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Possibly related PRs

• Update Bhashini Integrations.md #414 — Updates the same Bhashini Integrations documentation including OpenAI speech engine section and image assets.
• Update Bhashini Integrations.md #517 — Modifies Bhashini Integrations TTS documentation with OpenAI speech-engine usage and TTS setup steps.

Suggested reviewers

• SangeetaMishr
• Fawas003

Poem

🐰 A typo hops away today,
With hyphens replaced by underscores' way,
Languages matched, images bright and new,
Bhashini docs shine in clearer view! ✨

Pre-merge checks

❌ Failed checks (1 inconclusive)

Check name	Status	Explanation	Resolution
Title check	❓ Inconclusive	The title 'Update Bhashini Integrations.md' is vague and generic, using non-descriptive terms that don't convey the specific nature of the changes.	Consider using a more descriptive title such as 'Fix speech_engine syntax from open-ai to open_ai in Bhashini Integrations' to clearly reflect the main change.

✅ Passed checks (4 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Linked Issues check	✅ Passed	The pull request successfully addresses issue #532 by correcting the speech_engine value from open-ai to open_ai and updating the documentation accordingly.
Out of Scope Changes check	✅ Passed	All changes are directly related to issue #532: correcting the syntax, updating images, and adding clarification about language requirements for TTS.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

---

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

[github-actions]

🚀 Deployed on https://deploy-preview-537--glific-docs.netlify.app

[coderabbitai]

Actionable comments posted: 1

📜 Review details

Configuration used: defaults

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 742fb53 and d3e1617.

📒 Files selected for processing (1)

• docs/5. Integrations/Bhashini Integrations.md

🔇 Additional comments (2)

docs/5. Integrations/Bhashini Integrations.md (2)

139-140: Syntax correction for speech engine parameter is accurate.

The change from open-ai (hyphen) to open_ai (underscore) directly addresses issue #532 and provides the correct configuration value users should apply.

---

141-142: Language parity constraint clarification is clear and appropriately placed.

The note effectively communicates an important operational constraint—that OpenAI TTS currently requires source and target languages to be identical. This prevents user confusion and misconfiguration.

[coderabbitai]

⚠️ Potential issue | 🟡 Minor

🧩 Analysis chain

🏁 Script executed:

# Check screenshot URL accessibility
curl -sI https://github.com/user-attachments/assets/61d2884a-4dc4-4e36-bbe6-f8aa895a0cc1 | head -1

# Also check the file to see surrounding context
if [ -f "docs/5. Integrations/Bhashini Integrations.md" ]; then
  echo "=== File context around line 145 ==="
  sed -n '130,150p' "docs/5. Integrations/Bhashini Integrations.md"
fi

Repository: glific/docs

Length of output: 1167

---

Screenshot URL returns a redirect instead of direct content.

The screenshot URL (https://github.com/user-attachments/assets/61d2884a-4dc4-4e36-bbe6-f8aa895a0cc1) returns an HTTP 302 redirect rather than a 200 status. While the image may still load in browsers, consider linking directly to the image file or using a direct CDN URL for better reliability in documentation.

Additionally, the screenshot placement supports the general configuration instruction to set the speech engine to open_ai, but there is no evidence of a specific syntax correction being demonstrated at the referenced lines.

🤖 Prompt for AI Agents

In docs/5. Integrations/Bhashini Integrations.md around line 145, the embedded
screenshot uses a GitHub user-attachments URL that responds with a 302 redirect;
replace the image reference with a direct image/CDN URL (or commit the image to
the repo and reference it via raw.githubusercontent.com) so the link returns 200
and is reliably rendered, and add a short inline note or code snippet at the
same location showing the exact syntax to set the speech engine to "open_ai" to
make the configuration correction explicit.