Interface IMessageService

Namespace

OpenAI.Interfaces

Assembly

AntRunnerLib.dll

public interface IMessageService

Methods

CreateMessage(String, MessageCreateRequest, CancellationToken)

Create a message.

Task<MessageResponse> CreateMessage(string threadId, MessageCreateRequest request, CancellationToken cancellationToken = null)

Parameters

threadId System.String

request MessageCreateRequest

cancellationToken CancellationToken

Returns

Task<MessageResponse>

DeleteMessage(String, String, CancellationToken)

Deletes a message.

Task<DeletionStatusResponse> DeleteMessage(string threadId, string messageId, CancellationToken cancellationToken = null)

Parameters

threadId System.String

The ID of the thread to which this message belongs.

messageId System.String

The ID of the message to delete.

cancellationToken CancellationToken

Returns

Task<DeletionStatusResponse>

ListMessages(String, PaginationRequest, CancellationToken)

Returns a list of messages for a given thread.

Task<MessageListResponse> ListMessages(string threadId, PaginationRequest request = null, CancellationToken cancellationToken = null)

Parameters

threadId System.String

request PaginationRequest

cancellationToken CancellationToken

Returns

Task<MessageListResponse>

ModifyMessage(String, String, ModifyMessageRequest, CancellationToken)

Modifies a message.

Task<MessageResponse> ModifyMessage(string threadId, string messageId, ModifyMessageRequest requestBody, CancellationToken cancellationToken = null)

Parameters

threadId System.String

messageId System.String

requestBody ModifyMessageRequest

cancellationToken CancellationToken

Returns

Task<MessageResponse>

RetrieveMessage(String, String, CancellationToken)

Retrieve a message.

Task<MessageResponse> RetrieveMessage(string threadId, string messageId, CancellationToken cancellationToken = null)

Parameters

threadId System.String

messageId System.String

cancellationToken CancellationToken

Returns

Task<MessageResponse>