Public/Images/Request-ImageGeneration.ps1
|
function Request-ImageGeneration { [CmdletBinding(DefaultParameterSetName = 'Format')] param ( [Parameter(Mandatory, Position = 0, ValueFromPipeline)] [ValidateNotNullOrEmpty()] [string]$Prompt, [Parameter()] [Completions( 'gpt-image-1', 'dall-e-3', 'dall-e-2' )] [string]$Model = 'dall-e-2', [Parameter()] [ValidateRange(1, 10)] [Alias('n')] [uint16]$NumberOfImages = 1, [Parameter()] [ValidateSet('auto', '1024x1024', '1536x1024', '1024x1536', '256x256', '512x512', '1792x1024', '1024x1792')] [string]$Size = 'auto', [Parameter()] [ValidateSet('standard', 'hd', 'low', 'medium', 'high', 'auto')] [string][LowerCaseTransformation()]$Quality = 'auto', [Parameter()] [ValidateSet('vivid', 'natural')] [string][LowerCaseTransformation()]$Style = 'vivid', [Parameter()] [ValidateSet('transparent', 'opaque', 'auto')] [string][LowerCaseTransformation()]$Background = 'auto', [Parameter()] [ValidateSet('low', 'auto')] [string][LowerCaseTransformation()]$Moderation = 'auto', [Parameter()] [Alias('output_compression')] [ValidateRange(0, 100)] [uint16]$OutputCompression = 100, [Parameter()] [Alias('output_format')] [ValidateSet('png', 'jpeg', 'webp')] [string][LowerCaseTransformation()]$OutputFormat = 'png', [Parameter(ParameterSetName = 'Format')] [Alias('response_format')] [ValidateSet('url', 'base64', 'byte')] [string]$ResponseFormat = 'url', [Parameter(ParameterSetName = 'Format')] [switch]$OutputRawResponse, [Parameter(ParameterSetName = 'OutFile', Mandatory)] [ValidateNotNullOrEmpty()] [string]$OutFile, [Parameter()] [string]$User, [Parameter()] [int]$TimeoutSec = 0, [Parameter()] [OpenAIApiType]$ApiType = [OpenAIApiType]::OpenAI, [Parameter()] [System.Uri]$ApiBase, [Parameter(DontShow)] [string]$ApiVersion, [Parameter()] [ValidateSet('openai', 'azure', 'azure_ad')] [string]$AuthType = 'openai', [Parameter()] [ValidateRange(0, 100)] [int]$MaxRetryCount = 0, [Parameter()] [securestring][SecureStringTransformation()]$ApiKey, [Parameter()] [Alias('OrgId')] [string]$Organization, [Parameter()] [System.Collections.IDictionary]$AdditionalQuery, [Parameter()] [System.Collections.IDictionary]$AdditionalHeaders, [Parameter()] [object]$AdditionalBody ) begin { # Get API context $OpenAIParameter = Get-OpenAIAPIParameter -EndpointName 'Image.Generation' -Parameters $PSBoundParameters -Engine $Model -ErrorAction Stop } process { #region Construct parameters for API request $PostBody = [System.Collections.Specialized.OrderedDictionary]::new() $PostBody.prompt = $Prompt if ($OpenAIParameter.ApiType -eq [OpenAIApiType]::OpenAI) { if ($PSBoundParameters.ContainsKey('Model')) { $PostBody.model = $Model } } if ($PSBoundParameters.ContainsKey('NumberOfImages')) { $PostBody.n = $NumberOfImages } if ($PSBoundParameters.ContainsKey('Size')) { $PostBody.size = $Size } if ($PSBoundParameters.ContainsKey('Quality')) { $PostBody.quality = $Quality } if ($PSBoundParameters.ContainsKey('Style')) { $PostBody.style = $Style } if ($PSBoundParameters.ContainsKey('Background')) { $PostBody.background = $Background } if ($PSBoundParameters.ContainsKey('Moderation')) { $PostBody.moderation = $Moderation } if ($PSBoundParameters.ContainsKey('OutputCompression')) { $PostBody.output_compression = $OutputCompression } if ($PSBoundParameters.ContainsKey('User')) { $PostBody.user = $User } switch ($ResponseFormat) { { $Model -like 'gpt-image-*' } { # GPT-Image model does not support response_format parameter break } { $PSCmdlet.ParameterSetName -eq 'OutFile' } { $PostBody.response_format = 'b64_json' break } 'url' { $PostBody.response_format = 'url' break } 'base64' { $PostBody.response_format = 'b64_json' break } 'byte' { $PostBody.response_format = 'b64_json' break } } if ($Model -like 'gpt-image-*') { # The output_format parameter is only supported for gpt-image-1. if ($PSBoundParameters.ContainsKey('OutputFormat')) { $PostBody.output_format = $OutputFormat } elseif ($PSCmdlet.ParameterSetName -eq 'OutFile') { $ext = [System.IO.Path]::GetExtension($OutFile).ToLower() if ($ext -eq '.png') { $PostBody.output_format = 'png' } elseif ($ext -eq '.jpeg' -or $ext -eq '.jpg') { $PostBody.output_format = 'jpeg' } elseif ($ext -eq '.webp') { $PostBody.output_format = 'webp' } else { $PostBody.output_format = 'png' } } } #endregion #region Send API Request $splat = @{ Method = $OpenAIParameter.Method Uri = $OpenAIParameter.Uri ContentType = $OpenAIParameter.ContentType TimeoutSec = $OpenAIParameter.TimeoutSec MaxRetryCount = $OpenAIParameter.MaxRetryCount ApiKey = $OpenAIParameter.ApiKey AuthType = $OpenAIParameter.AuthType Organization = $OpenAIParameter.Organization Body = $PostBody AdditionalQuery = $AdditionalQuery AdditionalHeaders = $AdditionalHeaders AdditionalBody = $AdditionalBody } $Response = Invoke-OpenAIAPIRequest @splat # error check if ($null -eq $Response) { return } #endregion #region Parse response object if ($OutputRawResponse) { Write-Output $Response return } try { $Response = $Response | ConvertFrom-Json -ErrorAction Stop if ($null -ne $Response.error.message) { Write-Error -Message ('API returned error: ({0}) {1}' -f $Response.error.code, $Response.error.message) return } } catch { Write-Error -Exception $_.Exception } if ($null -ne $Response.data) { $ResponseContent = $Response.data } #endregion #region Output if ($PSCmdlet.ParameterSetName -eq 'OutFile') { $AbsoluteFilePath = New-ParentFolder -File $OutFile # Save image $ResponseContent | Select-Object -ExpandProperty 'b64_json' | ForEach-Object -Begin { $Suffix = 0 } -Process { if ( $Suffix -gt 0) { $Ext = [System.IO.Path]::GetExtension($AbsoluteFilePath) $BaseName = [System.IO.Path]::GetFileNameWithoutExtension($AbsoluteFilePath) $FileName = '{0}-{1}{2}' -f $BaseName, $Suffix, $Ext $SaveToPath = Join-Path (Split-Path $AbsoluteFilePath -Parent) $FileName } else { $SaveToPath = $AbsoluteFilePath } Write-Verbose ('Save image to {0}' -f $SaveToPath) try { [System.IO.File]::WriteAllBytes($SaveToPath, [Convert]::FromBase64String($_)) } catch { Write-Error -Exception $_.Exception } $Suffix++ } } elseif ($ResponseFormat -eq 'url') { Write-Output ($ResponseContent | Select-Object -ExpandProperty 'url') } elseif ($ResponseFormat -eq 'base64') { Write-Output ($ResponseContent | Select-Object -ExpandProperty 'b64_json') } elseif ($ResponseFormat -eq 'byte') { $ByteArrayList = [System.Collections.Generic.List[byte[]]]::new() $ResponseContent | Select-Object -ExpandProperty 'b64_json' | ForEach-Object { $ByteArrayList.Add([Convert]::FromBase64String($_)) } if ( $ByteArrayList.Count -eq 1) { Write-Output ($ByteArrayList[0]) } else { Write-Output ($ByteArrayList.ToArray()) } } #endregion } end { } } |