Public/Request-AudioTranscription.ps1
|
function Request-AudioTranscription { [CmdletBinding(DefaultParameterSetName = 'Language')] [OutputType([string])] param ( [Parameter(Mandatory, Position = 0, ValueFromPipeline)] [ValidateScript({ Test-Path -LiteralPath $_ -PathType Leaf })] [string]$File, [Parameter()] [Completions('whisper-1')] [string][LowerCaseTransformation()]$Model = 'whisper-1', [Parameter()] [string]$Prompt, [Parameter()] [Alias('response_format')] [ValidateSet('json', 'text', 'srt', 'verbose_json', 'vtt')] [string]$Format = 'text', [Parameter()] [ValidateRange(0.0, 1.0)] [double]$Temperature, [Parameter()] [ValidateSet('word', 'segment')] [Alias('timestamp_granularities')] [string[]]$TimestampGranularities, [Parameter(ParameterSetName = 'Language')] [string]$Language, [Parameter(DontShow, ParameterSetName = 'LiteralLanguage')] [string]$LiteralLanguage, [Parameter()] [int]$TimeoutSec = 0, [Parameter()] [ValidateRange(0, 100)] [int]$MaxRetryCount = 0, [Parameter()] [OpenAIApiType]$ApiType = [OpenAIApiType]::OpenAI, [Parameter()] [System.Uri]$ApiBase, [Parameter(DontShow)] [string]$ApiVersion, [Parameter()] [ValidateSet('openai', 'azure', 'azure_ad')] [string]$AuthType = 'openai', [Parameter()] [securestring][SecureStringTransformation()]$ApiKey, [Parameter()] [Alias('OrgId')] [string]$Organization, [Parameter()] [System.Collections.IDictionary]$AdditionalQuery, [Parameter()] [System.Collections.IDictionary]$AdditionalHeaders, [Parameter()] [object]$AdditionalBody ) begin { # Initialize API Key [securestring]$SecureToken = Initialize-APIKey -ApiKey $ApiKey # Initialize API Base $ApiBase = Initialize-APIBase -ApiBase $ApiBase -ApiType $ApiType # Initialize Organization ID $Organization = Initialize-OrganizationID -OrgId $Organization # Get API context $OpenAIParameter = Get-OpenAIContext -EndpointName 'Audio.Transcription' -ApiType $ApiType -AuthType $AuthType -ApiBase $ApiBase -ApiVersion $ApiVersion -Engine $Model # Convert language name to ISO-639-1 format (if we can) if ($PSCmdlet.ParameterSetName -eq 'Language' -and $PSBoundParameters.ContainsKey('Language')) { $ci = Get-CultureInfo -LanguageName $Language -ErrorAction Ignore if ($ci -is [cultureinfo]) { $Language = $ci.TwoLetterISOLanguageName } } elseif ($PSBoundParameters.ContainsKey('LiteralLanguage')) { $Language = $LiteralLanguage } } process { $FileInfo = (Get-Item -LiteralPath $File) # (Only PS6+) # If the filename contains non-ASCII characters, # the OpenAI API cannot recognize the file format correctly and returns an error. # As a workaround, copy the file to a temporary file and send it. # We need to find a better way. $IsTempFileCreated = $false if ($PSVersionTable.PSVersion.Major -ge 6) { if ($FileInfo.Name -match '[^\u0000-\u007F]') { Write-Warning 'File name contains non-ASCII characters. It is strongly recommended that file name only contains ASCII characters.' $FileInfo = Copy-TempFile -SourceFile $FileInfo -ErrorAction Stop $IsTempFileCreated = $true } } #region Construct parameters for API request $PostBody = [System.Collections.Specialized.OrderedDictionary]::new() if ($ApiType -eq [OpenAIApiType]::OpenAI) { $PostBody.model = $Model } $PostBody.file = $FileInfo if ($Format) { $PostBody.response_format = $Format } if ($PSBoundParameters.ContainsKey('Prompt')) { $PostBody.prompt = $Prompt } if ($PSBoundParameters.ContainsKey('Temperature')) { $PostBody.temperature = $Temperature } if ($PSBoundParameters.ContainsKey('TimestampGranularities')) { $PostBody.timestamp_granularities = $TimestampGranularities } if ($Language) { $PostBody.language = $Language } #region Send API Request try { $splat = @{ Method = $OpenAIParameter.Method Uri = $OpenAIParameter.Uri ContentType = $OpenAIParameter.ContentType TimeoutSec = $TimeoutSec MaxRetryCount = $MaxRetryCount ApiKey = $SecureToken AuthType = $OpenAIParameter.AuthType Organization = $Organization Body = $PostBody AdditionalQuery = $AdditionalQuery AdditionalHeaders = $AdditionalHeaders AdditionalBody = $AdditionalBody } $Response = Invoke-OpenAIAPIRequest @splat } finally { if ($IsTempFileCreated -and (Test-Path $FileInfo -PathType Leaf)) { Remove-Item $FileInfo -Force -ErrorAction SilentlyContinue } } # error check if ($null -eq $Response) { return } #endregion #region Output Write-Output $Response #endregion } end { } } |