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

creating speak streaming client and api #239

Closed SandraRodgers closed 2 months ago

SandraRodgers commented 2 months ago

Summary by CodeRabbit

These changes enhance the text-to-speech functionality, provide better error handling, and introduce examples for easier implementation.

coderabbitai[bot] commented 2 months ago

Walkthrough

The overall changes introduce significant enhancements to the Deepgram SDK for text-to-speech streaming. New constants, error-handling mechanisms, struct types, and response types are added. The updates include default callback handlers, message routing logic, and a refined client streaming interface, thus providing a more robust foundation for implementing voice and text-based processing solutions.

Changes

Files Change Summary
pkg/api/speak/v1/constants.go Added error constants ErrInvalidMessageType, ErrUserCallbackNotDefined.
pkg/api/speak/v1/default.go Introduced default callback handler for live transcription, including various event handling functions.
pkg/api/speak/v1/interfaces/constants.go Added message type constants for the text-to-speech streaming API.
pkg/api/speak/v1/interfaces/interfaces.go Defined SpeakMessageCallback interface with methods for handling text-to-speech response types.
pkg/api/speak/v1/interfaces/types.go Added several struct types, including SpeakStreamResponse and different response types.
pkg/api/speak/v1/router.go Introduced MessageRouter struct for handling various message types and routing messages to appropriate callback methods.
pkg/api/version/constants.go Added APITypeSpeakStream and updated APIPathMap to include new API type "speak-stream".
pkg/api/version/speakstream-version.go New file introducing GetSpeakStreamAPI function for managing versioning and customization of the text-to-speech API.
pkg/client/interfaces/types-speak.go Updated SpeakOptions struct to include Callback and CallbackMethod fields.
pkg/client/speak/constants.go Added constants for retry mechanisms, error constants, and a new error related to connection validity.
pkg/client/speak/client_stream.go Enhanced streaming client implementation with functions for websocket connection, retries, event handling, and connection lifecycle management.
examples/speak/stream/http/main.go Renamed Transcription options to TTS options in the main function.
examples/speak/stream/interactive/main.go New file implementing an example for text-to-speech using the Deepgram SDK, with user interaction and callback handling.
pkg/api/speak-stream/v1/constants.go Added error constants for input validation and callback definition in the Deepgram SDK.
pkg/api/speak-stream/v1/default.go Introduced a default callback handler for text-to-speech connections, handling various events with debug logging.
pkg/api/speak-stream/v1/interfaces/constants.go Added message type constants for the text-to-speech streaming API.
pkg/api/speak-stream/v1/interfaces/interfaces.go Defined SpeakMessageCallback interface with methods for handling text-to-speech response types.
pkg/api/speak-stream/v1/interfaces/types.go Added request and response structs for the speech streaming API, including SpeakStreamResponse and various response types.

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.
dvonthenen commented 2 months ago

Just in case this got lost: https://github.com/deepgram/deepgram-go-sdk/pull/239#pullrequestreview-2128437923

dvonthenen commented 2 months ago

This is ready to go, but we need to merge this PR https://github.com/deepgram/deepgram-go-sdk/pull/245 and cut a release before merging this one.

dvonthenen commented 2 months ago

Hold this for right now, but I think we are in the clear.

I am going to need to port/code some things over from these PRs: https://github.com/deepgram/deepgram-go-sdk/pull/243 and https://github.com/deepgram/deepgram-go-sdk/pull/245

Will do that when tackling this: https://github.com/deepgram/deepgram-go-sdk/issues/241

We should be good for the release then.