AgentsClient.GetAgentAsync Method

Definition

Namespace:

Azure.AI.Projects

Assembly:

Azure.AI.Projects.dll

Package:

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

Overloads

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

GetAgentAsync(String, RequestContext)

Source:

AgentsClient.cs

[Protocol Method] Retrieves an existing agent.

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

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

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

Public Overridable Function GetAgentAsync (assistantId As String, context As RequestContext) As Task(Of Response)

Parameters

assistantId

String

Identifier of the agent.

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

assistantId is null.

ArgumentException

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

RequestFailedException

Service returned a non-success status code.

GetAgentAsync(String, CancellationToken)

Source:

AgentsClient.cs

Retrieves an existing agent.

public virtual System.Threading.Tasks.Task<Azure.Response<Azure.AI.Projects.Agent>> GetAgentAsync (string assistantId, System.Threading.CancellationToken cancellationToken = default);

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

Public Overridable Function GetAgentAsync (assistantId As String, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response(Of Agent))

Parameters

assistantId

String

Identifier of the agent.

cancellationToken

CancellationToken

The cancellation token to use.

Returns

Task<Response<Agent>>

Exceptions

ArgumentNullException

assistantId is null.

ArgumentException

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