| external help file | Module Name | online version | schema |
|---|---|---|---|
PSOpenAI-help.xml |
PSOpenAI |
2.0.0 |
Waits until the vector store file batch is completed.
Wait-VectorStoreFileBatch
[-VectorStoreId] <String>
[-BatchId] <String>
[-StatusForWait <String[]>]
[-StatusForExit <String[]>]
[-TimeoutSec <Int32>]
[-MaxRetryCount <Int32>]
[-PollIntervalSec <Float>]
[-ApiBase <Uri>]
[-ApiKey <SecureString>]
[-Organization <String>]
[<CommonParameters>]
Waits until the vector store file batch is completed.
PS C:\> Start-VectorStoreFileBatch -VectorStoreId 'vs_abc123' -FileId ('file-abc123', 'file-def456', 'file-ghi789') | Wait-VectorStoreFileBatchStart a batch and wait for completes.
The ID of the vector store that the file batch belongs to.
Type: String
Aliases: vector_store_id
Required: True
Position: 0
Accept pipeline input: True (ByValue, ByPropertyName)The ID of the batch to wait.
Type: String
Aliases: batch_id
Required: True
Position: 1
Accept pipeline input: True (ByPropertyName)By default, this cmdlet exits when the status of batch is anything other than in_progress.
If specifies one or more statuses for -StatusForExit, this cmdlet waits until batch reaches that status.
Type: String[]
Parameter Sets: StatusForExit
Accepted values: failed, in_progress, completed, cancelling, cancelled
Required: False
Position: NamedIf one or more statuses are specified in -StatusForWait, this cmdlet will exit when a batch changes to a status other than that.
Note: Do not specify completed for this parameter. cmdlet may not exit permanently.
Type: String[]
Parameter Sets: StatusForWait
Accepted values: failed, in_progress, completed, cancelling, cancelled
Required: False
Position: Named
Default value: in_progressSpecifies 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 the interval in seconds to poll the batch status.
The default value is 1.
Type: Float
Required: False
Position: Named
Default value: 1.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