Fix Streaming/REST Functionality and Introduce Microphone Example

[davidvonthenen]

Fixes: https://github.com/deepgram/deepgram-dotnet-sdk/issues/222, https://github.com/deepgram/deepgram-dotnet-sdk/issues/194, and https://github.com/deepgram/deepgram-dotnet-sdk/issues/180

Changes:

• Fixes breaking all functionality on alpha.4 because of API Key issue. Tested Speak, Prerecorded and Live using Microphone.
• Introduces a Microphone example using portaudio
• Introduced Deepgram.Microphone and Deepgram.Microphone.Unstable builds on nuget
• Removed the LiveClientTests as none of the tests make sense anymore. WIll need to come up with new ones.

Summary by CodeRabbit

• New Features
  • Introduced a new Deepgram Microphone project for audio input handling.
  • Implemented functionality for real-time transcription from microphone audio streams.
• Enhancements
  • Updated API key handling across various clients to improve security and usability.
  • Improved audio processing with the initialization and termination of PortAudio.
  • Enhanced project configurations and paths for better organization and clarity.
• Bug Fixes
  • Fixed nullable types in models to ensure required values are provided, enhancing data integrity.
• Documentation
  • Updated project references and environment variable handling in example projects for a more streamlined setup.
• Chores
  • Added clean-up scripts for environment maintenance.
• Refactor
  • Renamed projects for better alignment with their functionality.
  • Updated constructors and method signatures across clients for consistency and simplicity.

[coderabbitai[bot]]

Walkthrough

This update encompasses a significant restructuring and enhancement of the Deepgram development environment, including renaming projects for clarity, adding numerous new projects to bolster the SDK's capabilities, and refining project paths and configurations for better organization and usability. Notably, it introduces the Deepgram.Microphone project, aimed at streamlining audio input handling. Furthermore, adjustments in unit tests and project settings reflect these broad changes, ensuring the SDK remains robust and well-documented.

Changes

Files	Change Summary
Deepgram.Dev.sln, Deepgram.DevBuild.sln, Deepgram.sln	Added new projects and updated project paths and configurations.
Deepgram.Microphone/*	Introduced Deepgram.Microphone project with classes for audio input handling using PortAudio.
Deepgram.Tests/*	Updated unit tests reflecting changes in project structure and configurations.
Deepgram/*	Major updates across various clients and models, including default parameter adjustments and API key handling.
clean-up.ps1, clean-up.sh	Added scripts for cleaning up project directories.
examples/*	Updated example projects to align with the SDK's structural changes and new features.

Assessment against linked issues

Objective	Addressed	Explanation
Unit Tests for UtteranceEnd and SpeechStarted (#222)	❓	While the summary indicates substantial changes across the project, including updates to unit tests, there's no explicit mention of tests for UtteranceEnd and SpeechStarted being added or updated. This makes it unclear if the specific objective of issue #222 has been directly addressed.

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.