Skip to content

feat: Add Post Call Transcription - #298

Open
superchilled wants to merge 3 commits into
mainfrom
feat-add-post-call-transcription
Open

feat: Add Post Call Transcription#298
superchilled wants to merge 3 commits into
mainfrom
feat-add-post-call-transcription

Conversation

@superchilled

@superchilled superchilled commented Aug 18, 2026

Copy link
Copy Markdown
Contributor

This PR adds support for transcription settings when starting an archive recording. Specifically it:

  • Updates the implementation of the Archives#create method to accept the new params
  • Adds a new unit test to test the new params can be passed to the method
  • Updates the YARD doc comments for the Archives#create method to document the new params

This PR completes https://jira.vonage.com/browse/DEVX-11323

@superchilled

superchilled commented Aug 18, 2026

Copy link
Copy Markdown
Contributor Author

Warning

WIP. DO NOT MERGE.

Note

Ready for review.

@vonage-ai-assistant

vonage-ai-assistant Bot commented Aug 18, 2026

Copy link
Copy Markdown

AI Code: 0%

AI Adoption Report

Lines %
AI-generated 0 0%
Human 0 100%
Untracked 77
Total 77
Per-commit breakdown (3 commits)
Commit Message Added AI Human AI %
7df4f18 Updating YARD doc comments to include new transcription para 5 untracked
083642d Updating valid_opts list 6 untracked
c053da9 Adding unit test and mock 66 untracked

Warning

The following commits have no Git AI authorship notes — AI adoption cannot be tracked for these changes.
Install git-ai locally (curl -sSL https://usegitai.com/install.sh | bash) to enable automatic tracking.

  • 7df4f18 Updating YARD doc comments to include new transcription para
  • 083642d Updating valid_opts list
  • c053da9 Adding unit test and mock

Powered by Git AI Standard v3.0.0 — authorship data from refs/notes/ai (supports sessions-v2 format)

@superchilled
superchilled marked this pull request as ready for review August 19, 2026 10:32
@superchilled
superchilled requested review from dragonmantank and a lite review from Copilot August 19, 2026 10:32

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Pull request overview

Adds support in the Ruby SDK for enabling post-call transcription when starting an archive, including wiring the new parameters through OpenTok::Archives#create, documenting them, and covering them with a VCR-backed unit spec.

Changes:

  • Extends OpenTok::Archives#create to accept :has_transcription and :transcription_properties.
  • Adds a new VCR-backed spec (and cassette) to exercise archive creation with transcription settings.
  • Updates YARD documentation for OpenTok::Archives#create to describe the new options.

Reviewed changes

Copilot reviewed 3 out of 3 changed files in this pull request and generated 2 comments.

File Description
spec/opentok/archives_spec.rb Adds a new spec case for creating an archive with transcription enabled.
spec/cassettes/OpenTok_Archives/should_create_an_archive_with_transcription_enabled_and_transcription_settings_specified.yml New VCR cassette capturing the expected request/response payload for transcription settings.
lib/opentok/archives.rb Allows new transcription-related options and documents them in the create method YARD comment.
Suppressed comments (1)

lib/opentok/archives.rb:132

  • transcription_properties keys are passed through as-is (only the top-level options keys are camelized). That forces callers to know and supply the nested REST API’s camelCase keys (for example "primaryLanguageCode"), which is inconsistent with the rest of the Ruby API and easy to get wrong. Consider normalizing :transcription_properties keys to lowerCamelCase before calling start_archive, while still accepting already-camelCased string keys unchanged.
      opts = options.inject({}) do |m,(k,v)|
        if valid_opts.include? k.to_sym
          m[k.to_sym] = v
        end
        m
      end

💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.

Comment thread lib/opentok/archives.rb
Comment thread spec/opentok/archives_spec.rb
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