Skip to content

Remove OAIThread

dfinke edited this page Apr 20, 2024 · 2 revisions

Remove-OAIThread

SYNOPSIS

Removes a thread from the OpenAI API.

SYNTAX

Remove-OAIThread [[-threadId] <Object>] [-ProgressAction <ActionPreference>] [<CommonParameters>]

DESCRIPTION

The Remove-OAIThread function removes a thread from the OpenAI API by sending a DELETE request to the specified thread ID.

EXAMPLES

EXAMPLE 1

Remove-OAIThread -threadId "123456789"

This example removes the thread with the ID "123456789" from the OpenAI API.

PARAMETERS

-threadId

The ID of the thread to be removed.

Type: Object
Parameter Sets: (All)
Aliases:

Required: False
Position: 1
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/threads/deleteThread

Clone this wiki locally