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

Implements Analyze Client #217

Closed dvonthenen closed 8 months ago

dvonthenen commented 8 months ago

Addresses Issues: https://github.com/deepgram/deepgram-dotnet-sdk/issues/158, https://github.com/deepgram/deepgram-dotnet-sdk/issues/157, https://github.com/deepgram/deepgram-dotnet-sdk/issues/156, https://github.com/deepgram/deepgram-dotnet-sdk/issues/155

This implements Analyze Client using PreRecorded Client as a template. This should be working... just need the unit tests and examples to make sure they do.

TODOs: will add unit tests and examples in subsequent PRs

Summary by CodeRabbit

coderabbitai[bot] commented 8 months ago

Walkthrough

The recent updates focus on enhancing the Deepgram SDK's functionality and organization. Key improvements include the introduction of the AnalyzeClient for Read API interactions, addition of AnalyzeSchema for detailed transcription requests, and restructuring of import statements across various models to accommodate versioning. These changes streamline the SDK's usability for developers, ensuring more efficient handling of transcription tasks and management operations within the Deepgram ecosystem.

Changes

File(s) Change Summary
.../UtilitiesTests/QueryParameterUtilTests.cs, Log.cs Updated import statement from Deepgram.Models.Manage to Deepgram.Models.Manage.v1.
AnalyzeClient.cs Introduced ReadClient class with methods for file transcription via various sources, including callback options for asynchronous tasks.
Constants/UriSegments.cs Added ANALYZE constant with value "read".
ManageClient.cs Reorganized import statements for Manage and Authenticate modules.
Deepgram/Models/Analyze/v1/... Introduced new classes and records in the Analyze.v1 namespace for detailed transcription handling.
Deepgram/Models/Live/v1/... Converted classes to records for Average, SpeechStartedResponse, and UtteranceEndResponse.
Deepgram/Models/Manage/v1/... Fixed missing semicolons, updated namespace declarations, and improved class declaration syntax.
Deepgram/Models/PreRecorded/v1/... Made various updates including semicolon corrections, class-to-record conversions, and property type renaming.

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.
dvonthenen commented 8 months ago

@coderabbitai review