Public/Responses/Get-Response.ps1
|
function Get-Response { [CmdletBinding(DefaultParameterSetName = 'Get_Id')] [OutputType([pscustomobject])] param ( [Parameter(ParameterSetName = 'Get_Response', Mandatory, Position = 0, ValueFromPipeline)] [Alias('InputObject')] [PSTypeName('PSOpenAI.Response')]$Response, [Parameter(ParameterSetName = 'Get_Id', Mandatory, Position = 0, ValueFromPipeline, ValueFromPipelineByPropertyName)] [ValidateNotNullOrEmpty()] [Alias('Id')] [Alias('response_id')] [string][UrlEncodeTransformation()]$ResponseId, # For internal use [Parameter(DontShow)] [switch]$Primitive, [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 { # Get API context $OpenAIParameter = Get-OpenAIAPIParameter -EndpointName 'Responses' -Parameters $PSBoundParameters -ErrorAction Stop # Parse Common params $CommonParams = ParseCommonParams $PSBoundParameters # Iterator flag [bool]$HasMore = $true } process { # Get id if ($PSCmdlet.ParameterSetName -ceq 'Get_Response') { $ResponseId = $Response.id if (-not $ResponseId) { Write-Error -Exception ([System.ArgumentException]::new('Could not retrieve response id.')) return } } #region Construct Query URI $UriBuilder = [System.UriBuilder]::new($OpenAIParameter.Uri) $UriBuilder.Path += "/$ResponseId" $QueryUri = $UriBuilder.Uri #endregion #region Send API Request $params = @{ Method = 'Get' Uri = $QueryUri # ContentType = $OpenAIParameter.ContentType TimeoutSec = $OpenAIParameter.TimeoutSec MaxRetryCount = $OpenAIParameter.MaxRetryCount ApiKey = $OpenAIParameter.ApiKey AuthType = $OpenAIParameter.AuthType Organization = $OpenAIParameter.Organization AdditionalQuery = $AdditionalQuery AdditionalHeaders = $AdditionalHeaders AdditionalBody = $AdditionalBody } $Response = Invoke-OpenAIAPIRequest @params # error check if ($null -eq $Response) { return } #endregion #region Parse response object try { $Response = $Response | ConvertFrom-Json -ErrorAction Stop } catch { Write-Error -Exception $_.Exception return } #endregion #region Output if ($Response.object -eq 'list' -and ($null -ne $Response.data)) { # List of object $Responses = @($Response.data) } else { # Single object $Responses = @($Response) } # parse objects foreach ($res in $Responses) { # get messages $Messages = [System.Collections.Generic.List[object]]::new() if (-not $Primitive) { Get-ResponseInputItem -ResponseId $res.id -All -Order asc @CommonParams | ForEach-Object { $Messages.Add($_) } } # Add assistant response to messages list. if (@($res.output).Count -ge 1) { $Messages.AddRange(@($res.output)) } # parse object ParseResponseObject $res -Messages $Messages -WarningAction Ignore } #endregion } end { } } |