Types/OpenAIClient.ps1
|
class OpenAIClient { [System.Management.Automation.HiddenAttribute()] [string]$apikey [System.Management.Automation.HiddenAttribute()] [string]$baseUri [System.Management.Automation.HiddenAttribute()] [string]$model [System.Management.Automation.HiddenAttribute()] [hashtable]$headers [System.Management.Automation.HiddenAttribute()] [string]$apiVersion [Assistant]$assistants [Vector_store]$vector_stores [File]$files [Thread]$threads OpenAIClient([string]$apiKey, [string]$baseUri, [string]$model, [string]$apiVersion) { $this.apikey = $apiKey $this.baseUri = $baseUri $this.model = $model $this.apiVersion = $apiVersion $this.init() } [System.Management.Automation.HiddenAttribute()] [void]init() { # check the apikey, endpoint and model, if empty, then return error $this.headers = @{ "OpenAI-Beta" = "assistants=v2" } if ($this.baseUri -match "azure") { $this.headers.Add("api-key", $this.apikey) $this.baseUri = $this.baseUri + "openai/" } else { $this.headers.Add("Authorization", "Bearer $($this.apikey)") $this.apiVersion = "" } $this.assistants = [Assistant]::new($this) $this.vector_stores = [Vector_store]::new($this) $this.files = [File]::new($this) $this.threads = [Thread]::new($this) } [psobject]web( [string]$urifragment, [string]$method = "GET", [psobject]$body = $null) { $url = "{0}{1}" -f $this.baseUri, $urifragment if ($this.apiVersion -ne "") { if ($url -match "\?") { $url = "{0}&api-version={1}" -f $url, $this.apiVersion } else { $url = "{0}?api-version={1}" -f $url, $this.apiVersion } } if ($method -eq "GET" -or $null -eq $body) { $params = @{ Method = $method Uri = $url Headers = $this.headers } return $this.unicodeiwr($params) } else { $params = @{ Method = $method Uri = $url Headers = $this.headers Body = ($body | ConvertTo-Json -Depth 10) } return $this.unicodeiwr($params) } } [System.Management.Automation.HiddenAttribute()] [psobject]unicodeiwr([hashtable]$params) { $oldProgressPreference = Get-Variable -Name ProgressPreference -ValueOnly Set-Variable -Name ProgressPreference -Value "SilentlyContinue" -Scope Script -Force $response = Invoke-WebRequest @params -ContentType "application/json;charset=utf-8" Set-Variable -Name ProgressPreference -Value $oldProgressPreference -Scope Script -Force $contentType = $response.Headers["Content-Type"] $version = Get-Variable -Name PSVersionTable -ValueOnly if ($version.PSVersion.Major -gt 5 -or $contentType -match 'charset=utf-8') { return $response.Content | ConvertFrom-Json } else { $response = $response.Content $charset = if ($contentType -match "charset=([^;]+)") { $matches[1] } else { "ISO-8859-1" } $dstEncoding = [System.Text.Encoding]::GetEncoding($charset) $srcEncoding = [System.Text.Encoding]::UTF8 $result = $srcEncoding.GetString([System.Text.Encoding]::Convert($srcEncoding, $dstEncoding, $srcEncoding.GetBytes($response))) return $result | ConvertFrom-Json } } [psobject]web($urifragment) { return $this.web($urifragment, "GET", @{}) } } class AssistantResource { [System.Management.Automation.HiddenAttribute()] [OpenAIClient]$client [System.Management.Automation.HiddenAttribute()] [string]$urifragment [System.Management.Automation.HiddenAttribute()] [string]$objTypeName AssistantResource([OpenAIClient]$client, [string]$urifragment, [string]$objTypeName) { $this.client = $client $this.urifragment = $urifragment $this.objTypeName = $objTypeName } [psobject[]]list() { if ($this.objTypeName) { return $this.client.web($this.urifragment).data | ForEach-Object { $temp = "{0}/{1}" -f $this.urifragment, $_.id $result = New-Object -TypeName $this.objTypeName -ArgumentList $_ $result | Add-Member -MemberType NoteProperty -Name client -Value $this.client $result | Add-Member -MemberType NoteProperty -Name urifragment -Value $temp $result } } return $this.client.web($this.urifragment).data } [psobject]get([string]$id) { if ($this.objTypeName) { $temp = "{0}/{1}" -f $this.urifragment, $id $result = New-Object -TypeName $this.objTypeName -ArgumentList $this.client.web($temp) $result | Add-Member -MemberType NoteProperty -Name client -Value $this.client $result | Add-Member -MemberType NoteProperty -Name urifragment -Value $temp return $result } return $this.client.web("$($this.urifragment)/$id") } [psobject]delete([string]$id) { return $this.client.web("$($this.urifragment)/$id", "DELETE", @{}) } [psobject]create([hashtable]$body) { if ($this.objTypeName) { $result = New-Object -TypeName $this.objTypeName -ArgumentList $this.client.web("$($this.urifragment)", "POST", $body) $result | Add-Member -MemberType NoteProperty -Name client -Value $this.client $result | Add-Member -MemberType NoteProperty -Name urifragment -Value "$($this.urifragment)/$($result.id)" return $result } return $this.client.web("$($this.urifragment)", "POST", $body) } [psobject]create() { return $this.create(@{}) } [void]clear() { # warn user this is very dangerous action, it will remove all the instance, and ask for confirmation $confirm = Read-Host "Are you sure you want to remove all the instances? (yes/no)" if ($confirm -ne "yes" -and $confirm -ne "y") { return } # get all the instances and remove it $this.list() | ForEach-Object { $this.delete($_.id) Write-Host "remove the instance: $($_.id)" } } } class AssistantResourceObject { AssistantResourceObject([psobject]$data) { # check all the properties and assign it to the object $data.PSObject.Properties | ForEach-Object { $this | Add-Member -MemberType NoteProperty -Name $_.Name -Value $_.Value } } [AssistantResourceObject]update([hashtable]$data) { $result = $this.client.web($this.urifragment, "POST", $data) return New-Object -TypeName $this.GetType().Name -ArgumentList $result } } class FileObject:AssistantResourceObject { FileObject([psobject]$data):base($data) {} [AssistantResourceObject]update([hashtable]$data) { Write-Host "You can't update the file object." return $this } } class File:AssistantResource { File([OpenAIClient]$client): base($client, "files", "FileObject") {} [psobject]create([hashtable]$body) { if ($body.files) { $files = $body.files return $this.upload($files) } throw "The body must contain 'files' key." } [System.Management.Automation.HiddenAttribute()] [FileObject[]]upload([string[]]$fullname) { $PSVersion = Get-Variable -Name PSVersionTable -ValueOnly if ($PSVersion.PSVersion.Major -lt 6) { throw "The upload file feature is only supported in PowerShell 6 or later." } # process the input, if it is a wildcard or a folder, then get all the files based on this pattern $fullname = $fullname | Get-ChildItem | Select-Object -ExpandProperty FullName # read all the files and check the filename, compute $existing_files = $this.list() | Select-Object id, @{l = "hash"; e = { $_.filename.split("-")[0] } } $localfiles = $fullname | Select-Object @{l = "fullname"; e = { $_ } }, @{l = "hash"; e = { (Get-FileHash $_).Hash } } $result = @( $existing_files | Where-Object { $_.hash -in $localfiles.hash } | ForEach-Object { [FileObject]::new($_) } ) $fullname = $localfiles | Where-Object { $_.hash -notin $existing_files.hash } | Select-Object -ExpandProperty fullname if ($fullname.Count -gt 0) { # confirm if user want to upload those files to openai $confirm = Read-Host "Are you sure you want to upload the $($fullname.Count) files? (yes/no)" if ($confirm -ne "yes" -and $confirm -ne "y") { throw "The user canceled the operation." } $url = "{0}{1}" -f $this.client.baseUri, $this.urifragment if ($this.client.baseUri -match "azure") { $url = "{0}?api-version=2024-05-01-preview" -f $url } foreach ($file in $fullname) { Write-Host "process file: $file" $name = "{0}-{1}" -f (Get-FileHash $file).Hash, (Split-Path $file -Leaf) # rename the file to the new name Rename-Item -Path $file -NewName $name $temppath = Join-Path -Path (Split-Path $file) -ChildPath $name try{ $form = @{ file = Get-Item -Path $temppath purpose = "assistants" } $response = Invoke-RestMethod -Uri $url -Method Post -Headers $this.client.headers -Form $form $result += [FileObject]::new($response) } finally{ # rename the file back to the original name Rename-Item -Path $temppath -NewName (Split-Path $file -Leaf) } } } return $result } } class Assistant:AssistantResource { Assistant([OpenAIClient]$client): base($client, "assistants", "AssistantObject") {} <# .SYNOPSIS Create a new assistant .DESCRIPTION Create a new assistant with the given name, model, and instructions. .PARAMETER body The body must contain 'name', 'model', and 'instructions' keys. But it can also contain 'config', 'vector_store_ids', 'functions', and 'files' keys. #> [AssistantObject]create([hashtable]$body) { if ($body.name -and $body.model -and $body.instructions) { $vector_store_ids = $body.vector_store_ids $functions = $body.functions $files = $body.files $config = $body.config if ($files) { # upload the files and create new vector store $file_ids = $this.client.files.create(@{ "files" = $files }) | Select-Object -ExpandProperty id $body.Add("tools", @( @{ "type" = "file_search" })) $body.Add("tool_resources", @{ "file_search" = @{ "vector_stores" = @( @{ file_ids = @($file_ids) }) } }) } if ($vector_store_ids -and $vector_store_ids.Count -gt 0) { $body.Add("tool_resources", @{ "file_search" = @{ "vector_store_ids" = @($vector_store_ids) } }) $body.Add("tools", @( @{ "type" = "file_search" })) } if ($functions -and $functions.Count -gt 0) { if ($null -eq $body.tools) { $body.Add("tools", @()) } $functions | ForEach-Object { $func = Get-FunctionJson -functionName $_ $body.tools += $func } } if ($config) { #if config is not hashtable, then convert it to hashtable if ($config -isnot [hashtable]) { $config = ConvertTo-Hashtable $config } Merge-Hashtable -table1 $body -table2 $config } # remove files, vector_store_ids, functions, and config from the body $body.Remove("files") $body.Remove("vector_store_ids") $body.Remove("functions") $body.Remove("config") $result = [AssistantObject]::new($this.client.web("$($this.urifragment)", "POST", $body)) $result | Add-Member -MemberType NoteProperty -Name client -Value $this.client $result | Add-Member -MemberType NoteProperty -Name urifragment -Value "$($this.urifragment)/$($result.id)" return $result } throw "The body must contain 'name' and 'model', 'instructions' keys." } } class AssistantObject:AssistantResourceObject { [ThreadObject]$thread AssistantObject([psobject]$data):base($data) {} [void]chat([bool]$clean = $false) { if (-not $this.thread) { # create a thread, and associate the assistant id $this.thread = $this.client.threads.create($this.id) } try { while ($true) { # ask use to input, until the user type 'q' or 'bye' $prompt = Read-Host ">" if ($prompt -eq "q" -or $prompt -eq "bye") { break } # send the message to the thread $response = $this.thread.send($prompt).run().get_last_message() if ($response) { Write-Host $response -ForegroundColor Green } } } finally { $this.client.threads.delete($this.thread.id) if ($clean) { Write-Host "clean up the thread, assistant, and vector_store..." -ForegroundColor Yellow # clean up the thread, assistant, and vector_store $vc_id = $this.tool_resources.file_search.vector_store_ids[0] $this.client.vector_stores.delete($vc_id) $this.client.assistants.delete($this.id) } } } } class ThreadObject:AssistantResourceObject { ThreadObject([psobject]$data):base($data) {} [ThreadObject]send([string]$message) { # send a message [AssistantResource]::new($this.client, ("threads/{0}/messages" -f $this.id), $null ).create(@{ role = "user" content = $message }) | Out-Null return $this } [ThreadObject]run([string]$assistantId) { $obj = [AssistantResource]::new($this.client, ("threads/{0}/runs" -f $this.id), $null ).create(@{assistant_id = $assistantId }) if ($null -eq $this.last_run_id) { $this | Add-Member -MemberType NoteProperty -Name last_run_id -Value $obj.id } else { $this.last_run_id = $obj.id } return $this } [ThreadObject]run() { return $this.run($this.assistant_id) } [string]get_last_message() { # check if the last_run is set, if not, then return null if ($this.last_run_id) { $run = [AssistantResource]::new($this.client, ("threads/{0}/runs" -f $this.id), $null ).get($this.last_run_id) while ($run.status -ne "completed") { Write-Verbose ("Run status: {0}" -f $run.status) if ($run.status -eq "failed") { Write-Host ("Run failed: {0}" -f $run.last_error.message) -ForegroundColor Red break } # The status of the run, which can be either queued, in_progress, requires_action, cancelling, cancelled, failed, completed, incomplete, or expired. if ($run.status -eq "requires_action") { $tool_calls = $run.required_action.submit_tool_outputs.tool_calls $tool_output = @() if ($tool_calls -and $tool_calls.Count -gt 0) { foreach ($tool_call in $tool_calls) { $call_id = $tool_call.id $function = $tool_call.function $function_args = $function.arguments | ConvertFrom-Json $exp = "{0} {1}" -f $function.name, (($function_args.PSObject.Properties | ForEach-Object { "-{0} '{1}'" -f $_.Name, $_.Value }) -join " ") Write-Verbose "calling function with arguments: $exp" $call_response = Invoke-Expression $exp $tool_output += @{ tool_call_id = $call_id output = $call_response } } } [AssistantResource]::new($this.client, ("threads/{0}/runs/{1}/submit_tool_outputs" -f $this.id, $this.last_run_id), $null ).create(@{tool_outputs = $tool_output }) } Start-Sleep -Milliseconds 500 $run = [AssistantResource]::new($this.client, ("threads/{0}/runs" -f $this.id), $null ).get($this.last_run_id) } $message = [AssistantResource]::new($this.client, ("threads/{0}/messages?limit=1" -f $this.id), $null).list() | Select-Object id, role, content -First 1 return $message.content.text.value } return $null } } class Thread:AssistantResource { Thread([OpenAIClient]$client): base($client, "threads", "ThreadObject") {} [psobject[]]list() { return @{ error = "It is not implemented yet, you can't get all the thread information." } } [ThreadObject]create([string]$assistantId) { $result = $this.create() $result | Add-Member -MemberType NoteProperty -Name assistant_id -Value $assistantId return $result } } class Vector_storeObject:AssistantResourceObject { Vector_storeObject([psobject]$data):base($data) {} [string[]]file_ids() { return $this.client.web("vector_stores/$($this.id)/files").data | Select-Object -ExpandProperty id } } class Vector_store:AssistantResource { Vector_store([OpenAIClient]$client): base($client, "vector_stores", "Vector_storeObject") {} [psobject]create([hashtable]$body) { <# .SYNOPSIS Create a new vector store .DESCRIPTION Create a new vector store with the given name, file_ids, and days_to_expire. .PARAMETER body The body must contain 'name', 'file_ids', and 'days_to_expire' keys. #> # check if the body contains name, file_ids, and days_to_expire if ($body.name -and $body.file_ids -and $body.days_to_expire) { #replace the days_to_expire with expires_after $body.expires_after = @{ "days" = $body.days_to_expire "anchor" = "last_active_at" } $body.Remove("days_to_expire") return $this.client.web("$($this.urifragment)", "POST", $body) } throw "The body must contain 'name', 'file_ids', and 'days_to_expire' keys." } } |