deepgram / deepgram-dotnet-sdk

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

Refactor and Simplify Live Client #237

Closed davidvonthenen closed 9 months ago

davidvonthenen commented 9 months ago

Ths start to address issue to refactor and simplify the Live Client: https://github.com/deepgram/deepgram-dotnet-sdk/issues/235 and https://github.com/deepgram/deepgram-dotnet-sdk/issues/229

Changes:

Others changes not related to Live Client that I noticed while working on the refactor:

TODOs:

The Prerecorded and Live examples function correctly and the unit tests pass. Screenshot 2024-02-20 at 07 30 10

Summary by CodeRabbit

Summary by CodeRabbit

coderabbitai[bot] commented 9 months ago

Walkthrough

The recent updates involve significant refactoring across the Deepgram .NET SDK, focusing on simplifying the import structure, enhancing consistency in URI segment handling, and streamlining client classes for various functionalities like Analyze, Live, Manage, OnPrem, and PreRecorded services. Changes include renaming classes and methods, adjusting namespaces, and refining the way HTTP clients are managed and utilized. This overhaul aims to improve the SDK's maintainability, usability, and alignment with the latest API capabilities.

Changes

File(s) Summary
Deepgram.Dev.sln Updated to define projects and configurations for Debug and Release modes.
Deepgram.Tests/UnitTests/ClientTests/AbstractRestClientTests.cs,
Deepgram.Tests/UnitTests/ClientTests/ManageClientTest.cs
Updated import statements, removing Deepgram.Encapsulations and adding version-specific client imports.
Deepgram.Tests/UnitTests/ClientTests/AnalyzeClientTests.cs,
Deepgram/Clients/Analyze/v1/Client.cs,
Deepgram/Clients/Analyze/v1/UriSegments.cs
Refactored AnalyzeClient and updated URI segments and import statements.
Deepgram.Tests/UnitTests/ClientTests/LiveClientTests.cs,
Deepgram.Tests/UnitTests/ClientTests/PreRecordedClientTests.cs,
Deepgram/Clients/Live/v1/...,
Deepgram/Clients/PreRecorded/v1/...,
Deepgram/LiveClient.cs,
examples/streaming/Program.cs
Import updates, class and method renaming, and URI segment consistency improvements for Live and PreRecorded clients.
Deepgram/Clients/Manage/v1/...,
Deepgram/ManageClient.cs
Implemented version 1 of the Manage Client with updated import statements and functionality adjustments.
Deepgram/Clients/OnPrem/v1/...,
Deepgram/OnPremClient.cs
Introduced version 1 of the OnPrem Client with new URI segments and simplified client functionality.
Deepgram/Constants/...,
Deepgram/Factory/HttpClientFactory.cs
Namespace changes from Enums to Constants and updates in HTTP client management.
Deepgram/GlobalUsings.cs,
Deepgram/README.md,
README.md
Removed global usings for outdated namespaces and updated method names in documentation.
Deepgram/Models/Live/v1/... Added new properties and updated types in live transcription models.
Deepgram/Utilities/RequestContentUtil.cs,
examples/prerecorded/...
Made DEFAULT_CONTENT_TYPE public and updated project references and namespace usage in examples.

This table summarizes the key changes across the SDK, showcasing efforts to streamline the codebase and align it with current best practices and the Deepgram API's structure.

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: - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit .` - `Generate unit-tests for this file.` - 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 tests 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 from git and render them as a table.` - `@coderabbitai show all the console.log statements in this repository.` - `@coderabbitai read src/utils.ts and generate unit tests.` - `@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. - The JSON schema for the configuration file is available [here](https://coderabbit.ai/integrations/coderabbit-overrides.v2.json). - 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/coderabbit-overrides.v2.json` ### CodeRabbit Discord Community Join our [Discord Community](https://discord.com/invite/GsXnASn26c) to get help, request features, and share feedback.