| external help file | Module Name | online version | schema |
|---|---|---|---|
PSOpenAI-help.xml |
PSOpenAI |
2.0.0 |
Upload a file that can be used across various endpoints.
Add-OpenAIFile
[-File] <String>
-Purpose <String>
[-TimeoutSec <Int32>]
[-MaxRetryCount <Int32>]
[-ApiBase <Uri>]
[-ApiKey <SecureString>]
[-Organization <String>]
[<CommonParameters>]
Add-OpenAIFile
[-Content] <byte[]>
-Name <String>
-Purpose <String>
[-TimeoutSec <Int32>]
[-MaxRetryCount <Int32>]
[-ApiBase <Uri>]
[-ApiKey <SecureString>]
[-Organization <String>]
[<CommonParameters>]
Upload a file that can be used across various endpoints.
PS C:\> Add-OpenAIFile -File "C:\sample.csv" -Purpose assistantsUpload sample.csv file to OpenAI.
PS C:\> $ByteArray = [System.Text.Encoding]::UTF8.GetBytes('some text data')
PS C:\> Add-OpenAIFile -Content $ByteArray -Name 'filename.txt' -Purpose assistantsUpload a content of bytes to OpenAI
The File path to be uploaded.
Type: String
Parameter Sets: File
Required: True
Position: 0
Accept pipeline input: True (ByValue)Byte array to be uploaded.
Type: byte[]
Parameter Sets: Content
Required: True
Position: 0The File name to be uploaded.
Type: String
Parameter Sets: Content
Required: True
Position: NamedThe intended purpose of the uploaded file.
You can specify fine-tune, assistants or batch.
Type: String
Required: True
Position: NamedSpecifies how long the request can be pending before it times out.
The default value is 0 (infinite).
Type: Int32
Required: False
Position: Named
Default value: 0Number between 0 and 100.
Specifies the maximum number of retries if the request fails.
The default value is 0 (No retry).
Note : Retries will only be performed if the request fails with a 429 (Rate limit reached) or 5xx (Server side errors) error. Other errors (e.g., authentication failure) will not be performed.
Type: Int32
Required: False
Position: Named
Default value: 0Specifies an API endpoint URL such like: https://your-api-endpoint.test/v1
If not specified, it will use https://api.openai.com/v1
Type: System.Uri
Required: False
Position: Named
Default value: https://api.openai.com/v1Specifies API key for authentication.
The type of data should [string] or [securestring].
If not specified, it will try to use $global:OPENAI_API_KEY or $env:OPENAI_API_KEY
Type: Object
Required: False
Position: NamedSpecifies Organization ID which used for an API request.
If not specified, it will try to use $global:OPENAI_ORGANIZATION or $env:OPENAI_ORGANIZATION
Type: string
Aliases: OrgId
Required: False
Position: Named