deepgram / deepgram-dotnet-sdk

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

Implement TTS and Other REST Refactor #245

Closed dvonthenen closed 6 months ago

dvonthenen commented 6 months ago

Addresses issue: https://github.com/deepgram/deepgram-dotnet-sdk/issues/244 Partially addresses: https://github.com/deepgram/deepgram-dotnet-sdk/issues/234

Major changes include:

There are TODOs for logging (and comments) which I will get back to when I have a logging mechanism with verbosity levels worked. Existing issues for Comments https://github.com/deepgram/deepgram-dotnet-sdk/issues/210 and Logging https://github.com/deepgram/deepgram-dotnet-sdk/issues/219 already exist as a reminder.

Summary by CodeRabbit

coderabbitai[bot] commented 6 months ago

Walkthrough

This update introduces a significant expansion and refinement to the .NET SDK for Deepgram, focusing on enhancing functionality around speech processing. Key additions include the introduction of a new Speak project, improvements to HTTP client configurations for better customization and thread safety, and the introduction of addons parameters across various client methods for extended functionality. The changes aim to provide more flexible and powerful tools for developers working with the Deepgram API for audio transcription and speech processing tasks.

Changes

Files Change Summary
Deepgram.Dev.sln Added "Speak" project
Deepgram.Tests/Fakes/MockHttpClient.cs Removed an empty line
Deepgram.Tests/Fakes/MockHttpMessageHandler.cs Added generic type parameter; removed line break
Deepgram.Tests/.../SpeakClientTests.cs Added unit tests for SpeakClient
Deepgram/Abstractions/AbstractRestClient.cs Added using directives; modified and added methods with addons parameter
Deepgram/Clients/Analyze/v1/Client.cs
Deepgram/Clients/Live/v1/Client.cs
Deepgram/Clients/Manage/v1/Client.cs
Deepgram/Clients/PreRecorded/v1/Client.cs
Updated methods to include addons parameter
Deepgram/Clients/Speak/v1/... Implemented SpeakClient and related classes for audio transcription
Deepgram/Models/... Updated and introduced models for Speak API
Deepgram/Utilities/QueryParameterUtil.cs Updated and added methods for query parameter handling
examples/speak/... Added examples demonstrating Speak API usage

Related issues

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.` - `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 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 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.