AgentsClient.GetAgent Method

Definition

Namespace:

Azure.AI.Projects

Assembly:

Azure.AI.Projects.dll

Package:

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

Overloads

GetAgent(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 GetAgent(String, CancellationToken) convenience overload with strongly typed models first.
GetAgent(String, CancellationToken)	Retrieves an existing agent.

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

public virtual Azure.Response GetAgent (string assistantId, Azure.RequestContext context);

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

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

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.

GetAgent(String, CancellationToken)

Source:

AgentsClient.cs

Retrieves an existing agent.

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

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

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

Parameters

assistantId

String

Identifier of the agent.

cancellationToken

CancellationToken

The cancellation token to use.

Returns

Response<Agent>

Exceptions

ArgumentNullException

assistantId is null.

ArgumentException

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