Public/Batch/Get-Batch.ps1
|
function Get-Batch { [CmdletBinding(DefaultParameterSetName = 'List')] [OutputType([pscustomobject])] param ( [Parameter(ParameterSetName = 'Get_Batch', Mandatory, Position = 0, ValueFromPipeline, ValueFromPipelineByPropertyName)] [PSTypeName('PSOpenAI.Batch')]$Batch, [Parameter(ParameterSetName = 'Get_Id', Mandatory, Position = 0, ValueFromPipeline, ValueFromPipelineByPropertyName)] [ValidateNotNullOrEmpty()] [Alias('batch_id')] [Alias('Id')] # for backword compatibility [string][UrlEncodeTransformation()]$BatchId, [Parameter(ParameterSetName = 'List')] [ValidateRange(1, 100)] [int]$Limit = 20, [Parameter(ParameterSetName = 'List')] [switch]$All, [Parameter(ParameterSetName = 'List', DontShow)] [string]$After, # [Parameter(ParameterSetName = 'ListAll', DontShow)] # [string]$Before, # [Parameter(ParameterSetName = 'List')] # [Parameter(ParameterSetName = 'ListAll')] # [ValidateSet('asc', 'desc')] # [string][LowerCaseTransformation()]$Order = 'asc', [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 'Batch' -Parameters $PSBoundParameters -ErrorAction Stop # Iterator flag [bool]$HasMore = $true } process { # Get id if ($PSCmdlet.ParameterSetName -like '*_Batch') { $BatchId = $Batch.id if (-not $BatchId) { Write-Error -Exception ([System.ArgumentException]::new('Could not retrieve batch id.')) return } } # Create cancellation token for timeout $Cancellation = [System.Threading.CancellationTokenSource]::new() if ($TimeoutSec -gt 0) { $Cancellation.CancelAfter([timespan]::FromSeconds($TimeoutSec)) } try { #region Pagenaion Loop while ($HasMore) { #region Construct Query URI $UriBuilder = [System.UriBuilder]::new($OpenAIParameter.Uri) if ($PSCmdlet.ParameterSetName -like 'Get_*') { $UriBuilder.Path += "/$BatchId" $QueryUri = $UriBuilder.Uri } else { $QueryParam = [System.Web.HttpUtility]::ParseQueryString($UriBuilder.Query) if ($All) { $Limit = 100 } $QueryParam.Add('limit', $Limit) # $QueryParam.Add('order', $Order) if ($After) { $QueryParam.Add('after', $After) } # if ($Before) { # $QueryParam.Add('before', $Before) # } $UriBuilder.Query = $QueryParam.ToString() $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 # Check cancellation $Cancellation.Token.ThrowIfCancellationRequested() # Update iterator flag if ($HasMore = [bool]$Response.has_more) { if ($All -and $Response.last_id) { $After = $Response.last_id } else { $HasMore = $false if (-not $PSBoundParameters.ContainsKey('Limit')) { Write-Warning 'There is more data that has not been retrieved.' } } } #region Output ## NOTE: In Azure API version 2024-07-01-preview, the response does not have 'object' property. (It seems that is a bug.) # if ($Response.object -eq 'list' -and ($null -ne $Response.data)) { if ($null -ne $Response.data) { # List of object $Responses = @($Response.data) } else { # Single object $Responses = @($Response) } # parse objects foreach ($res in $Responses) { ParseBatchObject $res } #endregion #region Pagenation if ($Response.has_more) { if ($All) { # pagenate $PagenationParam = $PSBoundParameters $PagenationParam.After = $Response.last_id PSOpenAI\Get-Bacth @PagenationParam } else { # Display warning message if there is more data. (Except when the user specifies -Limit parameter explicitly.) if (-not $PSBoundParameters.ContainsKey('Limit')) { Write-Warning 'There is more data that has not been retrieved.' } } } #endregion } #endregion } catch [OperationCanceledException] { Write-TimeoutError return } catch { Write-Error -Exception $_.Exception return } finally { if ($null -ne $Cancellation) { $Cancellation.Dispose() } } } end { } } |