AgentInsightMonitors.GetRuns Method

Definition

Namespace:

Azure.AI.Projects

Assembly:

Azure.AI.Projects.dll

Package:

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

Source:

AgentInsightMonitors.cs

List Agent Insights runs for a monitor.

public virtual System.ClientModel.CollectionResult<Azure.AI.Projects.AgentInsightRun> GetRuns(string monitorId, string after = default, string before = default, int? limit = default, Azure.AI.Projects.Memory.MemoryStoreListOrder? order = default, Azure.AI.Projects.ProjectsJobStatus? status = default, Azure.AI.Projects.AgentInsightRunTrigger? trigger = default, System.Threading.CancellationToken cancellationToken = default);

abstract member GetRuns : string * string * string * Nullable<int> * Nullable<Azure.AI.Projects.Memory.MemoryStoreListOrder> * Nullable<Azure.AI.Projects.ProjectsJobStatus> * Nullable<Azure.AI.Projects.AgentInsightRunTrigger> * System.Threading.CancellationToken -> System.ClientModel.CollectionResult<Azure.AI.Projects.AgentInsightRun>
override this.GetRuns : string * string * string * Nullable<int> * Nullable<Azure.AI.Projects.Memory.MemoryStoreListOrder> * Nullable<Azure.AI.Projects.ProjectsJobStatus> * Nullable<Azure.AI.Projects.AgentInsightRunTrigger> * System.Threading.CancellationToken -> System.ClientModel.CollectionResult<Azure.AI.Projects.AgentInsightRun>

Public Overridable Function GetRuns (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 status As Nullable(Of ProjectsJobStatus) = Nothing, Optional trigger As Nullable(Of AgentInsightRunTrigger) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As CollectionResult(Of AgentInsightRun)

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.

status

Nullable<ProjectsJobStatus>

Filter runs by status.

trigger

Nullable<AgentInsightRunTrigger>

Filter runs by trigger.

cancellationToken

CancellationToken

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

Returns

CollectionResult<AgentInsightRun>

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.