Feat/updating documentation for Gnani #6004
Open
Gnani-AI-Mintlify wants to merge 2 commits into
Open
Conversation
Gnani-AI-Mintlify
commented
Jun 8, 2026
Gnani-AI-Mintlify
commented
Contributor
- Clarify STT usage as REST and ASR (real-time streaming).
- Remove detailed STT/TTS access-method tables from the Gnani README.
- Keep concise code examples for stt.recognize(), stt.stream(), and TTS synthesize/stream flows.
- Removing the usage of organization_id and user_id.
…ey, update README for supported languages
…y synthesis transport options
![devin-ai-integration[bot]](https://avatars.githubusercontent.com/in/811515?s=60&v=4){kind=small}
Comment on lines
107
to
110
| api_key: str | None = None, | ||
| sample_rate: int = SAMPLE_RATE_16K, | ||
| base_url: str = GNANI_STT_BASE_URL, | ||
| organization_id: str | None = None, | ||
| user_id: str | None = None, | ||
| http_session: None = None, |
Contributor
There was a problem hiding this comment.
🚩 Breaking API change — removal of constructor parameters
This PR removes organization_id and user_id keyword arguments from STT.__init__(). Any existing user code that passes these parameters (e.g. STT(api_key=..., organization_id=..., user_id=...)) will get an unexpected keyword argument TypeError at runtime after upgrading. The README includes a migration note advising users to remove these parameters, which is appropriate for a breaking change. Consider whether this warrants a major version bump or a deprecation period with warnings before hard removal.
(Refers to lines 103-110)
Was this helpful? React with 👍 or 👎 to provide feedback.
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.