AgentsClient.GetThread Method

Definition

Namespace:

Azure.AI.Projects

Assembly:

Azure.AI.Projects.dll

Package:

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

Overloads

GetThread(String, CancellationToken)	Gets information about an existing thread.
GetThread(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 GetThread(String, CancellationToken) convenience overload with strongly typed models first.

GetThread(String, CancellationToken)

Source:

AgentsClient.cs

Gets information about an existing thread.

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

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

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

Parameters

threadId

String

Identifier of the thread.

cancellationToken

CancellationToken

The cancellation token to use.

Returns

Response<AgentThread>

Exceptions

ArgumentNullException

threadId is null.

ArgumentException

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

GetThread(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 GetThread(String, CancellationToken) convenience overload with strongly typed models first.

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

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

Public Overridable Function GetThread (threadId As String, context As RequestContext) As 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

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.