Update live_translate & live_transcribe docs, openapi spec & SWML schema #741
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Devon-White
requested review from
Manny-r31,
briankwest,
hey-august and
niravcodes
as code owners
✅ Deploy Preview for signalwire-docs ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
|
yarn run v1.22.22 OpenAPI Specification AnalysisChanges are compared to the
Done in 153.83s. |
briankwest
previously approved these changes
Dec 11, 2025
Contributor
|
Reviewing |
Resolved conflicts in live_transcribe, live_translate specs and docs. See PR for conflict resolution details. 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
Contributor
Merge Conflict Resolution: main → Devon/live_methods-update
|
| Conflict | HEAD (branch) | main | Resolution |
|---|---|---|---|
| L14-21: SpeechEngine enum | Not present | Defined locally | Removed - Already exists in Shared/Types/main.tsp; avoid duplication |
L43-49: speech_timeout @doc |
"Speech timeout in milliseconds." |
"The timeout for speech recognition in milliseconds." |
main - More explicit description |
L43-49: speech_timeout @example |
30 |
30000 |
main - 30ms is unrealistic; 30000ms matches 60000ms default |
L56-68: vad_thresh @doc |
"...threshold (0-1800)." |
"...threshold." |
branch - Includes valid range for users |
L56-68: vad_thresh @example |
3 |
400 |
main - 3 is unrealistic; 400 matches default |
L60-68: debug_level @doc |
"...logging (0-2)." |
"...logging." |
branch - Includes valid range for users |
L75-86: speech_engine @example |
SpeechEngine.google |
Not present | branch - Provides example value |
L80-86: ai_summary_prompt @doc |
"...instructs how to summarize...when ai_summary is enabled." |
"The prompt for summarization." |
branch - More descriptive, explains relationship to ai_summary |
specs/swml/Methods/live_translate/main.tsp
| Conflict | HEAD (branch) | main | Resolution |
|---|---|---|---|
| L14-50: Enum definitions | TranslationFilterPreset + CustomTranslationFilter |
SpeechEngine |
branch - TranslationFilterPreset is new feature; SpeechEngine already in shared types |
L89-95: speech_timeout @doc |
"Speech timeout in milliseconds." |
"The timeout for speech recognition in milliseconds." |
main - More explicit description |
L89-95: speech_timeout @example |
30 |
30000 |
main - Realistic value |
L102-114: vad_thresh @doc |
"...threshold (0-1800)." |
"...threshold." |
branch - Includes valid range |
L102-114: vad_thresh @example |
3 |
400 |
main - Matches default |
L107-114: debug_level @doc |
"...logging (0-2)." |
"...logging." |
branch - Includes valid range |
L121-132: speech_engine @example |
SpeechEngine.google |
Not present | branch - Provides example |
L126-132: ai_summary_prompt @doc |
"...instructs how to summarize...when ai_summary is enabled." |
"The prompt for summarization." |
branch - More descriptive |
L156-161: prompt @doc (SummarizeAction) |
"The AI prompt that instructs how to summarize the conversation." |
"The prompt for summarization." |
branch - Clearer description |
website/docs/.../live_transcribe/action/start.mdx
| Conflict | HEAD (branch) | main | Resolution |
|---|---|---|---|
L68-72: vad_silence_ms default |
"300 | 500" |
"300" |
branch - Accurately documents engine-dependent default (300 for Deepgram, 500 for Google) |
L107-119: speech_engine description |
"The speech recognition engine to use." |
"The speech engine to use for transcription." |
branch - Slightly more descriptive |
| L111-118: Field name | start.ai_summary_prompt |
start.summary_prompt |
branch - Matches renamed field in TypeSpec |
website/docs/.../live_translate/action/start.mdx
| Conflict | HEAD (branch) | main | Resolution |
|---|---|---|---|
L128-132: vad_silence_ms default |
"300 | 500" |
"300" |
branch - Documents engine-dependent default |
L173-187: speech_engine description |
"The speech recognition engine to use." |
"The speech engine to use for transcription." |
branch - More appropriate (this is translation, not transcription) |
| L179-186: Field name | start.ai_summary_prompt |
start.summary_prompt |
branch - Matches renamed field |
specs/swml/Methods/ai/ai_params.tsp (from stash)
| Conflict | Stashed (our fix) | main | Resolution |
|---|---|---|---|
L393: openai_asr_engine type |
"deepgram:nova-2" | "deepgram:nova-3" |
string = "gcloud_speech_v2_async" |
main - Doc says "and other supported ASR engines" implying more values exist; string type is more flexible |
hey-august
approved these changes
Jan 6, 2026
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Updates
live_transcribeandlive_translatedocumentation, OpenAPI specs, and SWML schema with improved parameter descriptions, new features, and REST API support.Changes
New Features
calling.live_transcribeandcalling.live_translatecommands to the Calling REST APIfilter_from,filter_to) with preset values (polite,rude,professional,shakespeare,gen-z) and custom prompt supportSchema Improvements
SpeechEngineenum to shared types for reuse across modulessummary_prompt→ai_summary_promptfor consistencyspeech_timeout(60000ms),vad_thresh(400),debug_level(0),speech_engine(deepgram)speech_enginefrom required to optional with defaultDocumentation Updates
vad_thresh (0-1800),debug_level (0-2))vad_silence_ms(300 for Deepgram, 500 for Google)stop,summarize, andinjectactions explaining REST API and SWML usageInjectAction.directiontype from array to single valueFiles Modified
specs/signalwire-rest/calling-api/- New REST API models and examplesspecs/swml/Methods/live_transcribe/- Updated TypeSpec definitionsspecs/swml/Methods/live_translate/- Updated TypeSpec definitionsspecs/swml/Shared/Types/- Added sharedSpeechEngineenumwebsite/docs/.../live_transcribe/- Updated MDX documentation (Preview)website/docs/.../live_translate/- Updated MDX documentation (Preview)Breaking Changes
summary_promptrenamed toai_summary_promptspeech_engineno longer required (has default)InjectAction.directionchanged fromTranslateDirection[]toTranslateDirection