fix: added readme files and updated timeouts#17
Conversation
|
Warning Rate limit exceeded
Your organization is not enrolled in usage-based pricing. Contact your admin to enable usage-based pricing to continue reviews beyond the rate limit, or try again in 16 minutes and 40 seconds. ⌛ How to resolve this issue?After the wait time has elapsed, 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 have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout. Please see our FAQ for further information. ℹ️ Review info⚙️ Run configurationConfiguration used: defaults Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (1)
📝 WalkthroughWalkthroughDocumentation updates in JavaScript and Python SDKs clarify API key and region configuration, require Node.js 20+ or Bun, add detailed pre-recorded and live transcription examples (including explicit audio/session fields), and increase pre-recorded Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~12 minutes Poem
🚥 Pre-merge checks | ✅ 3✅ Passed checks (3 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 |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 3
🧹 Nitpick comments (1)
packages/sdk-python/README.md (1)
35-63: Use one term consistently: “pre-recorded” vs “prerecorded.”Line 35–63 mixes variants in nearby sections, which makes docs feel inconsistent. Pick one form for headings/body text and keep method names as-is (
prerecorded*).🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@packages/sdk-python/README.md` around lines 35 - 63, Standardize the wording to "pre-recorded" in the README body and headings while preserving the actual SDK method names (`prerecorded()` and `prerecorded_async()`) as-is; update the heading and any occurrences of "prerecorded" or "prerecorded transcription" in the prose to "pre-recorded" (e.g., the section title and descriptive sentences) but do not change or rename the function references `prerecorded().transcribe` or `prerecorded_async()` in code samples or API mentions.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@packages/sdk-js/README.md`:
- Line 7: Update the README sentence on line 7 to fix grammar and spacing:
change "For non-browser environment, you need either **Node.js 20+** or **Bun**
." to "For non-browser environments, use **Node.js 20+** or **Bun**." so
"environment" becomes plural, remove the extra space before the period, and
prefer "use" for terser wording; modify the exact sentence in README.md
accordingly.
- Around line 136-139: The README's live transcription section incorrectly
references pre-recorded "Audio intelligence" options and links; update the text
under the startSession/live config to describe the correct live-specific options
and remove or replace the pre-recorded Audio Intelligence link. Specifically,
modify the paragraph that tells users to "Pass the **options** argument"
(related to startSession) so it explains which live features and option keys are
supported for startSession (e.g., real-time diarization/translation/PII flags if
available) and point to the correct live-feature docs or a neutral description
of supported live options instead of the pre-recorded Audio Intelligence URL.
In `@packages/sdk-python/README.md`:
- Line 58: The sentence "Pass a **options** as second argument..." is
grammatically incorrect; update the README sentence to use correct article/noun
agreement—either "Pass **options** as the second argument to enable..." or "Pass
**an options object** as the second argument to enable..."—so replace the phrase
in the README (the line containing "Pass a **options** as second argument to
enable all the features...") with one of these corrected alternatives.
---
Nitpick comments:
In `@packages/sdk-python/README.md`:
- Around line 35-63: Standardize the wording to "pre-recorded" in the README
body and headings while preserving the actual SDK method names (`prerecorded()`
and `prerecorded_async()`) as-is; update the heading and any occurrences of
"prerecorded" or "prerecorded transcription" in the prose to "pre-recorded"
(e.g., the section title and descriptive sentences) but do not change or rename
the function references `prerecorded().transcribe` or `prerecorded_async()` in
code samples or API mentions.
🪄 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: 0682a0e0-6e18-4a1e-8caf-9697c204e1c2
📒 Files selected for processing (4)
packages/sdk-js/README.mdpackages/sdk-js/src/client.tspackages/sdk-python/README.mdpackages/sdk-python/src/gladiaio_sdk/client_options.py
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@packages/sdk-python/README.md`:
- Around line 56-58: Fix two minor grammar issues in the README: remove the
extra space before the exclamation in the phrase "See all the [supported
languages](https://docs.gladia.io/chapters/language/supported-languages) here !"
so it reads "here!", and add the article "the" in the sentence that references
options so "Pass the **options** as second argument" becomes "Pass the
**options** as the second argument" (update the line containing the Audio
intelligence link and the options wording).
🪄 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: da3f2c73-2645-4b97-9e22-4a8c1435af3b
📒 Files selected for processing (2)
packages/sdk-js/README.mdpackages/sdk-python/README.md
🚧 Files skipped from review as they are similar to previous changes (1)
- packages/sdk-js/README.md
2 participants
increase timeouts for create and delete methods
updated the readme files for python and javascript sdk
Summary by CodeRabbit