docs: add custom ASR shim proxy example#1010
Open
xAlcahest wants to merge 1 commit into
Open
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
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.
Summary
OpenWhispr's "Cloud → Custom" transcription assumes the OpenAI wire format: it POSTs multipart/form-data to
{BaseUrl}/audio/transcriptionsand reads back{"text": "..."}. ASR APIs with a different shape (StepFun StepAudio 2.5, and several Chinese cloud providers) fail with 400/501-type errors and no obvious guidance. This adds anexamples/custom-asr-shim/directory with a small local proxy that bridges the two without touching OpenWhispr: the shim listens on/audio/transcriptions, transcodes the recording with ffmpeg, calls the vendor in its own format, and returns the OpenAI-shaped JSON.shim_template.pyis a vendor-neutral skeleton where you fill in onetranscribe()function;stepaudio_shim.pyis a working StepAudio 2.5 implementation ported from @ErogosZhou's gist.Closes #972
Changes
cgimodule, ffmpeg transcode, 25 MB body guard, temp-file cleanup).