feat: Add Post Call Transcription - #298
Conversation
|
Warning
Note Ready for review. |
AI Adoption Report
Per-commit breakdown (3 commits)
Warning The following commits have no Git AI authorship notes — AI adoption cannot be tracked for these changes.
Powered by Git AI Standard v3.0.0 — authorship data from |
There was a problem hiding this comment.
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#createto accept:has_transcriptionand:transcription_properties. - Adds a new VCR-backed spec (and cassette) to exercise archive creation with transcription settings.
- Updates YARD documentation for
OpenTok::Archives#createto 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_propertieskeys are passed through as-is (only the top-leveloptionskeys 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_propertieskeys to lowerCamelCase before callingstart_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.
This PR adds support for transcription settings when starting an archive recording. Specifically it:
Archives#createmethod to accept the new paramsArchives#createmethod to document the new paramsThis PR completes https://jira.vonage.com/browse/DEVX-11323