AgentsClient.GetMessage Method

Definition

Namespace:

Azure.AI.Projects

Assembly:

Azure.AI.Projects.dll

Package:

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

Overloads

GetMessage(String, String, CancellationToken)	Gets an existing message from an existing thread.
GetMessage(String, String, RequestContext)	[Protocol Method] Gets an existing message from an existing thread. This protocol method allows explicit creation of the request and processing of the response for advanced scenarios. Please try the simpler GetMessage(String, String, CancellationToken) convenience overload with strongly typed models first.

GetMessage(String, String, CancellationToken)

Source:

AgentsClient.cs

Gets an existing message from an existing thread.

public virtual Azure.Response<Azure.AI.Projects.ThreadMessage> GetMessage (string threadId, string messageId, System.Threading.CancellationToken cancellationToken = default);

abstract member GetMessage : string * string * System.Threading.CancellationToken -> Azure.Response<Azure.AI.Projects.ThreadMessage>
override this.GetMessage : string * string * System.Threading.CancellationToken -> Azure.Response<Azure.AI.Projects.ThreadMessage>

Public Overridable Function GetMessage (threadId As String, messageId As String, Optional cancellationToken As CancellationToken = Nothing) As Response(Of ThreadMessage)

Parameters

threadId

String

Identifier of the thread.

messageId

String

Identifier of the message.

cancellationToken

CancellationToken

The cancellation token to use.

Returns

Response<ThreadMessage>

Exceptions

ArgumentNullException

threadId or messageId is null.

ArgumentException

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

GetMessage(String, String, RequestContext)

Source:

AgentsClient.cs

[Protocol Method] Gets an existing message from an existing thread.

• This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
• Please try the simpler GetMessage(String, String, CancellationToken) convenience overload with strongly typed models first.

public virtual Azure.Response GetMessage (string threadId, string messageId, Azure.RequestContext context);

abstract member GetMessage : string * string * Azure.RequestContext -> Azure.Response
override this.GetMessage : string * string * Azure.RequestContext -> Azure.Response

Public Overridable Function GetMessage (threadId As String, messageId As String, context As RequestContext) As Response

Parameters

threadId

String

Identifier of the thread.

messageId

String

Identifier of the message.

context

RequestContext

The request context, which can override default behaviors of the client pipeline on a per-call basis.

Returns

Response

The response returned from the service.

Exceptions

ArgumentNullException

threadId or messageId is null.

ArgumentException

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

RequestFailedException

Service returned a non-success status code.