Add dictation parameter to STT streaming

[bryanwux]

Proposed changes

This resolves the issue in #259, which proposes to add dictation parameter back to STT streaming.

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

Summary by CodeRabbit

• New Features

  • Introduced a new Dictation field in live transcription options for enhanced control over spoken commands formatting. This allows users to dictate punctuated commands more effectively.

• Documentation

  • Added comments to clarify the functionality and requirements of the new Dictation field.

[coderabbitai]

Walkthrough

The recent changes enhance the LiveTranscriptionOptions struct by introducing a new boolean field named Dictation. This feature allows users to format spoken commands into punctuated text, improving transcription accuracy and usability. The Dictation field is optional and must be enabled when the punctuate parameter is true. This update provides greater control over the transcription process, facilitating more intuitive interactions.

Changes

Files	Change Summary
pkg/client/interfaces/v1/types-stream.go	Added a new boolean field Dictation to LiveTranscriptionOptions for formatting spoken commands. The field is optional and requires the punctuate parameter to be true for functionality.

---

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

[coderabbitai]

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 1d402c8 and 9ffbb75.

Files selected for processing (1)

• pkg/client/interfaces/v1/types-stream.go (1 hunks)

Additional comments not posted (1)

pkg/client/interfaces/v1/types-stream.go (1)

21-21: LGTM! Ensure clarity in the comment.

The new field Dictation is well-documented and follows the existing pattern in the struct.

However, ensure that the comment is clear and unambiguous. Consider rephrasing for better readability:

- // Option to format spoken punctuated commands, must be enabled with punctuate parameter to true. Eg: "i went to the store comma new paragraph then i went home period" --> "i went to the store, <\n> then i went home."
+ // Option to format spoken punctuated commands. Must be enabled with the `punctuate` parameter set to true. E.g., "i went to the store comma new paragraph then i went home period" --> "i went to the store, <\n> then i went home."

[davidvonthenen]

hi @bryanwux

thanks for the contribution!