BetaInsightsOperations Class
Warning
DO NOT instantiate this class directly.
Instead, you should access the following operations through
<xref:insights> attribute.
Constructor
BetaInsightsOperations(*args, **kwargs)Methods
| generate |
Generate insights. Generates an insights report from the provided evaluation configuration. |
| get |
Get an insight. Retrieves the specified insight report and its results. |
| list |
List insights. Returns insights in reverse chronological order, with the most recent entries first. |
generate
Generate insights.
Generates an insights report from the provided evaluation configuration.
generate(insight: _models.Insight, *, content_type: str = 'application/json', **kwargs: Any) -> _models.InsightParameters
| Name | Description |
|---|---|
|
insight
Required
|
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. The Insight is compatible with MutableMapping |
Exceptions
| Type | Description |
|---|---|
get
Get an insight.
Retrieves the specified insight report and its results.
get(insight_id: str, *, include_coordinates: bool | None = None, **kwargs: Any) -> InsightParameters
| Name | Description |
|---|---|
|
insight_id
Required
|
The unique identifier for the insights report. Required. |
Keyword-Only Parameters
| Name | Description |
|---|---|
|
include_coordinates
|
Whether to include coordinates for visualization in the response. Defaults to false. Default value is None. Default value: None
|
Returns
| Type | Description |
|---|---|
|
Insight. The Insight is compatible with MutableMapping |
Exceptions
| Type | Description |
|---|---|
list
List insights.
Returns insights in reverse chronological order, with the most recent entries 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
|
Filter by the evaluation ID. Default value is None. Default value: None
|
|
run_id
|
Filter by the evaluation run ID. Default value is None. Default value: None
|
|
agent_name
|
Filter by the agent name. Default value is None. Default value: None
|
|
include_coordinates
|
Whether to include coordinates for visualization in the response. Defaults to false. Default value is None. Default value: None
|
Returns
| Type | Description |
|---|---|
|
An iterator like instance of Insight |
Exceptions
| Type | Description |
|---|---|
