AgentsClient.GetThreadAsync Method

Definition

Namespace:

Azure.AI.Projects

Assembly:

Azure.AI.Projects.dll

Package:

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

Overloads

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

GetThreadAsync(String, RequestContext)

Source:

AgentsClient.cs

[Protocol Method] Gets information about an existing thread.

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

public virtual System.Threading.Tasks.Task<Azure.Response> GetThreadAsync (string threadId, Azure.RequestContext context);

abstract member GetThreadAsync : string * Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Response>
override this.GetThreadAsync : string * Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Response>

Public Overridable Function GetThreadAsync (threadId As String, context As RequestContext) As Task(Of Response)

Parameters

threadId

String

Identifier of the thread.

context

RequestContext

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

Returns

Task<Response>

The response returned from the service.

Exceptions

ArgumentNullException

threadId is null.

ArgumentException

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

RequestFailedException

Service returned a non-success status code.

GetThreadAsync(String, CancellationToken)

Source:

AgentsClient.cs

Gets information about an existing thread.

public virtual System.Threading.Tasks.Task<Azure.Response<Azure.AI.Projects.AgentThread>> GetThreadAsync (string threadId, System.Threading.CancellationToken cancellationToken = default);

abstract member GetThreadAsync : string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.AI.Projects.AgentThread>>
override this.GetThreadAsync : string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.AI.Projects.AgentThread>>

Public Overridable Function GetThreadAsync (threadId As String, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response(Of AgentThread))

Parameters

threadId

String

Identifier of the thread.

cancellationToken

CancellationToken

The cancellation token to use.

Returns

Task<Response<AgentThread>>

Exceptions

ArgumentNullException

threadId is null.

ArgumentException

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