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

Rename `OnPrem` -> `SelfHosted` #310

Closed dvonthenen closed 3 months ago

dvonthenen commented 3 months ago

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

Marks old OnPrem as obsolete to preserve backward compatibility.

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

Summary by CodeRabbit

coderabbitai[bot] commented 3 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 39 minutes and 24 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 885871b296c906130bf4516b07a4ee18a94cff96 and c1f0cf3314642ce4e305b88e4421b459288be29f.

Walkthrough

The updates primarily replace OnPrem terminology with SelfHosted throughout the codebase to reflect a shift towards self-hosted service terms. This includes modifications to namespaces, class names, method signatures, and deprecating old components in favor of new ones focusing on SelfHosted. The changes ensure that the new SelfHosted components support similar functionality with improved clarity and future-proofing.

Changes

File(s) / Group Change Summary
.../OnPremClientTests.cs Updates references from OnPrem to SelfHosted in namespaces, class names, and method calls.
.../ClientFactory.cs Deprecates CreateOnPremClient method, introduces CreateSelfHostedClient.
.../Interfaces/v1/IOnPremClient.cs Marks IOnPremClient interface as deprecated.
.../Interfaces/v1/ISelfHostedClient.cs Introduces ISelfHostedClient interface with methods for credential management.
.../Clients/OnPrem/v1/Client.cs Deprecates the Client class, advising use of SelfHosted namespace equivalent.
.../Clients/OnPrem/v1/UriSegments.cs Adds deprecation warning to UriSegments class.
.../Clients/SelfHosted/v1/Client.cs Introduces new Client class with methods to manage credentials.
.../Clients/SelfHosted/v1/UriSegments.cs Defines constants for URI segments related to self-hosted services.
.../Models/OnPrem/v1/... Deprecates OnPrem models, advises the use of corresponding SelfHosted models.
.../Models/SelfHosted/v1/... Introduces new models under SelfHosted namespace with properties and methods for credentials.

Sequence Diagram(s)

sequenceDiagram
    participant ClientFactory
    participant SelfHostedClient
    participant ISelfHostedClient
    participant CredentialService

    ClientFactory->>SelfHostedClient: CreateSelfHostedClient(apiKey, options, httpId)
    SelfHostedClient->>ISelfHostedClient: Initialize(apiKey, options, httpId)

    SelfHostedClient->>CredentialService: ListCredentials(projectId, ...)
    CredentialService-->>SelfHostedClient: CredentialsResponse
    SelfHostedClient-->>ClientFactory: SelfHostedClient instance with credentials

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 3 months ago

@coderabbitai review

coderabbitai[bot] commented 3 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.