Share via


EvaluationRulesOperations Class

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through

AIProjectClient's

<xref:evaluation_rules> attribute.

Constructor

EvaluationRulesOperations(*args, **kwargs)

Methods

create_or_update

Create or update an evaluation rule.

delete

Delete an evaluation rule.

get

Get an evaluation rule.

list

List all evaluation rules.

create_or_update

Create or update an evaluation rule.

create_or_update(id: str, evaluation_rule: _models.EvaluationRule, *, content_type: str = 'application/json', **kwargs: Any) -> _models.EvaluationRule

Parameters

Name Description
id
Required
str

Unique identifier for the evaluation rule. Required.

evaluation_rule
Required
EvaluationRule or <xref:JSON> or IO[bytes]

Evaluation rule resource. Is one of the following types: EvaluationRule, JSON, IO[bytes] Required.

Returns

Type Description

EvaluationRule. The EvaluationRule is compatible with MutableMapping

Exceptions

Type Description

delete

Delete an evaluation rule.

delete(id: str, **kwargs: Any) -> None

Parameters

Name Description
id
Required
str

Unique identifier for the evaluation rule. Required.

Returns

Type Description

None

Exceptions

Type Description

get

Get an evaluation rule.

get(id: str, **kwargs: Any) -> EvaluationRule

Parameters

Name Description
id
Required
str

Unique identifier for the evaluation rule. Required.

Returns

Type Description

EvaluationRule. The EvaluationRule is compatible with MutableMapping

Exceptions

Type Description

list

List all evaluation rules.

list(*, action_type: str | EvaluationRuleActionType | None = None, agent_name: str | None = None, enabled: bool | None = None, **kwargs: Any) -> ItemPaged[EvaluationRule]

Keyword-Only Parameters

Name Description
action_type

Filter by the type of evaluation rule. Known values are: "continuousEvaluation" and "humanEvaluation". Default value is None.

Default value: None
agent_name
str

Filter by the agent name. Default value is None.

Default value: None
enabled

Filter by the enabled status. Default value is None.

Default value: None

Returns

Type Description

An iterator like instance of EvaluationRule

Exceptions

Type Description