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 ClientOptionsFromEnv with Defined Interface for ClientOptions #275

Closed dvonthenen closed 4 months ago

dvonthenen commented 4 months ago

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

Although .NET/Windows apps are pretty rare in containers, they still do happen with the windows headless server installs. This allows you do set key client options using environment variables. This also creates an IDeepgramClientOptions interface as not to expose the clients to configuration/class changes.

coderabbitai[bot] commented 4 months ago

[!WARNING]

Rate Limit Exceeded

@dvonthenen has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 9 minutes and 33 seconds before requesting another review.

How to resolve this issue? After the wait time has elapsed, a review can be triggered using the `@coderabbitai review` command as a PR comment. Alternatively, push new commits to this PR. We recommend that you space out your commits to avoid hitting the rate limit.
How do rate limits work? CodeRabbit enforces hourly rate limits for each developer per organization. Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout. Please see our [FAQ](https://coderabbit.ai/docs/faq) for further information.
Commits Files that changed from the base of the PR and between c431b65062099fa10f466e5b8f2617839b1c9e33 and 8f28f6a0f7994008a3a4d4062a93642d2c48569d.

Walkthrough

The primary update across the Deepgram .NET SDK involves the adoption of the IDeepgramClientOptions interface, replacing DeepgramHttpClientOptions in various components for enhanced flexibility and abstraction. This change affects constructors, method signatures, and option handling in multiple client classes, ensuring a more interface-oriented design. Additional features include a new KeepAlive property and environment-based configuration options, enriching client customization and functionality.

Changes

File Path Change Summary
.../AbstractRestClient.cs Switched _options type to IDeepgramClientOptions, updated constructor and GetUri method. Added null check.
.../Analyze/v1/Client.cs Updated to use IDeepgramClientOptions for HttpClient configuration.
.../Live/v1/Client.cs Replaced DeepgramWsClientOptions with IDeepgramClientOptions. Added null check and casting in constructor.
.../Manage/v1/Client.cs Updated deepgramClientOptions type to IDeepgramClientOptions in constructor.
.../OnPrem/v1/Client.cs Changed parameter type to IDeepgramClientOptions in constructor.
.../PreRecorded/v1/Client.cs Updated deepgramClientOptions type to IDeepgramClientOptions in constructor.
.../Speak/v1/Client.cs Updated to use IDeepgramClientOptions for HttpClient configuration.
.../Factory/HttpClientFactory.cs Method ConfigureDeepgram now accepts IDeepgramClientOptions. Changed default options initialization.
.../Authenticate/v1/...Options.cs DeepgramHttpClientOptions implements IDeepgramClientOptions. Added KeepAlive property. Introduced DeepgramOptionsFromEnv and updated DeepgramWsClientOptions.
.../Authenticate/v1/IDeepgramOptions.cs Introduced IDeepgramClientOptions interface defining client configuration options.

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