Private/Invoke-OpenAIAPIRequestSSE.ps1
|
using namespace System.Text using namespace System.Net using namespace System.Net.Http using namespace System.Management.Automation using namespace Microsoft.PowerShell.Commands # Workaround for assemblies loading issue on PS5.1 if ($PSVersionTable.PSVersion.Major -le 5) { Add-Type -AssemblyName System.Net.Http } $script:HttpStreamClientHandler = @{ HttpClient = $null Expires = $null } function Invoke-OpenAIAPIRequestSSE { [CmdletBinding()] param ( [Parameter()] [string]$Method = 'Post', [Parameter(Mandatory)] [System.Uri]$Uri, [Parameter()] [string]$ContentType = 'application/json', [Parameter(Mandatory)] [ValidateNotNull()] [securestring]$ApiKey, [Parameter()] [string]$Organization, [Parameter()] [object]$Body, [Parameter()] [IDictionary]$Headers, [Parameter()] [int]$TimeoutSec = 0, [Parameter()] [int]$MaxRetryCount = 0, [Parameter()] [int]$RetryCount = 0, [Parameter()] # [ValidateSet('openai', 'azure', 'azure_ad')] [string]$AuthType = 'openai' ) #region Set variables $IsDebug = Test-Debug $ServiceName = switch -Wildcard ($AuthType) { 'openai*' { 'OpenAI' } 'azure*' { 'Azure OpenAI' } } #endregion # Decrypt securestring $PlainToken = DecryptSecureString $ApiKey # Create HttpClient that has 5 min lifetime to reuse if ($null -eq $script:HttpClientHandler.HttpClient -or $script:HttpClientHandler.Expires -lt [datetime]::Now) { $script:HttpClientHandler.HttpClient = [System.Net.Http.HttpClient]::new() $script:HttpClientHandler.Expires = [datetime]::Now.AddMinutes(5) } # Create HttpRequestMessage $RequestMessage = [System.Net.Http.HttpRequestMessage]::new($Method, $Uri) # Use HTTP/2 if ($null -ne [System.Net.HttpVersion]::Version20) { $RequestMessage.Version = [System.Net.HttpVersion]::Version20 } if ($null -ne $Body) { $RequestMessage.Content = [System.Net.Http.StringContent]::new(($Body | ConvertTo-Json -Compress -Depth 100), [Encoding]::UTF8, $ContentType) } # Set User-Agent if (-not $script:UserAgent) { $script:UserAgent = Get-UserAgent } $RequestMessage.Headers.Add('User-Agent', $script:UserAgent) # Set debug header if ($IsDebug) { $RequestMessage.Headers.Add('OpenAI-Debug', 'true') } # Set other headers if ($PSBoundParameters.ContainsKey('Headers') -and $null -ne $Headers) { foreach ($h in $Headers.GetEnumerator()) { if (-not $RequestMessage.Headers.Contains($h.Key)) { $RequestMessage.Headers.Add($h.Key, $h.Value) } } } switch ($AuthType) { 'openai' { $RequestMessage.Headers.Authorization = [System.Net.Http.Headers.AuthenticationHeaderValue]::new('Bearer', $PlainToken) if (-not [string]::IsNullOrWhiteSpace($Organization)) { $RequestMessage.Headers.Add('OpenAI-Organization', $Organization.Trim()) } } 'azure' { $RequestMessage.Headers.Add('api-key', $PlainToken) } 'azure_ad' { $RequestMessage.Headers.Authorization = [System.Net.Http.Headers.AuthenticationHeaderValue]::new('Bearer', $PlainToken) } default { # covers null $RequestMessage.Headers.Authorization = [System.Net.Http.Headers.AuthenticationHeaderValue]::new('Bearer', $PlainToken) } } # Set timeout $cts = [System.Threading.CancellationTokenSource]::new() if ($TimeoutSec -gt 0 -and $TimeoutSec -lt ([int]::MaxValue / 1000)) { $cts.CancelAfter($TimeoutSec * 1000) } $CancelToken = $cts.Token # Verbose / Debug output Write-Verbose -Message "Request to $ServiceName API" Write-Verbose -Message "Method = $Method, Path = $Uri" Write-Verbose -Message ('Request HTTP/{0} {1} with {2}-byte payload' -f ` $RequestMessage.Version, $RequestMessage.Method, ` $($RequestMessage.Content.Headers.ContentLength -as [Int64])) if ($IsDebug) { $startIdx = $lastIdx = 2 if ($AuthType -eq 'openai') { $startIdx += 4 } # 'org-' $MaskedMessage = Get-MaskedString ` ('Request parameters: ' + ($RequestMessage | Format-List Method, RequestUri, @{name = 'Headers'; expression = { $_.Headers.ToString() } } | Out-String)).TrimEnd() ` -Target ($ApiKey, $Organization) -First $startIdx -Last $lastIdx -MaxNumberOfAsterisks 45 Write-Debug -Message $MaskedMessage $MaskedMessage = $null } # Send API Request try { $HttpResponse = $script:HttpClientHandler.HttpClient.SendAsync($RequestMessage, [System.Net.Http.HttpCompletionOption]::ResponseHeadersRead, $CancelToken).GetAwaiter().GetResult() #region On HTTP error if (-not $HttpResponse.IsSuccessStatusCode) { $ErrorCode = $HttpResponse.StatusCode.value__ $ErrorReason = $HttpResponse.ReasonPhrase $Body = $HttpResponse.Content.ReadAsStringAsync().GetAwaiter().GetResult() $ErrorContent = try { ($Body | ConvertFrom-Json -ErrorAction Ignore) }catch {} $ErrorObject = Parse-WebExceptionResponse -ErrorCode $ErrorCode -ErrorReason $ErrorReason -ErrorResponse $HttpResponse -ErrorContent $ErrorContent # Retry if (Should-Retry -ErrorCode $ErrorObject.StatusCode -ErrorMessage $ErrorObject.Message -Headers $ErrorObject.Response.Headers -RetryCount $RetryCount -MaxRetryCount $MaxRetryCount) { $Delay = Get-RetryDelay -RetryCount $RetryCount -ResponseHeaders $ErrorObject.Response.Headers Write-Warning $ErrorObject.Message Write-Warning ('Retry the request after waiting {0} ms (retry count: {1})' -f $Delay, $RetryCount) Start-Sleep -Milliseconds $Delay $PSBoundParameters.RetryCount = (++$RetryCount) Invoke-OpenAIAPIRequestSSE @PSBoundParameters return } # Throw exception $er = [ErrorRecord]::new( $ErrorObject, ('PSOpenAI.APIRequest.{0}' -f $ErrorObject.GetType().Name), [ErrorCategory]::InvalidOperation, $null ) $er.ErrorDetails = $ErrorObject.Message $PSCmdlet.ThrowTerminatingError($er) return } #endregion $ResponseStream = $HttpResponse.Content.ReadAsStreamAsync().Result $StreamReader = [System.IO.StreamReader]::new($ResponseStream, [Encoding]::UTF8) # Verbose / Debug output Write-Verbose -Message ('Received HTTP/{0} response of content type {1}' -f $HttpResponse.Version, $HttpResponse.Content.Headers.ContentType.MediaType) Write-Verbose -Message ("$ServiceName API response: " + ($HttpResponse | Format-List ` StatusCode, ` @{name = 'processing_ms'; expression = { $_.Headers.GetValues('openai-processing-ms')[0] } }, ` @{name = 'request_id'; expression = { $_.Headers.GetValues('X-Request-Id')[0] } } | Out-String)).TrimEnd() # Don't read the whole stream for debug logging unless necessary. if ($IsDebug) { $startIdx = $lastIdx = 2 if ($AuthType -eq 'openai') { $startIdx += 4 } # 'org-' Write-Debug -Message (Get-MaskedString ` ('API response header: ' + ($HttpResponse.Headers | Format-Table -Hide | Out-String)).TrimEnd() ` -Target ($ApiKey, $Organization) -First $startIdx -Last $lastIdx -MaxNumberOfAsterisks 45) } while (-not $StreamReader.EndOfStream) { $data = $null #Timeout $CancelToken.ThrowIfCancellationRequested() #Retrive response content $data = [string]$StreamReader.ReadLine() # Skip on empty if ([string]::IsNullOrWhiteSpace($data)) { continue } else { # Debug output if ($IsDebug) { Write-Debug -Message ('API response body: ' + ($data | Out-String)).TrimEnd() } # Event if ($data.StartsWith('event: ', [StringComparison]::Ordinal)) { #Verbose output Write-Verbose -Message $data } # Data elseif ($data.StartsWith('data: ', [StringComparison]::Ordinal)) { # End of stream if ($data -eq 'data: [DONE]') { Write-Verbose -Message ('Received the signal of the end of stream') break } else { #Output Write-Output $data.Substring(6) # ("data: ").Length -> 6 } } } } } catch [OperationCanceledException] { # Convert OperationCanceledException to TimeoutException $er = [ErrorRecord]::new( ([TimeoutException]::new('The operation was canceled due to timeout.', $_.Exception)), 'PSOpenAI.APIRequest.TimeoutException', [ErrorCategory]::OperationTimeout, $null ) $er.ErrorDetails = $_.Exception.Message $PSCmdlet.ThrowTerminatingError($er) } catch { $PSCmdlet.ThrowTerminatingError($_) } finally { $PlainToken = $null try { if ($null -ne $cts) { $cts.Dispose() } if ($null -ne $HttpResponse) { $HttpResponse.Dispose() } if ($null -ne $ResponseStream) { $ResponseStream.Dispose() } if ($null -ne $RequestMessage) { $RequestMessage.Dispose() } } catch {} } } |