Share via

EvaluationsOperations Class

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through

AIProjectClient's

<xref:evaluations> attribute.

Constructor

EvaluationsOperations(*args, **kwargs)

Methods

cancel

Cancel an evaluation run by name.
create

Creates an evaluation run.
create_agent_evaluation

Creates an agent evaluation run.
delete

Delete an evaluation run by name.
get

Get an evaluation run by name.
list

List evaluation runs.

cancel

Cancel an evaluation run by name.

cancel(name: str, **kwargs: Any) -> None

Parameters

Name Description
name
Required
str

Identifier of the evaluation. Required.

Returns

Type Description
None

None

Exceptions

Type Description
HttpResponseError

create

Creates an evaluation run.

create(evaluation: _models.Evaluation, *, content_type: str = 'application/json', **kwargs: Any) -> _models.Evaluation

Parameters

Name Description
evaluation
Required
Evaluation or <xref:JSON> or IO[bytes]

Evaluation to be run. Is one of the following types: Evaluation, JSON, IO[bytes] Required.

Returns

Type Description
Evaluation

Evaluation. The Evaluation is compatible with MutableMapping

Exceptions

Type Description
HttpResponseError

create_agent_evaluation

Creates an agent evaluation run.

create_agent_evaluation(evaluation: _models.AgentEvaluationRequest, *, content_type: str = 'application/json', **kwargs: Any) -> _models.AgentEvaluation

Parameters

Name Description
evaluation
Required
AgentEvaluationRequest or <xref:JSON> or IO[bytes]

Agent evaluation to be run. Is one of the following types: AgentEvaluationRequest, JSON, IO[bytes] Required.

Returns

Type Description
AgentEvaluation

AgentEvaluation. The AgentEvaluation is compatible with MutableMapping

Exceptions

Type Description
HttpResponseError

delete

Delete an evaluation run by name.

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

Parameters

Name Description
name
Required
str

Identifier of the evaluation. Required.

Returns

Type Description
None

None

Exceptions

Type Description
HttpResponseError

get

Get an evaluation run by name.

get(name: str, **kwargs: Any) -> Evaluation

Parameters

Name Description
name
Required
str

Identifier of the evaluation. Required.

Returns

Type Description
Evaluation

Evaluation. The Evaluation is compatible with MutableMapping

Exceptions

Type Description
HttpResponseError

list

List evaluation runs.

list(**kwargs: Any) -> ItemPaged[Evaluation]

Returns

Type Description
ItemPaged[Evaluation]

An iterator like instance of Evaluation

Exceptions

Type Description
HttpResponseError