Skip to content

Throw exception when streaming is used with unsupported whisper-1 model #537

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Jul 15, 2025
Merged

Throw exception when streaming is used with unsupported whisper-1 model #537

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
0af0524
Throw exception when streaming is used with unsupported whisper-1 model
ShivangiReja Jul 15, 2025
d26a1d4
Feedback
ShivangiReja Jul 15, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 22 additions & 0 deletions src/Custom/Audio/AudioClient.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -229,6 +229,8 @@ public virtual AsyncCollectionResult<StreamingAudioTranscriptionUpdate> Transcri
Argument.AssertNotNull(audio, nameof(audio));
Argument.AssertNotNullOrEmpty(audioFilename, nameof(audioFilename));

EnsureModelSupportsStreaming();

MultiPartFormDataBinaryContent content
= CreatePerCallTranscriptionOptions(options, stream: true)
.ToMultipartContent(audio, audioFilename);
Expand All @@ -245,6 +247,8 @@ public virtual AsyncCollectionResult<StreamingAudioTranscriptionUpdate> Transcri
{
Argument.AssertNotNullOrEmpty(audioFilePath, nameof(audioFilePath));

EnsureModelSupportsStreaming();

FileStream inputStream = File.OpenRead(audioFilePath);

MultiPartFormDataBinaryContent content
Expand All @@ -266,6 +270,8 @@ public virtual CollectionResult<StreamingAudioTranscriptionUpdate> TranscribeAud
Argument.AssertNotNull(audio, nameof(audio));
Argument.AssertNotNullOrEmpty(audioFilename, nameof(audioFilename));

EnsureModelSupportsStreaming();

MultiPartFormDataBinaryContent content
= CreatePerCallTranscriptionOptions(options, stream: true)
.ToMultipartContent(audio, audioFilename);
Expand All @@ -282,6 +288,8 @@ public virtual CollectionResult<StreamingAudioTranscriptionUpdate> TranscribeAud
{
Argument.AssertNotNullOrEmpty(audioFilePath, nameof(audioFilePath));

EnsureModelSupportsStreaming();

FileStream inputStream = File.OpenRead(audioFilePath);

MultiPartFormDataBinaryContent content
Expand All @@ -296,6 +304,20 @@ MultiPartFormDataBinaryContent content
return result;
}

private void EnsureModelSupportsStreaming()
{
if (string.Equals(_model, "whisper-1", StringComparison.OrdinalIgnoreCase))
{
string isEnabled = Environment.GetEnvironmentVariable("OPENAI_ENABLE_WHISPER_1_STREAMING");
if (!string.Equals(isEnabled, "true", StringComparison.OrdinalIgnoreCase))
{
throw new NotSupportedException(
"The selected model 'whisper-1' does not support streaming transcription. " +
"Please use a compatible model or set the environment variable 'OPENAI_ENABLE_WHISPER_1_STREAMING=true' to bypass this check.");
}
}
}

#endregion

#region TranslateAudio
Expand Down
26 changes: 26 additions & 0 deletions tests/Audio/TranscriptionTests.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -322,4 +322,30 @@ public async Task StreamingTranscriptionWorks(AudioSourceKind audioSourceKind)

inputStream?.Dispose();
}

[Test]
[TestCase(AudioSourceKind.UsingStream)]
[TestCase(AudioSourceKind.UsingFilePath)]
public void StreamingTranscriptionThrowsForWhisperModel(AudioSourceKind audioSourceKind)
{
AudioClient client = GetTestClient<AudioClient>(TestScenario.Audio_Whisper);
string filename = "audio_hello_world.mp3";
string path = Path.Combine("Assets", filename);

if (audioSourceKind == AudioSourceKind.UsingStream)
{
using FileStream inputStream = File.OpenRead(path);
Assert.Throws<NotSupportedException>(() =>
{
_ = client.TranscribeAudioStreamingAsync(inputStream, filename);
});
}
else if (audioSourceKind == AudioSourceKind.UsingFilePath)
{
Assert.Throws<NotSupportedException>(() =>
{
_ = client.TranscribeAudioStreamingAsync(path);
});
}
}
}