AssistantsClient.GetMessageFilesAsync 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 a list of previously uploaded files associated with a message from a thread.

public virtual System.Threading.Tasks.Task<Azure.Response<Azure.AI.OpenAI.Assistants.PageableList<Azure.AI.OpenAI.Assistants.MessageFile>>> GetMessageFilesAsync (string threadId, string messageId, int? limit = default, Azure.AI.OpenAI.Assistants.ListSortOrder? order = default, string after = default, string before = default, System.Threading.CancellationToken cancellationToken = default);

abstract member GetMessageFilesAsync : string * string * Nullable<int> * Nullable<Azure.AI.OpenAI.Assistants.ListSortOrder> * string * string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.AI.OpenAI.Assistants.PageableList<Azure.AI.OpenAI.Assistants.MessageFile>>>
override this.GetMessageFilesAsync : string * string * Nullable<int> * Nullable<Azure.AI.OpenAI.Assistants.ListSortOrder> * string * string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.AI.OpenAI.Assistants.PageableList<Azure.AI.OpenAI.Assistants.MessageFile>>>

Public Overridable Function GetMessageFilesAsync (threadId As String, messageId As String, Optional limit As Nullable(Of Integer) = Nothing, Optional order As Nullable(Of ListSortOrder) = Nothing, Optional after As String = Nothing, Optional before As String = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response(Of PageableList(Of MessageFile)))

Parameters

threadId: String

The ID of the thread containing the message to list files from.

messageId: String

The ID of the message to list files from.

limit: Nullable<Int32>

A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20.

order: Nullable<ListSortOrder>

Sort order by the created_at timestamp of the objects. asc for ascending order and desc for descending order.

after: String

A cursor for use in pagination. after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include after=obj_foo in order to fetch the next page of the list.

before: String

A cursor for use in pagination. before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include before=obj_foo in order to fetch the previous page of the list.

cancellationToken: CancellationToken

The cancellation token to use.

Returns

Task<Response<PageableList<MessageFile>>>

Exceptions

ArgumentNullException

threadId or messageId is null.

ArgumentException

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

Applies to

Share via