search

deepgram / deepgram-dotnet-sdk

.NET SDK for Deepgram's automated speech recognition APIs.
https://developers.deepgram.com
MIT License
28 stars 32 forks source link

Implement TTS WS #309

Closed dvonthenen closed 2 months ago

dvonthenen commented 2 months ago

Implements/Addresses: https://github.com/deepgram/deepgram-dotnet-sdk/issues/306

This PR implements TTS WS. In this PR, I restructured the Speak/TTS clients because we are introducing a WS Client, and the REST client was at the root of the Deepgram.<Clients | Models>.Speak.v1 folder would place the REST and WS client in the same namespace. This is awkward and can be confusing. This follows the Go SDK, which places each into the respective namespaces:

The REST client has been renamed SpeakClient -> SpeakRESTClient. References to the old (now obsolete) REST client in Deepgram.<Clients | Models>.Speak.v1 references have been marked obsolete but still exist for backward compatibility. The references to the examples for the Speak REST clients are intentionally pointing to the obsolete namespaces to prove backwards compatibility. These will be updated in a subsequent PR.

This implements a simple example to demonstrate the functionality and updates the Speak REST unit tests.

The README was NOT updated because they need to be updated for Listen and Speak. Will do so in a subsequent PR.

Summary by CodeRabbit

coderabbitai[bot] commented 2 months ago

Walkthrough

The recent changes involved significant updates and restructuring within the Deepgram project. Mainly, new projects for REST and WebSocket clients were added, the Speak project was deprecated in favor of SpeakREST and SpeakWebSocket clients, and tests were updated accordingly. Additionally, new constants and schema classes specific to REST and WebSocket communication were introduced. This refactor aims to modularize the API client types and improve clarity and extensibility.

Changes

Files/Paths Change Summaries
Deepgram.Dev.sln Removed Speak projects and added rest, websocket, simple, Factory projects.
Deepgram.Tests/UnitTests/ClientTests/SpeakClientTests.cs Updated namespaces and classes from SpeakClient to SpeakRESTClient.
Deepgram/ClientFactory.cs Deprecated CreateSpeakClient in favor of CreateSpeakRESTClient and added CreateSpeakWebSocketClient.
Deepgram/Clients/Interfaces/v1/ISpeakClient.cs Deprecated ISpeakClient interface.
Deepgram/Clients/Interfaces/v1/ISpeakRESTClient.cs Introduced ISpeakRESTClient interface with methods for processing audio files.
Deepgram/Clients/Interfaces/v1/ISpeakWebSocketClient.cs Updated ISpeakWebSocketClient interface with methods for WebSocket interactions.
Deepgram/Clients/Live/v1/Client.cs Updated log message semantics.
Deepgram/Clients/Speak/v1/REST/... Added Client.cs, Constants.cs to define REST client and constants.
Deepgram/Models/Authenticate/v1/DeepgramWsClientOptions.cs Updated log messages from REST to WS base address.
Deepgram/Models/Speak/v1/AsyncResponse.cs Deprecated AsyncResponse class, merged into REST namespace.
Deepgram/Clients/Speak/v1/WebSocket/v1/... Added Client.cs, Constants.cs, ResponseEvent.cs, UriSegments.cs for WebSocket.
Deepgram/Models/Speak/v1/REST/SpeakSchema.cs Added SpeakSchema for REST audio processing.
Deepgram/Models/Speak/v1/WebSocket/v1/... Added CommandSource.cs, ErrorResponse.cs, FlushedResponse.cs, MetadataResponse.cs, OpenResponse.cs, SpeakSchema.cs, SpeakType.cs, TextSource.cs.
examples/speak/websocket/simple/Speak.csproj Added new project file for WebSocket example with a reference to Deepgram.

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

@coderabbitai review

coderabbitai[bot] commented 2 months 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.