Wait-ThreadRun.md

external help file	Module Name	online version	schema
PSOpenAI-help.xml	PSOpenAI	https://github.com/mkht/PSOpenAI/blob/main/Docs/Wait-ThreadRun.md	2.0.0

Wait-ThreadRun

SYNOPSIS

Waits until the run is completed.

SYNTAX

Wait-ThreadRun
    [-RunId] <String>
    [-ThreadId] <String>
    [-StatusForWait <String[]>]
    [-StatusForExit <String[]>]
    [-TimeoutSec <Int32>]
    [-MaxRetryCount <Int32>]
    [-PollIntervalSec <Float>]
    [-ApiBase <Uri>]
    [-ApiKey <SecureString>]
    [-Organization <String>]
    [<CommonParameters>]

DESCRIPTION

Waits until the run is completed.

EXAMPLES

Example 1

PS C:\> $Thread | Start-ThreadRun | Wait-ThreadRun

Start a run and wait for completes.

Example 1

PS C:\> $Run | Stop-ThreadRun | Wait-ThreadRun -StatusForExit 'cancelled'

Requests a run cancellation and wait for cancelled.

PARAMETERS

-RunId

The ID of thre run to wait.

Type: String
Aliases: run_id
Required: True
Position: 0
Accept pipeline input: True (ByValue, ByPropertyName)

-ThreadId

The ID of the thread to which this run belongs.

Type: String
Aliases: thread_id
Required: True
Position: 0
Accept pipeline input: True (ByPropertyName)

-StatusForExit

By default, this cmdlet exits when the status of Run is anything other than queued or in_progress.
If specifies one or more statuses for -StatusForExit, this cmdlet waits until Run reaches that status.

Type: String[]
Accepted values: queued, in_progress, completed, requires_action, expired, cancelling, cancelled, failed, incomplete
Required: False
Position: Named

-StatusForWait

If one or more statuses are specified in -StatusForWait, this cmdlet will exit when Run changes to a status other than that.
Note: Do not specify completed for this parameter. cmdlet may not exit permanently.

Type: String[]
Accepted values: queued, in_progress, completed, requires_action, expired, cancelling, cancelled, failed, incomplete
Required: False
Position: Named
Default value: queued, in_progress

-TimeoutSec

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: 0

-MaxRetryCount

Number 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: 0

-PollIntervalSec

Specifies the interval in seconds to poll the status of the run. The default value is 1.

Type: Float
Required: False
Position: Named
Default value: 1

-ApiBase

Specifies 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/v1

-ApiKey

Specifies 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: Named

-Organization

Specifies 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

INPUTS

OUTPUTS

PSCustomObject

NOTES

RELATED LINKS