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 Client Interfaces and Factory Methods #274

Closed dvonthenen closed 4 months ago

dvonthenen commented 4 months ago

Addresses issue: https://github.com/deepgram/deepgram-dotnet-sdk/issues/273

This implements client interfaces and factory methods to instantiate each of these clients. The point of this PR is encapsulate the clients without needing to expose the internal details.

Examples are provided for each client type.

coderabbitai[bot] commented 4 months ago

Walkthrough

The recent updates to the Deepgram.Dev solution primarily involve the introduction of several client interfaces and their implementations across various services like Analyze, Live, Manage, OnPrem, PreRecorded, and Speak. Additionally, there are new example projects demonstrating the usage of these clients in different contexts such as streaming, managing, and analyzing audio data. These changes enhance the modularity and extend the functionality of the Deepgram SDK.

Changes

File Path Change Summary
Deepgram/ClientFactory.cs Introduced ClientFactory for creating service-specific clients.
Deepgram/Clients/.../v1/Client.cs Added implementations for various client interfaces.
Deepgram/Clients/Interfaces/v1/I*.cs Created interfaces for different clients (Analyze, Live, Manage, OnPrem, PreRecorded, Speak).
examples/.../factory_example/Factory.csproj Introduced .NET project configurations for various examples.
examples/.../factory_example/Program.cs Added functionality to utilize Deepgram SDK in different contexts (analyze, manage, speak, etc.).
examples/speak/file/.../Program.cs Enhanced JSON serialization for better output formatting.
examples/streaming/.../Program.cs Updated resource management by modifying the disposal of liveClient.
Recent Review Details **Configuration used: CodeRabbit UI**
Commits Files that changed from the base of the PR and between e32502d25dcb7a9babe9e0a0fd2cf9790ab0d46f and 39be7a6a07d2a3234adefcede98a93304b8b36ef.
Files ignored due to path filters (1) * `examples/prerecorded/factory_example/Bueller-Life-moves-pretty-fast.wav` is excluded by `!**/*.wav`
Files selected for processing (30) * Deepgram.Dev.sln (3 hunks) * Deepgram/ClientFactory.cs (1 hunks) * Deepgram/Clients/Analyze/v1/Client.cs (2 hunks) * Deepgram/Clients/Interfaces/v1/IAnalyzeClient.cs (1 hunks) * Deepgram/Clients/Interfaces/v1/ILiveClient.cs (1 hunks) * Deepgram/Clients/Interfaces/v1/IManageClient.cs (1 hunks) * Deepgram/Clients/Interfaces/v1/IOnPremClient.cs (1 hunks) * Deepgram/Clients/Interfaces/v1/IPreRecordedClient.cs (1 hunks) * Deepgram/Clients/Interfaces/v1/ISpeakClient.cs (1 hunks) * Deepgram/Clients/Live/v1/Client.cs (1 hunks) * Deepgram/Clients/Manage/v1/Client.cs (2 hunks) * Deepgram/Clients/OnPrem/v1/Client.cs (2 hunks) * Deepgram/Clients/PreRecorded/v1/Client.cs (2 hunks) * Deepgram/Clients/Speak/v1/Client.cs (3 hunks) * examples/analyze/factory_example/Factory.csproj (1 hunks) * examples/analyze/factory_example/Program.cs (1 hunks) * examples/analyze/factory_example/conversation.txt (1 hunks) * examples/manage/factory_example/Factory.csproj (1 hunks) * examples/manage/factory_example/Program.cs (1 hunks) * examples/prerecorded/factory_example/Factory.csproj (1 hunks) * examples/prerecorded/factory_example/Program.cs (1 hunks) * examples/speak/file/factory_example/Factory.csproj (1 hunks) * examples/speak/file/factory_example/Program.cs (1 hunks) * examples/speak/file/hello-world/Program.cs (2 hunks) * examples/speak/file/woodchuck/Program.cs (2 hunks) * examples/streaming/factory_example/Factory.csproj (1 hunks) * examples/streaming/factory_example/Program.cs (1 hunks) * examples/streaming/file/Program.cs (1 hunks) * examples/streaming/http/Program.cs (1 hunks) * examples/streaming/microphone/Program.cs (1 hunks)
Files skipped from review as they are similar to previous changes (29) * Deepgram.Dev.sln * Deepgram/ClientFactory.cs * Deepgram/Clients/Analyze/v1/Client.cs * Deepgram/Clients/Interfaces/v1/IAnalyzeClient.cs * Deepgram/Clients/Interfaces/v1/ILiveClient.cs * Deepgram/Clients/Interfaces/v1/IManageClient.cs * Deepgram/Clients/Interfaces/v1/IOnPremClient.cs * Deepgram/Clients/Interfaces/v1/IPreRecordedClient.cs * Deepgram/Clients/Interfaces/v1/ISpeakClient.cs * Deepgram/Clients/Live/v1/Client.cs * Deepgram/Clients/Manage/v1/Client.cs * Deepgram/Clients/OnPrem/v1/Client.cs * Deepgram/Clients/PreRecorded/v1/Client.cs * Deepgram/Clients/Speak/v1/Client.cs * examples/analyze/factory_example/Factory.csproj * examples/analyze/factory_example/Program.cs * examples/manage/factory_example/Factory.csproj * examples/manage/factory_example/Program.cs * examples/prerecorded/factory_example/Factory.csproj * examples/prerecorded/factory_example/Program.cs * examples/speak/file/factory_example/Factory.csproj * examples/speak/file/factory_example/Program.cs * examples/speak/file/hello-world/Program.cs * examples/speak/file/woodchuck/Program.cs * examples/streaming/factory_example/Factory.csproj * examples/streaming/factory_example/Program.cs * examples/streaming/file/Program.cs * examples/streaming/http/Program.cs * examples/streaming/microphone/Program.cs
--- 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.` 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 a review. This is useful when automatic reviews are disabled for the repository. - `@coderabbitai resolve` resolve all the CodeRabbit review comments. - `@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.