IOpenAIClient.ModifyThreadMessageAsync

IOpenAIClient.ModifyThreadMessageAsync method

Modifies an existing message within a thread asynchronously.

public Task<ThreadMessageResponse> ModifyThreadMessageAsync(string threadId, 
    string threadMessageId, ThreadMessageModifyRequest threadMessageModifyRequest, 
    CancellationToken? cancellationToken = default)
ParameterTypeDescription
threadIdStringThe ID of the thread containing the message to modify.
threadMessageIdStringThe ID of the message to modify.
threadMessageModifyRequestThreadMessageModifyRequestThe request details for modifying the message.
cancellationTokenNullable`1A token to cancel the operation.

Return Value

A task that represents the asynchronous operation. The task result contains the response from the message modification.

Exceptions

exceptioncondition
AIClientExceptionThrown when the thread Id is null or empty.
AIClientExceptionThrown when the thread message Id is null or empty.

See Also