BetaAgentInsightMonitorsOperations interface

Package:

@azure/ai-projects

Interface representing a BetaAgentInsightMonitors operations.

Properties

cancelRun	Cancel an Agent Insights run.
create	Create an Agent Insights monitor for an agent.
createRun	Start an Agent Insights run for a monitor. The poller exposes the created run id.
deleteAgentInsightMonitor	Delete an Agent Insights monitor and all of its runs, insights, and state.
get	Get an Agent Insights monitor.
getInsight	Get a full insight for an Agent Insights monitor.
getRun	Get an Agent Insights run.
list	List Agent Insights monitors, optionally filtered by agent name.
listInsights	List current insights for an Agent Insights monitor.
listRuns	List Agent Insights runs for a monitor.
reset	Reset an Agent Insights monitor's overview, checkpoint, and active insight state.
update	Update an Agent Insights monitor.
updateInsight	Update the lifecycle status of an insight.

Property Details

cancelRun

Cancel an Agent Insights run.

cancelRun: (monitorId: string, runId: string, options?: BetaAgentInsightMonitorsCancelRunOptionalParams) => Promise<AgentInsightRun>

Property Value

(monitorId: string, runId: string, options?: BetaAgentInsightMonitorsCancelRunOptionalParams) => Promise<AgentInsightRun>

create

Create an Agent Insights monitor for an agent.

create: (monitor: AgentInsightMonitorCreate, options?: BetaAgentInsightMonitorsCreateOptionalParams) => Promise<AgentInsightMonitor>

Property Value

(monitor: AgentInsightMonitorCreate, options?: BetaAgentInsightMonitorsCreateOptionalParams) => Promise<AgentInsightMonitor>

createRun

Start an Agent Insights run for a monitor. The poller exposes the created run id.

createRun: (monitorId: string, run: AgentInsightRunCreate, options?: BetaAgentInsightMonitorsCreateRunOptionalParams) => RunPoller<AgentInsightRunResult>

Property Value

(monitorId: string, run: AgentInsightRunCreate, options?: BetaAgentInsightMonitorsCreateRunOptionalParams) => RunPoller<AgentInsightRunResult>

deleteAgentInsightMonitor

Delete an Agent Insights monitor and all of its runs, insights, and state.

deleteAgentInsightMonitor: (monitorId: string, options?: BetaAgentInsightMonitorsDeleteOptionalParams) => Promise<void>

Property Value

(monitorId: string, options?: BetaAgentInsightMonitorsDeleteOptionalParams) => Promise<void>

get

Get an Agent Insights monitor.

get: (monitorId: string, options?: BetaAgentInsightMonitorsGetOptionalParams) => Promise<AgentInsightMonitor>

Property Value

(monitorId: string, options?: BetaAgentInsightMonitorsGetOptionalParams) => Promise<AgentInsightMonitor>

getInsight

Get a full insight for an Agent Insights monitor.

getInsight: (monitorId: string, insightId: string, options?: BetaAgentInsightMonitorsGetInsightOptionalParams) => Promise<AgentInsight>

Property Value

(monitorId: string, insightId: string, options?: BetaAgentInsightMonitorsGetInsightOptionalParams) => Promise<AgentInsight>

getRun

Get an Agent Insights run.

getRun: (monitorId: string, runId: string, options?: BetaAgentInsightMonitorsGetRunOptionalParams) => Promise<AgentInsightRun>

Property Value

(monitorId: string, runId: string, options?: BetaAgentInsightMonitorsGetRunOptionalParams) => Promise<AgentInsightRun>

list

List Agent Insights monitors, optionally filtered by agent name.

list: (options?: BetaAgentInsightMonitorsListOptionalParams) => PagedAsyncIterableIterator<AgentInsightMonitorListItem, AgentInsightMonitorListItem[], PageSettings>

Property Value

(options?: BetaAgentInsightMonitorsListOptionalParams) => PagedAsyncIterableIterator<AgentInsightMonitorListItem, AgentInsightMonitorListItem[], PageSettings>

listInsights

List current insights for an Agent Insights monitor.

listInsights: (monitorId: string, options?: BetaAgentInsightMonitorsListInsightsOptionalParams) => PagedAsyncIterableIterator<AgentInsight, AgentInsight[], PageSettings>

Property Value

(monitorId: string, options?: BetaAgentInsightMonitorsListInsightsOptionalParams) => PagedAsyncIterableIterator<AgentInsight, AgentInsight[], PageSettings>

listRuns

List Agent Insights runs for a monitor.

listRuns: (monitorId: string, options?: BetaAgentInsightMonitorsListRunsOptionalParams) => PagedAsyncIterableIterator<AgentInsightRun, AgentInsightRun[], PageSettings>

Property Value

(monitorId: string, options?: BetaAgentInsightMonitorsListRunsOptionalParams) => PagedAsyncIterableIterator<AgentInsightRun, AgentInsightRun[], PageSettings>

reset

Reset an Agent Insights monitor's overview, checkpoint, and active insight state.

reset: (monitorId: string, options?: BetaAgentInsightMonitorsResetOptionalParams) => Promise<void>

Property Value

(monitorId: string, options?: BetaAgentInsightMonitorsResetOptionalParams) => Promise<void>

update

Update an Agent Insights monitor.

update: (monitorId: string, monitor: AgentInsightMonitorUpdate, options?: BetaAgentInsightMonitorsUpdateOptionalParams) => Promise<AgentInsightMonitor>

Property Value

(monitorId: string, monitor: AgentInsightMonitorUpdate, options?: BetaAgentInsightMonitorsUpdateOptionalParams) => Promise<AgentInsightMonitor>

updateInsight

Update the lifecycle status of an insight.

updateInsight: (monitorId: string, insightId: string, update: AgentInsightUpdate, options?: BetaAgentInsightMonitorsUpdateInsightOptionalParams) => Promise<AgentInsight>

Property Value

(monitorId: string, insightId: string, update: AgentInsightUpdate, options?: BetaAgentInsightMonitorsUpdateInsightOptionalParams) => Promise<AgentInsight>