add numerals query param for batch and streaming

[jjmaldonis]

Proposed changes

add numerals query param for batch and streaming

Types of changes

What types of changes does your code introduce to the community .NET SDK?
Put an x in the boxes that apply

• Bugfix (non-breaking change which fixes an issue)
• New feature (non-breaking change which adds functionality)
• Breaking change (fix or feature that would cause existing functionality to not work as expected)
• Documentation update or tests (if none of the other choices apply)

Checklist

Put an x in the boxes that apply. You can also fill these out after creating the PR. If you're unsure about any of them, don't hesitate to ask. We're here to help! This is simply a reminder of what we are going to look for before merging your code.

• I have read the CONTRIBUTING doc
• I have lint'ed all of my code using repo standards
• I have added tests that prove my fix is effective or that my feature works
• I have added necessary documentation (if appropriate)

Further comments

I did not test this.

Summary by CodeRabbit

• New Features
  • Introduced a new optional property, numerals, in both the PreRecordedSchema and LiveSchema classes to enhance numerical data handling in audio processing.
  • Users can now control the conversion of numbers from written to numerical format in transcripts.

[coderabbitai]

Walkthrough

The changes introduce a new nullable property named numerals to both the PreRecordedSchema and LiveSchema classes within the Deepgram models. This property facilitates the conversion of numbers from written to numerical format and is annotated with JsonIgnore to exclude it from serialization when null. Additionally, the LiveSchema property includes a JsonPropertyName attribute to specify its JSON representation. Documentation comments have been added to clarify the purpose of the new feature.

Changes

File Path	Change Summary
Deepgram/Models/Listen/v1/REST/PreRecordedSchema.cs	Added nullable property public bool? numerals { get; set; } to PreRecordedSchema.
Deepgram/Models/Listen/v1/WebSocket/LiveSchema.cs	Added nullable property public bool? numerals { get; set; } to LiveSchema.

---

Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 184f161 and fddb9d2.

Files selected for processing (2)

• Deepgram/Models/Listen/v1/REST/PreRecordedSchema.cs (1 hunks)
• Deepgram/Models/Listen/v1/WebSocket/LiveSchema.cs (1 hunks)

Additional comments not posted (2)

Deepgram/Models/Listen/v1/WebSocket/LiveSchema.cs (1)

206-212: LGTM!

The addition of the numerals property to the LiveSchema class is a well-implemented enhancement. Here are the positive aspects of the changes:

• The property is clearly named and follows the naming convention used for other properties in the class.
• The JsonIgnore and JsonPropertyName attributes are used appropriately to handle serialization and deserialization, ensuring consistency with the existing codebase.
• The documentation comments provide a clear explanation of the property's purpose and include a link to the relevant documentation for further reference, improving the usability and maintainability of the code.

Overall, the changes introduce a useful new feature while maintaining backward compatibility and adhering to the established coding practices in the codebase.

Deepgram/Models/Listen/v1/REST/PreRecordedSchema.cs (1)

250-256: LGTM!

The addition of the numerals property to the PreRecordedSchema class is a valuable enhancement that enables the conversion of numbers from written to numerical format. The property is properly annotated with JsonIgnore to exclude it from serialization when null, which aligns with the existing pattern used for other nullable properties in the class. The summary comment provides clear documentation for the new feature, making it easier for developers to understand its purpose and usage.

This change is a non-breaking addition that does not disrupt existing functionality and enhances the flexibility and usability of the SDK for pre-recorded audio processing.

---

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
• Mastodon
• Reddit
• LinkedIn

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 <commit_id>, please review it.
  -- 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 gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  -- @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 using 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.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration 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 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 for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[davidvonthenen]

Thanks for spotting this!