| external help file | Module Name | online version | schema |
|---|---|---|---|
PSOpenAI-help.xml |
PSOpenAI |
2.0.0 |
Deletes a Message of the Thread.
Remove-ThreadMessage
-ThreadId <String>
[-MessageId] <String>
[-TimeoutSec <Int32>]
[-MaxRetryCount <Int32>]
[-ApiBase <Uri>]
[-ApiKey <SecureString>]
[-Organization <String>]
[-AdditionalQuery <IDictionary>]
[-AdditionalHeaders <IDictionary>]
[-AdditionalBody <Object>]
[<CommonParameters>]
Deletes a Message of the Thread.
PS C:\> Remove-ThreadMessage -ThreadId 'thread_abc123' -MessageId 'msg_abc123'The ID of the Thread.
Type: String
Aliases: thread_id
Required: True
Position: Named
Accept pipeline input: True (ByPropertyName, ByValue)The ID of the Message to delete.
Type: String
Aliases: message_id
Required: True
Position: 0
Accept pipeline input: True (ByPropertyName)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: 0Number between 0 and 100.
Specifies the maximum number of retries if the request fails.
The default value is 0 (No retry).
Note : Retries will only be performed if the request fails with a 429 (Rate limit reached) or 5xx (Server side errors) error. Other errors (e.g., authentication failure) will not be performed.
Type: Int32
Required: False
Position: Named
Default value: 0Specifies an API endpoint URL such like: 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/v1Specifies API key for authentication.
The type of data should [string] or [securestring].
If not specified, it will try to use $global:OPENAI_API_KEY or $env:OPENAI_API_KEY
Type: Object
Required: False
Position: NamedSpecifies Organization ID which used for an API request.
If not specified, it will try to use $global:OPENAI_ORGANIZATION or $env:OPENAI_ORGANIZATION
Type: string
Aliases: OrgId
Required: False
Position: Named