AssistantsClient.GetMessageFile Method

Reference

Definition

Namespace:: Azure.AI.OpenAI.Assistants

Assembly:: Azure.AI.OpenAI.Assistants.dll

Package:: Azure.AI.OpenAI.Assistants v1.0.0-beta.4

Source:: AssistantsClient.cs

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

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

Response<MessageFile>

Exceptions

ArgumentNullException

threadId, messageId or fileId is null.

ArgumentException

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

Applies to

Share via