Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Adds Missing Dictation Param #321

Merged
merged 1 commit into from
Aug 1, 2024

Conversation

dvonthenen
Copy link
Contributor

@dvonthenen dvonthenen commented Jul 31, 2024

Proposed changes

Addresses: #317

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

NA

Summary by CodeRabbit

  • New Features
    • Introduced an optional Dictation property to enhance the LiveSchema with speaker diarization capabilities, allowing for improved audio transcription by recognizing speaker changes.
  • Documentation
    • Added summary documentation to clarify the functionality of the new Dictation property and provide links to relevant resources.

Copy link
Contributor

coderabbitai bot commented Jul 31, 2024

Warning

Rate limit exceeded

@dvonthenen has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 21 minutes and 8 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 for further information.

Commits

Files that changed from the base of the PR and between f4cb60c and cf89d14.

Walkthrough

The recent update introduces an optional Dictation property to the LiveSchema class, enhancing its functionality by enabling diarization during audio processing. This feature allows the system to identify speaker changes and link them to the corresponding transcript words. With this addition, users can control whether diarization is applied by setting the property accordingly, improving the schema's overall flexibility.

Changes

File Path Change Summary
Deepgram/Models/Listen/v1/WebSocket/LiveSchema.cs Added an optional Dictation property to the LiveSchema class, changing its type from string? to bool?, enabling speaker diarization.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant LiveSchema
    participant AudioProcessor
    participant DiarizationService

    User->>LiveSchema: Set Dictation to true
    LiveSchema->>AudioProcessor: Process audio with diarization
    AudioProcessor->>DiarizationService: Enable diarization feature
    DiarizationService-->>AudioProcessor: Return diarized transcript
    AudioProcessor-->>LiveSchema: Provide transcript with speaker labels
    LiveSchema-->>User: Return completed transcript
Loading

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

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 0

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between c4bb711 and f4cb60c.

Files selected for processing (1)
  • Deepgram/Models/Listen/v1/WebSocket/LiveSchema.cs (1 hunks)
Additional comments not posted (1)
Deepgram/Models/Listen/v1/WebSocket/LiveSchema.cs (1)

61-69: Addition of Dictation property looks good.

The Dictation property is well-documented and follows the existing pattern of other properties in the LiveSchema class. The use of JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull) ensures that the property is not serialized if it is null, which is a good practice for optional properties.

@dvonthenen dvonthenen merged commit acafeae into deepgram:main Aug 1, 2024
4 checks passed
@dvonthenen dvonthenen deleted the missing-dictation-param branch August 1, 2024 14:17
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants