AgentInsightMonitor Class

A per-agent Agent Insights monitor that owns configuration, runs, and discovered insights.

Constructor

AgentInsightMonitor(*args: Any, **kwargs: Any)

Variables

Name	Description
id	str The monitor identifier. Required.
agent_name	str The agent this monitor analyzes. There can be only one monitor per agent. Required.
enabled	bool Whether scheduled insight generation is armed for the monitor. Required.
run_interval_hours	float Interval between scheduled insight runs, in hours. Required.
model_deployment_name	str The model deployment to use for analyzing traces. Accepts either the deployment name alone or with the connection name as '{connectionName}/modelDeploymentName'. Required.
next_scheduled_run_at	datetime The next time a scheduled agent insight run will start. Omitted when scheduled generation is disabled.
estimated_cost	AgentInsightEstimatedCost Estimated cost accumulated by Agent Insights for this monitor.
suspension	AgentInsightSuspension Why the system suspended scheduled generation. Null when the monitor is not suspended. Required.
overview	AgentInsightsOverview The effective overview, or null before an overview is available. Required.
updated_at	datetime The time when this monitor was last updated. Required.

Methods

as_dict	Return a dict that can be turned into json using json.dump.
clear	Remove all items from the dictionary.
copy
get	Get the value for key if key is in the dictionary, else default. :param str key: The key to look up. :param any default: The value to return if key is not in the dictionary. Defaults to None :returns: The value for key if key is in the dictionary, else default. :rtype: any
items
keys
pop	Removes specified key and return the corresponding value. :param str key: The key to pop. :param any default: The value to return if key is not in the dictionary :returns: The value corresponding to the key. :rtype: any :raises KeyError: If key is not found and default is not given.
popitem	Removes and returns some (key, value) pair :returns: The (key, value) pair. :rtype: tuple :raises KeyError: if the dictionary is empty.
setdefault	Return the value for key if key is in the dictionary; otherwise set the key to default and return default. :param str key: The key to look up. :param any default: The value to set if key is not in the dictionary :returns: The value for key if key is in the dictionary, else default. :rtype: any
update	Update the dictionary from a mapping or an iterable of key-value pairs. :param any args: Either a mapping object or an iterable of key-value pairs.
values

as_dict

Return a dict that can be turned into json using json.dump.

as_dict(*, exclude_readonly: bool = False) -> dict[str, Any]

Keyword-Only Parameters

Name	Description
exclude_readonly	bool Whether to remove the readonly properties. Default value: False

Returns

Type	Description
dict	A dict JSON compatible object

clear

Remove all items from the dictionary.

clear() -> None

copy

copy() -> Model

get

Get the value for key if key is in the dictionary, else default. :param str key: The key to look up. :param any default: The value to return if key is not in the dictionary. Defaults to None :returns: The value for key if key is in the dictionary, else default. :rtype: any

get(key: str, default: Any = None) -> Any

Parameters

Name	Description
key Required
default	Default value: None

items

items() -> ItemsView[str, Any]

Returns

Type	Description
ItemsView	a set-like object providing a view on the mapping's items

keys

keys() -> KeysView[str]

Returns

Type	Description
KeysView	a set-like object providing a view on the mapping's keys

pop

Removes specified key and return the corresponding value. :param str key: The key to pop. :param any default: The value to return if key is not in the dictionary :returns: The value corresponding to the key. :rtype: any :raises KeyError: If key is not found and default is not given.

pop(key: str, default: ~typing.Any = <object object>) -> Any

Parameters

Name	Description
key Required
default

popitem

Removes and returns some (key, value) pair :returns: The (key, value) pair. :rtype: tuple :raises KeyError: if the dictionary is empty.

popitem() -> tuple[str, Any]

setdefault

Return the value for key if key is in the dictionary; otherwise set the key to default and return default. :param str key: The key to look up. :param any default: The value to set if key is not in the dictionary :returns: The value for key if key is in the dictionary, else default. :rtype: any

setdefault(key: str, default: ~typing.Any = <object object>) -> Any

Parameters

Name	Description
key Required
default

update

Update the dictionary from a mapping or an iterable of key-value pairs. :param any args: Either a mapping object or an iterable of key-value pairs.

update(*args: Any, **kwargs: Any) -> None

values

values() -> ValuesView[Any]

Returns

Type	Description
ValuesView	an object providing a view on the mapping's values

Attributes

agent_name

The agent this monitor analyzes. There can be only one monitor per agent. Required.

agent_name: str

enabled

Whether scheduled insight generation is armed for the monitor. Required.

enabled: bool

estimated_cost

Estimated cost accumulated by Agent Insights for this monitor.

estimated_cost: _models.AgentInsightEstimatedCost | None

id

The monitor identifier. Required.

id: str

model_deployment_name

The model deployment to use for analyzing traces. Accepts either the deployment name alone or with the connection name as '{connectionName}/modelDeploymentName'. Required.

model_deployment_name: str

next_scheduled_run_at

The next time a scheduled agent insight run will start. Omitted when scheduled generation is disabled.

next_scheduled_run_at: datetime | None

overview

The effective overview, or null before an overview is available. Required.

overview: _models.AgentInsightsOverview

run_interval_hours

Interval between scheduled insight runs, in hours. Required.

run_interval_hours: float

suspension

Why the system suspended scheduled generation. Null when the monitor is not suspended. Required.

suspension: _models.AgentInsightSuspension

updated_at

The time when this monitor was last updated. Required.

updated_at: datetime