Public/VectorStores/Files/Get-VectorStoreFile.ps1
|
function Get-VectorStoreFile { [CmdletBinding(DefaultParameterSetName = 'List_VectorStore')] [OutputType([pscustomobject])] param ( [Parameter(ParameterSetName = 'Get_VectorStore', Mandatory, Position = 0, ValueFromPipeline, ValueFromPipelineByPropertyName)] [Parameter(ParameterSetName = 'List_VectorStore', Mandatory, Position = 0, ValueFromPipeline, ValueFromPipelineByPropertyName)] [Alias('InputObject')] # for backword compatibility [PSTypeName('PSOpenAI.VectorStore')]$VectorStore, [Parameter(ParameterSetName = 'Get_Id', Mandatory, Position = 0, ValueFromPipeline, ValueFromPipelineByPropertyName)] [Parameter(ParameterSetName = 'List_Id', Mandatory, Position = 0, ValueFromPipeline, ValueFromPipelineByPropertyName)] [ValidateNotNullOrEmpty()] [Alias('vector_store_id')] [string][UrlEncodeTransformation()]$VectorStoreId, [Parameter(ParameterSetName = 'Get_VectorStore', Mandatory, Position = 1, ValueFromPipelineByPropertyName)] [Parameter(ParameterSetName = 'Get_Id', Mandatory, Position = 1, ValueFromPipelineByPropertyName)] [ValidateNotNullOrEmpty()] [Alias('file_id')] [string][UrlEncodeTransformation()]$FileId, [Parameter(ParameterSetName = 'Get_VectorStoreFile', Mandatory, Position = 0, ValueFromPipeline, ValueFromPipelineByPropertyName)] [PSTypeName('PSOpenAI.VectorStore.File')]$VectorStoreFile, [Parameter(ParameterSetName = 'List_VectorStore')] [Parameter(ParameterSetName = 'List_Id')] [ValidateRange(1, 100)] [int]$Limit = 20, [Parameter(ParameterSetName = 'List_VectorStore')] [Parameter(ParameterSetName = 'List_Id')] [switch]$All, [Parameter(ParameterSetName = 'List_VectorStore', DontShow)] [Parameter(ParameterSetName = 'List_Id', DontShow)] [string]$After, [Parameter(ParameterSetName = 'List_VectorStore', DontShow)] [Parameter(ParameterSetName = 'List_Id', DontShow)] [string]$Before, [Parameter(ParameterSetName = 'List_VectorStore')] [Parameter(ParameterSetName = 'List_Id')] [ValidateSet('asc', 'desc')] [string][LowerCaseTransformation()]$Order = 'asc', [Parameter(ParameterSetName = 'List_VectorStore')] [Parameter(ParameterSetName = 'List_Id')] [ValidateSet('in_progress', 'completed', 'failed', 'cancelled')] [string][LowerCaseTransformation()]$Filter, [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 'VectorStore.Files' -Parameters $PSBoundParameters -ErrorAction Stop } process { # Get ids if ($PSCmdlet.ParameterSetName -like '*_VectorStore') { $VectorStoreId = $VectorStore.id } elseif ($PSCmdlet.ParameterSetName -like '*_VectorStoreFile') { $VectorStoreId = $VectorStoreFile.vector_store_id $FileId = $VectorStoreFile.id } if (-not $VectorStoreId) { Write-Error -Exception ([System.ArgumentException]::new('Could not retrieve vector store id.')) return } $QueryUri = $OpenAIParameter.Uri.ToString() -f $VectorStoreId $UriBuilder = [System.UriBuilder]::new($QueryUri) if ($PSCmdlet.ParameterSetName -like 'Get_*') { $UriBuilder.Path += "/$FileId" $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); } if ($Filter) { $QueryParam.Add('filter', $Filter); } $UriBuilder.Query = $QueryParam.ToString() $QueryUri = $UriBuilder.Uri } #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 Headers = @{'OpenAI-Beta' = 'assistants=v2' } 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 } #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) { ParseVectorStoreFileObject $res } #endregion #region Pagenation if ($Response.has_more) { if ($All) { # pagenate $PagenationParam = $PSBoundParameters $PagenationParam.After = $Response.last_id PSOpenAI\Get-VectorStoreFile @PagenationParam } else { Write-Warning 'There is more data that has not been retrieved.' } } #endregion } end { } } |