Remove-Conversation.md

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

Remove-Conversation

SYNOPSIS

Delete a conversation with the given ID.

SYNTAX

Remove-Conversation
    -ConversationId <String>
    [-TimeoutSec <Int32>]
    [-MaxRetryCount <Int32>]
    [-ApiBase <Uri>]
    [-ApiKey <SecureString>]
    [<CommonParameters>]

DESCRIPTION

Delete a conversation with the given ID.

EXAMPLES

Example 1

PS C:\> Remove-Conversation -ConversationId "conv_abc123"

Deletes the conversation with the ID conv_abc123.

PARAMETERS

-ConversationId

The ID of the conversation to delete.

Type: String
Required: True
Position: 0
Aliases: Conversation, conversation_id

-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).

Type: Int32
Required: False
Position: Named
Default value: 0

-ApiBase

Specifies an API endpoint URL such as: 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 be [string] or [securestring].
If not specified, it will try to use $global:OPENAI_API_KEY or $env:OPENAI_API_KEY.

Type: SecureString
Required: False
Position: Named

INPUTS

OUTPUTS

None

NOTES

RELATED LINKS

https://developers.openai.com/api/reference/resources/conversations/methods/delete/