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

Implements Multi-Lingual Support #255

Merged
merged 1 commit into from
Jul 15, 2024

Conversation

dvonthenen
Copy link
Contributor

@dvonthenen dvonthenen commented Jul 10, 2024

Proposed changes

Implements Multi-Lingual Support

Types of changes

What types of changes does your code introduce to the community Go 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

    • Added Language field to the Word struct for enhanced language identification.
    • Added Languages field to the Alternative struct for supporting multiple languages.
  • Documentation

    • Deprecated ToWebVTT and ToSRT methods in favor of alternative projects for VTT or SRT generation.

Copy link

coderabbitai bot commented Jul 10, 2024

Walkthrough

The recent changes to the codebase involve adding language-related fields to the Word and Alternative structs in two different packages and marking certain methods as deprecated. Specifically, Word now includes a Language field, and Alternative includes a Languages field. Additionally, methods ToWebVTT and ToSRT in PreRecordedResponse have been deprecated with guidance to use other projects for VTT or SRT generation.

Changes

File Path Change Summary
pkg/api/listen/v1/rest/interfaces/types.go Added Language string to Word struct and Languages []string to Alternative struct.
pkg/api/listen/v1/websocket/interfaces/types.go Added Language string to Word struct and Languages []string to Alternative struct.
pkg/api/listen/v1/rest/interfaces/vtt-srt.go Deprecated ToWebVTT and ToSRT methods in PreRecordedResponse struct.

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

@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 1456965 and e4d7290.

Files selected for processing (3)
  • pkg/api/listen/v1/rest/interfaces/types.go (2 hunks)
  • pkg/api/listen/v1/rest/interfaces/vtt-srt.go (2 hunks)
  • pkg/api/listen/v1/websocket/interfaces/types.go (1 hunks)
Files skipped from review due to trivial changes (1)
  • pkg/api/listen/v1/rest/interfaces/vtt-srt.go
Additional comments not posted (4)
pkg/api/listen/v1/websocket/interfaces/types.go (2)

43-43: Addition of Language field in Word struct.

The Language field addition looks correct and consistent with the struct's existing fields. Ensure that this change is reflected in all relevant parts of the codebase where Word is used.


48-51: Addition of Languages field in Alternative struct.

The Languages field addition looks correct and consistent with the struct's existing fields. Ensure that this change is reflected in all relevant parts of the codebase where Alternative is used.

pkg/api/listen/v1/rest/interfaces/types.go (2)

89-89: Addition of Language field in Word struct.

The Language field addition looks correct and consistent with the struct's existing fields. Ensure that this change is reflected in all relevant parts of the codebase where Word is used.


105-105: Addition of Languages field in Alternative struct.

The Languages field addition looks correct and consistent with the struct's existing fields. Ensure that this change is reflected in all relevant parts of the codebase where Alternative is used.

@dvonthenen dvonthenen merged commit 768ef6a into deepgram:main Jul 15, 2024
2 checks passed
@dvonthenen dvonthenen deleted the implement-multilingual branch July 15, 2024 15:37
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