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

[main] Implement Mutli-Lingual and Missing Speaker/NumWords #314

Merged
merged 1 commit into from
Jul 9, 2024
Merged

[main] Implement Mutli-Lingual and Missing Speaker/NumWords #314

merged 1 commit into from
Jul 9, 2024

Conversation

davidvonthenen
Copy link
Contributor

@davidvonthenen davidvonthenen commented Jul 9, 2024

This implements multi-lingual support for main branch. This is implemented in the temp branch here:
https://github.com/dvonthenen/deepgram-python-sdk/tree/temp-v40-rel

Did not test. Implemented per the spec since this was pretty straight forward.

Summary by CodeRabbit

  • New Features

    • Added language detection capabilities to words and alternatives in both REST and WebSocket models.
  • Enhancements

    • Made the NumWords property in the Paragraph model publicly accessible.
    • Added a new Speaker property to the Paragraph model for identifying speakers.

Copy link
Contributor

coderabbitai bot commented Jul 9, 2024

Walkthrough

The recent updates include the addition of language detection capabilities across various models in the Deepgram REST and WebSocket APIs. New properties were introduced to store language information for words and transcription alternatives, along with adjustments to some access modifiers to improve data accessibility.

Changes

File Change Summary
Deepgram/Models/Listen/v1/REST/Alternative.cs Deepgram/Models/Listen/v1/WebSocket/Alternative.cs Added Languages property to store detected languages.
Deepgram/Models/Listen/v1/REST/Paragraph.cs Changed NumWords access modifier to public, added Speaker property.
Deepgram/Models/Listen/v1/REST/Word.cs Deepgram/Models/Listen/v1/WebSocket/Word.cs Added Language property to store the detected language of the word.

Sequence Diagram(s)

Since the changes involve adding new properties and modifying existing ones without altering core control flow, no sequence diagrams are necessary for these updates. The additions are primarily enhancements aimed at improving the data model for existing 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
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 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 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 f8bc0c2 and 079531f.

Files selected for processing (5)
  • Deepgram/Models/Listen/v1/REST/Alternative.cs (1 hunks)
  • Deepgram/Models/Listen/v1/REST/Paragraph.cs (2 hunks)
  • Deepgram/Models/Listen/v1/REST/Word.cs (1 hunks)
  • Deepgram/Models/Listen/v1/WebSocket/Alternative.cs (1 hunks)
  • Deepgram/Models/Listen/v1/WebSocket/Word.cs (1 hunks)
Additional comments not posted (6)
Deepgram/Models/Listen/v1/WebSocket/Alternative.cs (1)

29-34: New property Languages added correctly.

The Languages property is correctly annotated for JSON serialization and follows the existing pattern of the class.

Deepgram/Models/Listen/v1/REST/Paragraph.cs (2)

21-21: Access modifier for NumWords changed to public.

The NumWords property now has a public access modifier, increasing its accessibility.


30-35: New property Speaker added correctly.

The Speaker property is correctly annotated for JSON serialization and follows the existing pattern of the class.

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

44-49: New property Language added correctly.

The Language property is correctly annotated for JSON serialization and follows the existing pattern of the class.

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

24-29: New property Language added correctly.

The Language property is correctly annotated for JSON serialization and follows the existing pattern of the class.

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

24-30: LGTM! The new Languages property is well-integrated.

The addition of the Languages property follows the existing pattern and is correctly annotated for JSON serialization.

@davidvonthenen davidvonthenen merged commit cd8cc92 into deepgram:main Jul 9, 2024
4 checks passed
@davidvonthenen davidvonthenen deleted the impl-multilingual-speaker-numwords branch July 9, 2024 18:10
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