| external help file | Module Name | online version | schema |
|---|---|---|---|
PSOpenAI-help.xml |
PsopenAI |
2.0.0 |
Cancels an in-progress batch.
Stop-Batch
[-BatchId] <String>
[-Wait]
[-Force]
[-PassThru]
[-InputObject] <Object>
[-TimeoutSec <Int32>]
[-MaxRetryCount <Int32>]
[-ApiBase <Uri>]
[-ApiKey <SecureString>]
[-Organization <String>]
[<CommonParameters>]
Cancels an in-progress batch.
PS C:\> $Batch = Start-Batch -FileId 'file_abc123'
PS C:\> $Batch = $Batch | Stop-Batch -Force -PassThru
PS C:\> $Batch.status # cancellingCancels an in-progress batch.
PS C:\> $Batch = Start-Batch -FileId 'file_abc123'
PS C:\> $Batch = $Batch | Stop-Batch -Force -Wait -PassThru
PS C:\> $Batch.status # cancelledCancels an in-progress batch. Then the cmdlet waits until the batch has been cancelled.
The batch id to cancel.
Type: String
Aliases: Id, batch_id
Required: True
Position: 0
Accept pipeline input: True (ByValue, ByPropertyName)By default, This cmdlet does not wait completes cancellation.
When the switch specified, Waits for complete.
Type: SwitchParameter
Required: False
Position: NamedBy default, This cmdlet only requests cancel a batch that the status is 'validating', 'in_progress' or 'finalizing'.
When the switch specified, Always requests cancel any status of the batch.
Type: SwitchParameter
Required: False
Position: NamedBy default, This cmdlet returns nothing. When the PassThru switch specified, This cmdlet returns Batch object.
Type: SwitchParameter
Required: False
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
Parameter Sets: (All)
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