Get OAIRunItem

Get-OAIRunItem

SYNOPSIS

Retrieves information about a specific run item.

SYNTAX

Get-OAIRunItem [[-ThreadID] <Object>] [[-RunId] <Object>] [-ProgressAction <ActionPreference>]
 [<CommonParameters>]

DESCRIPTION

The Get-OAIRunItem function retrieves information about a specific run item based on the provided thread ID and run ID.

EXAMPLES

EXAMPLE 1

Get-OAIRunItem -threadId 123 -runId 456
Retrieves information about the run item with thread ID 123 and run ID 456.

PARAMETERS

-ThreadID

The ID of the thread associated with the run item. 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

-RunId

The ID of the run item to retrieve information for. This parameter is mandatory.

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

Required: False
Position: 2
Default value: None
Accept pipeline input: True (ByPropertyName)
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/getRun