AgentInsight Class

A persisted issue discovered from an agent's traces.

Constructor

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

Variables

Name	Description
id	str The insight identifier. Required.
monitor_id	str The Agent Insights monitor this insight belongs to. Required.
agent_name	str The agent this insight belongs to. Required.
agent_version	str The latest immutable agent version associated with this insight. Required.
title	str A short title for the issue. Required.
severity	str or AgentInsightSeverity The severity of the issue. Required. Known values are: "high", "medium", and "low".
category	str An open, service-generated category label for the issue. Clients must accept previously unseen values. Required.
status	str or AgentInsightStatus The lifecycle status of the insight. Required. Known values are: "active", "resolved", and "ignored".
trace_count	int The number of traces that provide evidence for this insight. Required.
created_at	datetime The time when this insight was created. Required.
updated_at	datetime The time when this insight was last updated. Required.
description	str The root-cause diagnosis for the issue. Required.
details	AgentInsightDetails Additional insight details. Omitted unless details are requested.

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 insight belongs to. Required.

agent_name: str

agent_version

The latest immutable agent version associated with this insight. Required.

agent_version: str

category

An open, service-generated category label for the issue. Clients must accept previously unseen values. Required.

category: str

created_at

The time when this insight was created. Required.

created_at: datetime

description

The root-cause diagnosis for the issue. Required.

description: str

details

Additional insight details. Omitted unless details are requested.

details: _models.AgentInsightDetails | None

id

The insight identifier. Required.

id: str

monitor_id

The Agent Insights monitor this insight belongs to. Required.

monitor_id: str

severity

"high", "medium", and "low".

severity: str | _models.AgentInsightSeverity

status

"active", "resolved", and "ignored".

status: str | _models.AgentInsightStatus

title

A short title for the issue. Required.

title: str

trace_count

The number of traces that provide evidence for this insight. Required.

trace_count: int

updated_at

The time when this insight was last updated. Required.

updated_at: datetime