| external help file | PSOpenAI-help.xml |
|---|---|
| Module Name | PSOpenAI |
| online version | https://github.com/mkht/PSOpenAI/blob/main/Docs/Remove-ContainerFile.md |
| schema | 2.0.0 |
Delete Container File
Remove-ContainerFile
[-ContainerId] <String>
[-FileId] <String>
[-TimeoutSec <Int32>]
[-MaxRetryCount <Int32>]
[-ApiBase <Uri>]
[-ApiKey <SecureString>]
[-Organization <String>]
[<CommonParameters>]
Removes a file attached to a container.
PS C:\> Remove-ContainerFile -ContainerId 'cont_abc123' -FileId 'file-abc123'Remove the file with ID file-abc123 from the container with ID cont_abc123.
PS C:\> $File = Get-ContainerFile -ContainerId 'cont_abc123' -FileId 'file-abc123'
PS C:\> Remove-ContainerFile -ContainerFile $FileRemove the file using a ContainerFile object.
The ID of the container.
Type: String
Aliases: Container, container_id
Parameter Sets: Id
Required: True
Position: 0
Accept pipeline input: True (ByPropertyName, ByValue)The ID of the file to remove.
Type: String
Aliases: file_id
Parameter Sets: Id
Required: True
Position: 1
Accept pipeline input: True (ByPropertyName, ByValue)A ContainerFile object from Get-ContainerFile.
Type: PSCustomObject
Parameter Sets: ContainerFile
Required: True
Position: 0
Accept pipeline input: True (ByValue)Specifies 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 retried.
Type: Int32
Required: False
Position: Named
Default value: 0Specifies an API endpoint URL such as: 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 be [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 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: Namedhttps://developers.openai.com/api/reference/resources/containers/subresources/files/methods/delete/