Skip to content

Get OAIRun

dfinke edited this page Apr 20, 2024 · 2 revisions

Get-OAIRun

SYNOPSIS

Retrieves the runs associated with a specific thread ID.

SYNTAX

Get-OAIRun [[-threadId] <Object>] [[-limit] <Object>] [[-order] <Object>] [[-after] <Object>]
 [[-before] <Object>] [-ProgressAction <ActionPreference>] [<CommonParameters>]

DESCRIPTION

The Get-OAIRun function retrieves the runs associated with a specific thread ID from a specified base URL. It allows you to specify various parameters such as the number of runs to retrieve, the order in which they should be sorted, and the time range for the runs.

EXAMPLES

EXAMPLE 1

Get-OAIRun -threadId 12345 -limit 10 -order 'asc' -after '2022-01-01T00:00:00Z'
Retrieves the 10 oldest runs associated with thread ID 12345, sorted in ascending order, and after the specified timestamp.

PARAMETERS

-threadId

Specifies the ID of the thread for which to retrieve the runs. This parameter is mandatory.

Type: Object
Parameter Sets: (All)
Aliases: thread_id

Required: False
Position: 1
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-limit

Specifies the maximum number of runs to retrieve. The default value is 20.

Type: Object
Parameter Sets: (All)
Aliases:

Required: False
Position: 2
Default value: 20
Accept pipeline input: False
Accept wildcard characters: False

-order

Specifies the order in which the runs should be sorted. Valid values are 'asc' (ascending) and 'desc' (descending). The default value is 'desc'.

Type: Object
Parameter Sets: (All)
Aliases:

Required: False
Position: 3
Default value: Desc
Accept pipeline input: False
Accept wildcard characters: False

-after

Specifies the timestamp after which the runs should be retrieved.

Type: Object
Parameter Sets: (All)
Aliases:

Required: False
Position: 4
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-before

Specifies the timestamp before which the runs should be retrieved.

Type: Object
Parameter Sets: (All)
Aliases:

Required: False
Position: 5
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-ProgressAction

{{ Fill ProgressAction Description }}

Type: ActionPreference
Parameter Sets: (All)
Aliases: proga

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

INPUTS

OUTPUTS

NOTES

RELATED LINKS

https://platform.openai.com/docs/api-reference/runs/listRuns

Clone this wiki locally