ToolUp.VoiceProviders.AzureSpeech 0.22.0

Prefix Reserved
dotnet add package ToolUp.VoiceProviders.AzureSpeech --version 0.22.0
                    
NuGet\Install-Package ToolUp.VoiceProviders.AzureSpeech -Version 0.22.0
                    
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="ToolUp.VoiceProviders.AzureSpeech" Version="0.22.0" />
                    
For projects that support PackageReference, copy this XML node into the project file to reference the package.
<PackageVersion Include="ToolUp.VoiceProviders.AzureSpeech" Version="0.22.0" />
                    
Directory.Packages.props
<PackageReference Include="ToolUp.VoiceProviders.AzureSpeech" />
                    
Project file
For projects that support Central Package Management (CPM), copy this XML node into the solution Directory.Packages.props file to version the package.
paket add ToolUp.VoiceProviders.AzureSpeech --version 0.22.0
                    
#r "nuget: ToolUp.VoiceProviders.AzureSpeech, 0.22.0"
                    
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.
#:package ToolUp.VoiceProviders.AzureSpeech@0.22.0
                    
#:package directive can be used in C# file-based apps starting in .NET 10 preview 4. Copy this into a .cs file before any lines of code to reference the package.
#addin nuget:?package=ToolUp.VoiceProviders.AzureSpeech&version=0.22.0
                    
Install as a Cake Addin
#tool nuget:?package=ToolUp.VoiceProviders.AzureSpeech&version=0.22.0
                    
Install as a Cake Tool

ToolUp.VoiceProviders.AzureSpeech

An ITranscriptionProvider (from ToolUp.Voice.Core) over the Azure AI Speech REST short-audio endpoint. Batch speech-to-text: an audio clip in, a Transcript out with per-hypothesis confidence and word-offset timing.

  • BYOK — reads azure-speech-key + azure-speech-region from ISecretStore in the _platform scope on every call; a rotated key flows through with no reconstruction, and neither credential is read from an env var directly.
  • GP 1HttpClient + System.Text.Json only; no Microsoft.CognitiveServices.Speech NuGet dependency reaches your dependency graph.
  • Batch onlySupportsStreaming = false (the REST short-audio path; continuous streaming is a WebSocket protocol left to a follow-on). For low-latency streaming, use the client companion's local Web Speech mode.

Compose

open ToolUp.Voice

let provider = AzureSpeechTranscriptionProvider.create secretStore
// register the preflight validator + readiness probe alongside it:
//   |> ServerApp.withConfigValidator (AzureSpeechTranscriptionProvider.createValidator secretStore)
//   |> ServerApp.withHealthCheck (AzureSpeechTranscriptionProviderHealth.create secretStore)

let request =
    TranscriptionRequest.create "audio/webm" audioBytes
    |> TranscriptionRequest.withLanguage "en-GB"

let! result = provider.Transcribe request

Secrets

_platform scope key Value
azure-speech-key the Speech resource subscription key
azure-speech-region the resource region, e.g. westeurope

Accepted audio

audio/webm / audio/ogg (Opus — the MediaRecorder default) and audio/wav (PCM). The provider declares the matching Azure Content-Type header per format. Any other content type returns TranscriptionError.UnsupportedAudio. The short-audio endpoint is bounded to roughly 60 s / 10 MB per clip.

Notes

  • The request uses format=detailed, so the top N-best hypothesis supplies per-segment Confidence and Offset/Duration timing (Azure ticks → TimeSpan).
  • NoMatch / InitialSilenceTimeout / BabbleTimeout map to an empty transcript — a valid "nothing was said" result, not an error.
  • Failure mapping: 401/403/400 → PermanentClient; 429 / 5xx / timeout / network → Transient.

Licensed Apache-2.0.

Product Compatible and additional computed target framework versions.
.NET net10.0 is compatible.  net10.0-android was computed.  net10.0-browser was computed.  net10.0-ios was computed.  net10.0-maccatalyst was computed.  net10.0-macos was computed.  net10.0-tvos was computed.  net10.0-windows was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last Updated
0.22.0 38 8/27/2026
0.21.0 40 8/26/2026
0.20.1 85 8/20/2026
0.20.0 110 8/19/2026