search

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

Add Manage API Examples and Fix Formatting in Other Examples #260

Closed dvonthenen closed 6 months ago

dvonthenen commented 6 months ago

Addresses issue: https://github.com/deepgram/deepgram-dotnet-sdk/issues/192

This introduces examples for the Manage APIs and includes CRUD examples for:

The intended flow for the example applications follows CRUD:

  1. list all objects (this would be keys or members or etc)
  2. create an object
  3. get the created object to verify it was successful
  4. delete the object
  5. list all objects to make sure it was deleted

Not all of these examples can follow this flow exactly because the operation may be destructive. In that case, the example with either excit early with a warning OR show you how to call the function as non-active AKA commented out code.

Summary by CodeRabbit

coderabbitai[bot] commented 6 months ago

Walkthrough

The update introduces significant enhancements across the Deepgram .NET SDK, focusing on extending functionality and refining data handling. Key areas of improvement include the addition of new projects for comprehensive management capabilities, adjustments to data types and serialization options for better accuracy and output readability, and refined example code to demonstrate the SDK's expanded features. These changes collectively aim to improve the SDK's usability, flexibility, and alignment with user needs in managing audio processing and analysis tasks.

Changes

File(s) Summary of Changes
Deepgram.Dev.sln Added new projects for debugging, streaming, invitations, keys, members, projects, usage, and scopes.
Deepgram/Models/Manage/v1/Details.cs Changed TotalAudio property's data type from int? to double?.
.../Manage/v1/InviteSchema.cs, .../KeySchema.cs, .../MemberScopeSchema.cs Modified constructors and removed default values for certain properties, making them nullable without default initialization.
Deepgram/Models/Manage/v1/UsageFieldsResponse.cs Changed ProcessingMethods property's type from IReadOnlyList<RequestMethod> to IReadOnlyList<string> and removed JsonConverter attribute.
Deepgram/Models/PreRecorded/v1/Channel.cs Added a missing semicolon after the namespace declaration.
examples/analyze/.../Program.cs (intent, sentiment, summary, topic) Introduced JsonSerializerOptions with specific settings for JSON serialization, altering the output format when printing to the console.
examples/manage/.../Program.cs (balances, invitations, keys, members, projects, scopes, usage) Enhanced JSON serialization, updated messages and formatting, improved error handling, and introduced specific functionalities using the Deepgram .NET SDK.
examples/manage/.../Manage.csproj (invitations, keys, members, projects, scopes, usage) Configured projects to target .NET 6.0, included package references, enabled nullable reference types where applicable, and added using directives for Deepgram.
examples/prerecorded/.../Program.cs (file, intent, sentiment, summary, topic, url) Added or modified use of JsonSerializerOptions for customized JSON serialization, improving readability and formatting of the output.
examples/streaming/.../Program.cs (file, microphone) Made adjustments to console output formatting and conditions for checking transcript content, enhancing user feedback during streaming processes.

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.` 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. - 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/coderabbit-overrides.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.