InsightsOperations Class

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through

AIProjectClient's

<xref:insights> attribute.

Constructor

InsightsOperations(*args, **kwargs)

Methods

generate	Generate Insights.
get	Get a specific insight by Id.
list	List all insights in reverse chronological order (newest first).

generate

Generate Insights.

generate(insight: _models.Insight, *, content_type: str = 'application/json', **kwargs: Any) -> _models.Insight

Parameters

Name	Description
insight Required	Insight or <xref:JSON> or IO[bytes] Complete evaluation configuration including data source, evaluators, and result settings. Is one of the following types: Insight, JSON, IO[bytes] Required.

Returns

Type	Description
Insight	Insight. The Insight is compatible with MutableMapping

Exceptions

Type	Description
HttpResponseError

get

Get a specific insight by Id.

get(id: str, *, include_coordinates: bool | None = None, **kwargs: Any) -> Insight

Parameters

Name	Description
id Required	str The unique identifier for the insights report. Required.

Keyword-Only Parameters

Name	Description
include_coordinates	bool Whether to include coordinates for visualization in the response. Defaults to false. Default value is None. Default value: None

Returns

Type	Description
Insight	Insight. The Insight is compatible with MutableMapping

Exceptions

Type	Description
HttpResponseError

list

List all insights in reverse chronological order (newest first).

list(*, type: str | InsightType | None = None, eval_id: str | None = None, run_id: str | None = None, agent_name: str | None = None, include_coordinates: bool | None = None, **kwargs: Any) -> ItemPaged[Insight]

Keyword-Only Parameters

Name	Description
type	str or InsightType Filter by the type of analysis. Known values are: "EvaluationRunClusterInsight", "AgentClusterInsight", and "EvaluationComparison". Default value is None. Default value: None
eval_id	str Filter by the evaluation ID. Default value is None. Default value: None
run_id	str Filter by the evaluation run ID. Default value is None. Default value: None
agent_name	str Filter by the agent name. Default value is None. Default value: None
include_coordinates	bool Whether to include coordinates for visualization in the response. Defaults to false. Default value is None. Default value: None

Returns

Type	Description
ItemPaged[Insight]	An iterator like instance of Insight

Exceptions

Type	Description
HttpResponseError