search

deepgram / deepgram-js-sdk

Official JavaScript SDK for Deepgram's automated speech recognition APIs.
https://developers.deepgram.com
MIT License
159 stars 54 forks source link

feat: add TTS Live Client #306

Closed SandraRodgers closed 2 months ago

SandraRodgers commented 4 months ago

Introduce live speak functionality to existing speak client. Maintain existing interface for batch.

Summary by CodeRabbit

jpvajda commented 2 months ago

@lukeocodes Things we need to change in this PR:

cc @dvonthenen

davidvonthenen commented 2 months ago

@lukeocodes Things we need to change in this PR:

  • Rename of reset to clear
  • Clear message now has a response type.
  • We want to remove the container field

cc @dvonthenen

Yep, confirmed those should be the only changes between now and towards the end of July. 👍

coderabbitai[bot] commented 2 months ago

Walkthrough

The changes enhance the text-to-speech (TTS) functionality using the Deepgram API by adding documentation for both REST API and WebSocket methods in README.md. A live TTS implementation is introduced in index.js, alongside an enumeration for live TTS events in LiveTTSEvents.ts. The SpeakClient and SpeakLiveClient classes are added to facilitate interactions with TTS services. Additionally, export statements are updated to include these new components, ensuring their availability throughout the application.

Changes

Files Change Summary
README.md Added sections for REST API and WebSocket methods for Deepgram TTS with example usage.
examples/node-speak-live/index.js Introduced live TTS functionality with event handling and audio data processing.
src/lib/enums/LiveTTSEvents.ts Added enumeration for live TTS events, including socket and message events.
src/lib/enums/index.ts Updated to export the new LiveTTSEvents enumeration.
src/packages/SpeakClient.ts Added SpeakClient class with methods for REST and live TTS interactions.
src/packages/SpeakLiveClient.ts Introduced SpeakLiveClient class for managing WebSocket connections for live TTS.
src/packages/SpeakRestClient.ts Removed alias export for SpeakRestClient, simplifying the export structure.
src/packages/index.ts Added exports for SpeakClient and SpeakLiveClient to the module's public API.
Recent review details **Configuration used: CodeRabbit UI** **Review profile: CHILL**
Commits Files that changed from the base of the PR and between 54c9085f8698b2f1cbc5f2a49b9ee734c3a6c56a and e3a6e69a6a75065c4e8ad7ff152be992f7eda94d.
Files selected for processing (8) * README.md (1 hunks) * examples/node-speak-live/index.js (1 hunks) * src/lib/enums/LiveTTSEvents.ts (1 hunks) * src/lib/enums/index.ts (1 hunks) * src/packages/SpeakClient.ts (1 hunks) * src/packages/SpeakLiveClient.ts (1 hunks) * src/packages/SpeakRestClient.ts (0 hunks) * src/packages/index.ts (1 hunks)
Files not reviewed due to no reviewable changes (1) * src/packages/SpeakRestClient.ts
Files skipped from review as they are similar to previous changes (7) * README.md * examples/node-speak-live/index.js * src/lib/enums/LiveTTSEvents.ts * src/lib/enums/index.ts * src/packages/SpeakClient.ts * src/packages/SpeakLiveClient.ts * src/packages/index.ts
--- 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 , 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 generate interesting stats about this repository and render them as a table.` -- `@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](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.