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 `Finalize` and AutoFlush Functionality #311

Closed dvonthenen closed 2 months ago

dvonthenen commented 2 months ago

Addresses: https://github.com/deepgram/deepgram-dotnet-sdk/issues/296, https://github.com/deepgram/deepgram-dotnet-sdk/issues/276, https://github.com/deepgram/deepgram-dotnet-sdk/issues/250

This implements fixes for:

This also restructures the PreRecorded and LiveClient to place them under the Deepgram.Clients.Listen and for their Model objects, the Deepgram.Models.Listen. This preserves the backward compatibility of the older objects/constants/etc., with a warning to update them as they will be removed in a future version. This makes it so all projects referencing old objects will still build and run, allowing users to migrate at their convenience before the next major version.

Deepgram.Clients Changes

Since TTS WS was implemented this way, the STT Clients have been reorganized similarly. To demonstrate the approach for clients on this PR, the following changes were made to the clients.

The way it was before:

Deepgram
+-- Clients
       +-- PreRecorded
              +-- Client.cs
              +-- (other files like constants, etc)
       +-- live
              +-- Client.cs
              +-- (other files like constants, etc)
       ...

The files were moved into a pkg/client/<type>/v1 folder, and the pkg/client/<type> created backward-compatible links to artifacts in these new v1 folders.

Deepgram
+-- Clients
       +-- Listen
             +-- client.go (reference/pointer to v1 folder)
             +-- v1
                    +-- REST
                          +-- [MOVED] Client.cs
                          +-- [MOVED]  (other files like constants, etc)
                    +-- WebSocket
                          +-- [MOVED] Client.cs
                          +-- [MOVED]  (other files like constants, etc)
       +-- PreRecorded.v1
              +-- [DEPRECATED] All classes/enums/etc that were there are accessible/referencable, but extending the new `Listen/v1` objects.
       +-- Live.v1
              +-- [DEPRECATED] All classes/enums/etc that were there are accessible/referencable, but extending the new `Listen/v1` objects.
       ...

Deepgram.Models Changes

Since TTS WS is implemented this way, the STT Models are reorganized similarly. The implementation of TTS WS was done purposely so that this change could be made easily. These changes then follow the client in a similar fashion.

The way it was before:

Deepgram
+-- Models
      ...
       +-- PreRecorded.v1
              +-- SyncResponse.cs
              +-- (other files like constants, etc)
       +-- Live.v1
              +-- SyncResponse.cs
              +-- (other files like constants, etc)
       ...

The files were moved into a pkg/api/<type>v1 folder and the pkg/client/<type> created backward-compatible links to artifacts in these new v1 folders.

Deepgram
+-- Models
       +-- Listen
             +-- v1
                    +-- REST
                           +-- [MOVED] SyncResponse.cs
                           +-- [MOVED] (other files like constants, etc)
                    +-- WebSocket
                           +-- [MOVED] SyncResponse.cs
                           +-- [MOVED] (other files like constants, etc)
       +-- PreRecorded.v1
              +-- [DEPRECATED] All classes/enums/etc that were there are accessible/referencable, but extending the new `Listen/v1` objects.
       +-- Live.v1
              +-- [DEPRECATED] All classes/enums/etc that were there are accessible/referencable, but extending the new `Listen/v1` objects.
       ...

The users' code should remain unchanged, but now hint that there are deprecated packages in use to be removed at the next major release. This is what it will look like in the IDE/editor by way of a strikethrough (picture below) and this warning in the deprecated packages:

// *********** WARNING ***********
// This package provides <package functionality>...
//
// Deprecated: This package is deprecated. Use the <this new> package instead. This will be removed in a future release.
//
// This package is frozen and no new functionality will be added.
// *********** WARNING ***********

Screenshot 2024-06-28 at 10 04 45

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

coderabbitai[bot] commented 2 months ago

[!IMPORTANT]

Review skipped

More than 25% of the files skipped due to max files limit. The review is being skipped to prevent a low-quality review.

86 files out of 158 files are above the max files limit of 50. Please upgrade to Pro plan to get higher limits.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

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.