search

deepgram / deepgram-go-sdk

Go SDK for Deepgram's automated speech recognition APIs.
https://developers.deepgram.com
MIT License
31 stars 27 forks source link

Port WebSocket Threading Fixes `STT Live` -> `TTS Speak`, Port Fixes From `TTS Speak` -> `STT Live` #246

Closed dvonthenen closed 2 months ago

dvonthenen commented 2 months ago

Proposed changes

This ports fixes from the STT WebSocket to the TTS WebSocket client. Please see for more details: https://github.com/deepgram/deepgram-go-sdk/pull/243 https://github.com/deepgram/deepgram-go-sdk/pull/245

This also ports fixes made in TTS WebSocket -> STT WebSocket client made in this PR: https://github.com/deepgram/deepgram-go-sdk/pull/239

Some other notes on changes:

Tested STT and TTS examples!

Types of changes

What types of changes does your code introduce to the community Go SDK? Put an x in the boxes that apply

Checklist

Put an x in the boxes that apply. You can also fill these out after creating the PR. If you're unsure about any of them, don't hesitate to ask. We're here to help! This is simply a reminder of what we are going to look for before merging your code.

Further comments

NA

coderabbitai[bot] commented 2 months ago

[!WARNING]

Rate limit exceeded

@dvonthenen has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 47 minutes and 5 seconds before requesting another review.

How to resolve this issue? After the wait time has elapsed, a review can be triggered using the `@coderabbitai review` command as a PR comment. Alternatively, push new commits to this PR. 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](https://coderabbit.ai/docs/faq) for further information.
Commits Files that changed from the base of the PR and between ed94f7311d19930d48df026cb869041fa33b50da and ba6f8461b7935cc051b8b543e74f340f6ab601f4.

Walkthrough

The recent changes encompass a mix of adding new settings, refactoring code, simplifying file paths, and consolidating types for better code maintainability. Additionally, error message handling has been improved, constants have been updated, and new utility functions have been introduced for managing websocket connections and logging.

Changes

Files Change Summary
examples/prerecorded/file/main.go Added Utterances: true to Deepgram client configuration.
examples/speak/stream/interactive/main.go Removed AUDIO_DIR constant, simplified file path generation, removed SpeakStream method.
examples/streaming/microphone/main.go Changed error message to include ErrCode rather than Message.
pkg/api/live/v1/default.go Renamed error fields Type to ErrCode and Message to ErrMsg.
pkg/api/live/v1/interfaces/types.go Aliased LiveOptions and ErrorResponse to interfaces structs.
pkg/api/speak-stream/v1/interfaces/types.go Removed SpeakStreamResponse struct and its fields.
pkg/client/interfaces/utils.go Removed RequestID field from DeepgramError struct.
pkg/client/live/client.go Renamed log messages, added message type differentiation, new functions for managing websocket connections.
pkg/client/live/constants.go Added MessageTypeKeepAlive, removed MessageTypeCloseStream, added new error messages.
pkg/client/speak/client_stream.go Added new controlMessage type, updated function signatures, new websocket management functions.
pkg/client/speak/constants.go Added new message type constants and an error message, modified existing error constants.
Expanded Changes Table | Files | Change Summary | |---------------------------------------|-----------------------------------------------------------------------------| | `examples/prerecorded/file/main.go` | - Added `Utterances: true` to Deepgram client configuration. | | `examples/speak/stream/interactive/main.go` | - Removed `AUDIO_DIR` constant. - Simplified file path generation in `Binary` method of `MyCallback`. - Removed `SpeakStream` method. | | `examples/streaming/microphone/main.go` | - Changed error message in `MyCallback` function to include `ErrCode` instead of `Message` from `api.ErrorResponse`. | | `pkg/api/live/v1/default.go` | - Renamed error fields in `Error` struct within `DefaultCallbackHandler` from `Type` to `ErrCode` and from `Message` to `ErrMsg`. | | `pkg/api/live/v1/interfaces/types.go` | - Changed `type LiveOptions` to alias `interfaces.LiveTranscriptionOptions`. - Changed `type ErrorResponse` to alias `interfaces.DeepgramError`. | | `pkg/api/speak-stream/v1/interfaces/types.go` | - Removed `SpeakStreamResponse` struct and its fields (`ContentType`, `RequestID`, `ModelUUID`, `ModelName`, and `Date`). | | `pkg/client/interfaces/utils.go` | - Removed `RequestID` field from `DeepgramError` struct. | | `pkg/client/live/client.go` | - Changed log messages for clarity. - Added differentiation for message types (binary or text). - Modified error handling in various methods. - Changed the field name from `Message` to `ErrMsg` in the `errorToResponse` function for error response handling. | | `pkg/client/live/constants.go` | - Added `MessageTypeKeepAlive`, removed `MessageTypeCloseStream`. - Added error messages for `ErrInvalidInput` and `ErrInvalidConnection`. | | `pkg/client/speak/client_stream.go` | - Added `controlMessage` type. - Modified signatures for `Connect`, `ConnectWithCancel`, `AttemptReconnect`, `AttemptReconnectWithCancel`, `internalConnect`, and `internalConnectWithCancel` with an additional parameter. - Added functions `listen`, `closeStream`, `normalClosure`. - Updated `WriteJSON` logic. - Added `Reset` function. | | `pkg/client/speak/constants.go` | - Added new constants: `MessageTypeFlush`, `MessageTypeReset`, `MessageTypeClose`. - Added error message `UseOfClosedSocket`. - Modified error constants `ErrInvalidInput` and `ErrInvalidConnection`. |

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.