AgentsClient.GetMessages Method

Reference

Definition

Namespace:: Azure.AI.Projects

Assembly:: Azure.AI.Projects.dll

Package:: Azure.AI.Projects v1.0.0-beta.1

Source:: AgentsClient.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 messages that exist on a thread.

public virtual Azure.Response<Azure.AI.Projects.PageableList<Azure.AI.Projects.ThreadMessage>> GetMessages (string threadId, string runId = default, int? limit = default, Azure.AI.Projects.ListSortOrder? order = default, string after = default, string before = default, System.Threading.CancellationToken cancellationToken = default);

abstract member GetMessages : string * string * Nullable<int> * Nullable<Azure.AI.Projects.ListSortOrder> * string * string * System.Threading.CancellationToken -> Azure.Response<Azure.AI.Projects.PageableList<Azure.AI.Projects.ThreadMessage>>
override this.GetMessages : string * string * Nullable<int> * Nullable<Azure.AI.Projects.ListSortOrder> * string * string * System.Threading.CancellationToken -> Azure.Response<Azure.AI.Projects.PageableList<Azure.AI.Projects.ThreadMessage>>

Public Overridable Function GetMessages (threadId As String, Optional runId As String = Nothing, 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 Response(Of PageableList(Of ThreadMessage))

Parameters

threadId: String

Identifier of the thread.

runId: String

Filter messages by the run ID that generated them.

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.