AgentInsightRun Class

A long-running run that analyzes one agent's traces and updates that agent's insights.

Constructor

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

Variables

Name	Description
id	str Server-assigned unique identifier. Required.
inputs	AgentInsightRunCreate Caller-supplied inputs.
result	AgentInsightRunResult Result produced on success.
status	str or JobStatus Current lifecycle status. Required. Known values are: "queued", "in_progress", "succeeded", "failed", and "cancelled".
error	ApiError Error details — populated only on failure.
monitor_id	str The Agent Insights monitor this run belongs to. Required.
agent_name	str The agent whose traces are analyzed by this run. Required.
trigger	str or AgentInsightRunTrigger The trigger that started the run. Required. Known values are: "on_demand" and "scheduled".
created_at	datetime The time when this run was created. Required.
updated_at	datetime The time when this run was last updated. Required.
window_start	datetime The start of the trace window analyzed by this run. Required.
window_end	datetime The end of the trace window analyzed by this run. Required.
started_at	datetime The time when this run started processing.
completed_at	datetime The time when this run reached a terminal status.
model_deployment_name	str The model deployment used to analyze traces for this run. 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 whose traces are analyzed by this run. Required.

agent_name: str

completed_at

The time when this run reached a terminal status.

completed_at: datetime | None

created_at

The time when this run was created. Required.

created_at: datetime

error

Error details — populated only on failure.

error: _models.ApiError | None

id

Server-assigned unique identifier. Required.

id: str

inputs

Caller-supplied inputs.

inputs: _models.AgentInsightRunCreate | None

model_deployment_name

The model deployment used to analyze traces for this run. Required.

model_deployment_name: str

monitor_id

The Agent Insights monitor this run belongs to. Required.

monitor_id: str

result

Result produced on success.

result: _models.AgentInsightRunResult | None

started_at

The time when this run started processing.

started_at: datetime | None

status

"queued", "in_progress", "succeeded", "failed", and "cancelled".

status: str | _models.JobStatus

trigger

"on_demand" and "scheduled".

trigger: str | _models.AgentInsightRunTrigger

updated_at

The time when this run was last updated. Required.

updated_at: datetime

window_end

The end of the trace window analyzed by this run. Required.

window_end: datetime

window_start

The start of the trace window analyzed by this run. Required.

window_start: datetime

Opinia

Czy ta strona była pomocna?