AgentInsightMonitors.GetInsight Method

Definition

Namespace:

Azure.AI.Projects

Assembly:

Azure.AI.Projects.dll

Package:

Azure.AI.Projects v3.0.0-beta.2

Overloads

Name	Description
GetInsight(String, String, Nullable<Boolean>, RequestOptions)	[Protocol Method] Get a full insight for an Agent Insights monitor. This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
GetInsight(String, String, Nullable<Boolean>, CancellationToken)	Get a full insight for an Agent Insights monitor.

GetInsight(String, String, Nullable<Boolean>, RequestOptions)

Source:

AgentInsightMonitors.cs

[Protocol Method] Get a full insight for an Agent Insights monitor.

• This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.

public virtual System.ClientModel.ClientResult GetInsight(string monitorId, string insightId, bool? includeDetails, System.ClientModel.Primitives.RequestOptions options);

abstract member GetInsight : string * string * Nullable<bool> * System.ClientModel.Primitives.RequestOptions -> System.ClientModel.ClientResult
override this.GetInsight : string * string * Nullable<bool> * System.ClientModel.Primitives.RequestOptions -> System.ClientModel.ClientResult

Public Overridable Function GetInsight (monitorId As String, insightId As String, includeDetails As Nullable(Of Boolean), options As RequestOptions) As ClientResult

Parameters

monitorId

String

The identifier of the monitor.

insightId

String

The identifier of the insight.

includeDetails

Nullable<Boolean>

Whether to include expanded insight details such as evidence and run links in the response. Defaults to false.

options

RequestOptions

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

Returns

ClientResult

The response returned from the service.

Exceptions

ArgumentNullException

monitorId or insightId is null.

ArgumentException

monitorId or insightId is an empty string, and was expected to be non-empty.

ClientResultException

Service returned a non-success status code.

GetInsight(String, String, Nullable<Boolean>, CancellationToken)

Source:

AgentInsightMonitors.cs

Get a full insight for an Agent Insights monitor.

public virtual System.ClientModel.ClientResult<Azure.AI.Projects.AgentInsight> GetInsight(string monitorId, string insightId, bool? includeDetails = default, System.Threading.CancellationToken cancellationToken = default);

abstract member GetInsight : string * string * Nullable<bool> * System.Threading.CancellationToken -> System.ClientModel.ClientResult<Azure.AI.Projects.AgentInsight>
override this.GetInsight : string * string * Nullable<bool> * System.Threading.CancellationToken -> System.ClientModel.ClientResult<Azure.AI.Projects.AgentInsight>

Public Overridable Function GetInsight (monitorId As String, insightId As String, Optional includeDetails As Nullable(Of Boolean) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As ClientResult(Of AgentInsight)

Parameters

monitorId

String

The identifier of the monitor.

insightId

String

The identifier of the insight.

includeDetails

Nullable<Boolean>

Whether to include expanded insight details such as evidence and run links in the response. Defaults to false.

cancellationToken

CancellationToken

The cancellation token that can be used to cancel the operation.

Returns

ClientResult<AgentInsight>

Exceptions

ArgumentNullException

monitorId or insightId is null.

ArgumentException

monitorId or insightId is an empty string, and was expected to be non-empty.

ClientResultException

Service returned a non-success status code.