-
Notifications
You must be signed in to change notification settings - Fork 28
Get OAIRunStep
Retrieves the run steps for a specific thread and run ID.
Get-OAIRunStep [-ThreadId] <Object> [-RunId] <Object> [[-Limit] <Object>] [[-Order] <Object>]
[[-After] <Object>] [[-Before] <Object>] [-ProgressAction <ActionPreference>] [<CommonParameters>]
The Get-OAIRunStep function retrieves the run steps for a specific thread and run ID. It allows you to specify optional parameters such as the number of steps to retrieve, the order in which the steps should be sorted, and filters based on timestamps.
Get-OAIRunStep -threadId 123 -runId 456
Retrieves the run steps for thread ID 123 and run ID 456.
Get-OAIRunStep -threadId 123 -runId 456 -limit 50 -order 'asc' -after '2022-01-01T00:00:00Z'
Retrieves the first 50 run steps in ascending order that occurred after January 1, 2022.
The ID of the thread for which to retrieve the run steps. This parameter is mandatory.
Type: Object
Parameter Sets: (All)
Aliases:
Required: True
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseThe ID of the run for which to retrieve the steps. This parameter is mandatory.
Type: Object
Parameter Sets: (All)
Aliases:
Required: True
Position: 2
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseThe maximum number of steps to retrieve. The default value is 20.
Type: Object
Parameter Sets: (All)
Aliases:
Required: False
Position: 3
Default value: 20
Accept pipeline input: False
Accept wildcard characters: FalseThe order in which the steps 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: 4
Default value: Desc
Accept pipeline input: False
Accept wildcard characters: FalseRetrieve steps that occurred after which is an object ID that defines your place in the list.
Type: Object
Parameter Sets: (All)
Aliases:
Required: False
Position: 5
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseRetrieve steps that occurred before which is an object ID that defines your place in the list.
Type: Object
Parameter Sets: (All)
Aliases:
Required: False
Position: 6
Default value: None
Accept pipeline input: False
Accept wildcard characters: False{{ Fill ProgressAction Description }}
Type: ActionPreference
Parameter Sets: (All)
Aliases: proga
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseThis cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.
https://platform.openai.com/docs/api-reference/runs/listRunSteps