Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Added speech-to-text node using Deepgram API #133

Merged
merged 3 commits into from
Nov 30, 2024

Conversation

shivsak
Copy link
Contributor

@shivsak shivsak commented Nov 27, 2024

Summary by CodeRabbit

  • New Features
    • Introduced the TranscribeSpeechToText class for audio transcription using the Deepgram API.
    • Expanded the public API to include the new transcription class.
  • Bug Fixes
    • Improved error handling for transcription requests to manage potential issues effectively.
  • Chores
    • Updated version number from 1.6.14 to 1.6.15 in project configuration.

Copy link
Contributor

coderabbitai bot commented Nov 27, 2024

Walkthrough

The changes introduce a new class, TranscribeSpeechToText, in the athina/steps/transcribe_speech_to_text.py file, which is designed to transcribe audio files into text using the Deepgram API. Additionally, the __init__.py file is updated to include this new class in the module's public API by modifying the __all__ list. The project version is also incremented from "1.6.14" to "1.6.15".

Changes

File Change Summary
athina/steps/init.py Added import for TranscribeSpeechToText, updated __all__ list to include it.
athina/steps/transcribe_speech_to_text.py Introduced TranscribeSpeechToText class, implemented execute method for audio transcription.
pyproject.toml Updated version from "1.6.14" to "1.6.15".

Poem

In a world of sound, where whispers play,
A rabbit hops forth, to transcribe the day.
With Deepgram's magic, words take flight,
From audio to text, a wondrous sight!
So let us rejoice, in this new delight,
For every soft murmur, now shines so bright! 🐇✨


📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 5134253 and da3ea99.

📒 Files selected for processing (1)
  • pyproject.toml (1 hunks)
✅ Files skipped from review due to trivial changes (1)
  • pyproject.toml

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 3

🧹 Outside diff range and nitpick comments (1)
athina/steps/transcribe_speech_to_text.py (1)

27-27: Adjust type hint for 'language' parameter

The language attribute is declared as Optional[str] with a default value of "en". Since it has a default value and is not intended to be None, it should be typed as str instead of Optional[str].

Apply this diff to change the type hint:

-    language: Optional[str] = "en"
+    language: str = "en"
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 1d62cf9 and 5134253.

📒 Files selected for processing (2)
  • athina/steps/__init__.py (2 hunks)
  • athina/steps/transcribe_speech_to_text.py (1 hunks)
🔇 Additional comments (2)
athina/steps/__init__.py (2)

14-14: LGTM! Import statement follows module conventions.

The import statement correctly imports the new TranscribeSpeechToText class and follows the established import pattern.


33-34: LGTM! Proper all list update.

The TranscribeSpeechToText class is correctly added to the __all__ list, maintaining alphabetical order and consistent formatting.

athina/steps/transcribe_speech_to_text.py Show resolved Hide resolved
athina/steps/transcribe_speech_to_text.py Show resolved Hide resolved
athina/steps/transcribe_speech_to_text.py Show resolved Hide resolved
vivek-athina
vivek-athina previously approved these changes Nov 29, 2024
Copy link
Collaborator

@vivek-athina vivek-athina left a comment

Choose a reason for hiding this comment

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

Please rebase with main and bump up the version

@vivek-athina vivek-athina merged commit 125a9b4 into main Nov 30, 2024
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