search

deepgram / deepgram-python-sdk

Official Python SDK for Deepgram's automated speech recognition APIs.
https://developers.deepgram.com
MIT License
178 stars 48 forks source link

adds TTS streaming clients #424

Closed SandraRodgers closed 2 days ago

SandraRodgers commented 4 days ago

Proposed changes

Summary by CodeRabbit

coderabbitai[bot] commented 4 days ago

Walkthrough

The recent enhancements to the Deepgram codebase involve the introduction of new classes for handling real-time speech synthesis via WebSockets. This includes the addition of SpeakStreamClient and AsyncSpeakStreamClient to enable synchronous and asynchronous interactions, respectively, along with event handling for various TTS synthesis events. Several new files and imports have been introduced to support these capabilities, and there are significant improvements to event handling logic in the asynchronous client.

Changes

File/Module Change Summary
deepgram/__init__.py Added imports for SpeakStreamClient, AsyncSpeakStreamClient, and SpeakStreamEvents.
deepgram/client.py Added SpeakStreamClient, AsyncSpeakStreamClient, SpeakStreamEvents imports; new properties speakstream and asyncspeakstream. Updated the v method to handle new cases.
deepgram/clients/__init__.py Added imports for SpeakStreamEvents, SpeakStreamClient, and AsyncSpeakStreamClient.
deepgram/clients/live/v1/async_client.py Updated event handling logic for adding handlers and optimized task creation and handling during event emission. Enhanced exception handling.
deepgram/clients/speak/__init__.py Added SpeakStreamClient, AsyncSpeakStreamClient exports, and imported SpeakStreamEvents.
deepgram/clients/speak/client.py Updated declarations of SpeakStreamClient and AsyncSpeakStreamClient to latest versions.
deepgram/clients/speak/enums.py New file defining SpeakStreamEvents enumeration.
deepgram/clients/speak/errors.py Updated error message in DeepgramTypeError class.
deepgram/clients/speak/v1/__init__.py Added imports for SpeakStreamClient and AsyncSpeakStreamClient.
deepgram/clients/speak/v1/async_client_stream.py New file introducing AsyncSpeakStreamClient with methods for managing TTS synthesis over WebSockets.
deepgram/clients/speak/v1/client_stream.py New file introducing SpeakStreamClient with methods and attributes for WebSocket-based TTS synthesis.
deepgram/clients/speak/v1/response.py Added new data classes for various response types (OpenResponse, MetadataResponse, FlushedResponse, etc.).
examples/speak-stream/async-interactive/main.py New example for setting up a client to interact with TTS service asynchronously, handling various events and data processing.
examples/speak-stream/interactive/main.py New example for setting up a client to interact with TTS service synchronously, handling several streaming events.

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 - [X](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)
Tips ### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit .` - `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 generate interesting stats about this repository and render them as a table.` - `@coderabbitai show all the console.log statements in this repository.` - `@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 as 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. Additionally, you can add `@coderabbitai ignore` anywhere in the PR description to prevent this PR from being reviewed. ### CodeRabbit Configration 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](https://docs.coderabbit.ai/guides/configure-coderabbit) 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](https://coderabbit.ai/docs) for detailed information on how to use CodeRabbit. - Join our [Discord Community](https://discord.com/invite/GsXnASn26c) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.
SandraRodgers commented 3 days ago

@coderabbitai review

coderabbitai[bot] commented 3 days ago
Actions performed Review triggered. > Note: CodeRabbit is an incremental review system and does not re-review already reviewed commits. This command is applicable only when automatic reviews are paused.
dvonthenen commented 2 days ago

It looks like the blackformatter doesnt error the unit tests out. Will fix in this in a subsequent PR.