AssistantsClient.GetMessageFile Method

Definition

Gets information about a file attachment to a message within a thread.

public virtual Azure.Response<Azure.AI.OpenAI.Assistants.MessageFile> GetMessageFile (string threadId, string messageId, string fileId, System.Threading.CancellationToken cancellationToken = default);
abstract member GetMessageFile : string * string * string * System.Threading.CancellationToken -> Azure.Response<Azure.AI.OpenAI.Assistants.MessageFile>
override this.GetMessageFile : string * string * string * System.Threading.CancellationToken -> Azure.Response<Azure.AI.OpenAI.Assistants.MessageFile>
Public Overridable Function GetMessageFile (threadId As String, messageId As String, fileId As String, Optional cancellationToken As CancellationToken = Nothing) As Response(Of MessageFile)

Parameters

threadId
String

The ID of the thread containing the message to get information from.

messageId
String

The ID of the message to get information from.

fileId
String

The ID of the file to get information about.

cancellationToken
CancellationToken

The cancellation token to use.

Returns

Exceptions

threadId, messageId or fileId is null.

threadId, messageId or fileId is an empty string, and was expected to be non-empty.

Applies to