AgentInsightMonitors.GetInsights Method

Definition

Namespace:

Azure.AI.Projects

Assembly:

Azure.AI.Projects.dll

Package:

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

Source:

AgentInsightMonitors.cs

List current insights for an Agent Insights monitor.

public virtual System.ClientModel.CollectionResult<Azure.AI.Projects.AgentInsight> GetInsights(string monitorId, string after = default, string before = default, int? limit = default, Azure.AI.Projects.Memory.MemoryStoreListOrder? order = default, string category = default, Azure.AI.Projects.AgentInsightSeverity? severity = default, Azure.AI.Projects.AgentInsightStatus? status = default, bool? includeDetails = default, System.Threading.CancellationToken cancellationToken = default);

abstract member GetInsights : string * string * string * Nullable<int> * Nullable<Azure.AI.Projects.Memory.MemoryStoreListOrder> * string * Nullable<Azure.AI.Projects.AgentInsightSeverity> * Nullable<Azure.AI.Projects.AgentInsightStatus> * Nullable<bool> * System.Threading.CancellationToken -> System.ClientModel.CollectionResult<Azure.AI.Projects.AgentInsight>
override this.GetInsights : string * string * string * Nullable<int> * Nullable<Azure.AI.Projects.Memory.MemoryStoreListOrder> * string * Nullable<Azure.AI.Projects.AgentInsightSeverity> * Nullable<Azure.AI.Projects.AgentInsightStatus> * Nullable<bool> * System.Threading.CancellationToken -> System.ClientModel.CollectionResult<Azure.AI.Projects.AgentInsight>

Public Overridable Function GetInsights (monitorId As String, Optional after As String = Nothing, Optional before As String = Nothing, Optional limit As Nullable(Of Integer) = Nothing, Optional order As Nullable(Of MemoryStoreListOrder) = Nothing, Optional category As String = Nothing, Optional severity As Nullable(Of AgentInsightSeverity) = Nothing, Optional status As Nullable(Of AgentInsightStatus) = Nothing, Optional includeDetails As Nullable(Of Boolean) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As CollectionResult(Of AgentInsight)

Parameters

monitorId

String

The identifier of the monitor.

after

String

A cursor that identifies the last item in the previous page.

before

String

A cursor that identifies the first item in the next page.

limit

Nullable<Int32>

The maximum number of items to return. Defaults to 20.

order

Nullable<MemoryStoreListOrder>

Sort order by creation time. Defaults to descending.

category

String

Filter insights by category.

severity

Nullable<AgentInsightSeverity>

Filter insights by severity.

status

Nullable<AgentInsightStatus>

Filter insights by lifecycle status.

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

CollectionResult<AgentInsight>

Exceptions

ArgumentNullException

monitorId is null.

ArgumentException

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

ClientResultException

Service returned a non-success status code.