Share via

EvaluatorsOperations Class

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through

AIProjectClient's

<xref:evaluators> attribute.

Constructor

EvaluatorsOperations(*args, **kwargs)

Methods

create_version

Create a new EvaluatorVersion with auto incremented version id.
delete_version

Delete the specific version of the EvaluatorVersion. The service returns 204 No Content if the EvaluatorVersion was deleted successfully or if the EvaluatorVersion does not exist.
get_version

Get the specific version of the EvaluatorVersion. The service returns 404 Not Found error if the EvaluatorVersion does not exist.
list_latest_versions

List the latest version of each evaluator.
list_versions

List all versions of the given evaluator.
update_version

Update an existing EvaluatorVersion with the given version id.

create_version

Create a new EvaluatorVersion with auto incremented version id.

create_version(name: str, evaluator_version: _models.EvaluatorVersion, *, content_type: str = 'application/json', **kwargs: Any) -> _models.EvaluatorVersion

Parameters

Name Description
name
Required
str

The name of the resource. Required.
evaluator_version
Required
EvaluatorVersion or <xref:JSON> or IO[bytes]

Evaluator resource. Is one of the following types: EvaluatorVersion, JSON, IO[bytes] Required.

Returns

Type Description
EvaluatorVersion

EvaluatorVersion. The EvaluatorVersion is compatible with MutableMapping

Exceptions

Type Description
HttpResponseError

delete_version

Delete the specific version of the EvaluatorVersion. The service returns 204 No Content if the EvaluatorVersion was deleted successfully or if the EvaluatorVersion does not exist.

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

Parameters

Name Description
name
Required
str

The name of the resource. Required.
version
Required
str

The version of the EvaluatorVersion to delete. Required.

Returns

Type Description
None

None

Exceptions

Type Description
HttpResponseError

get_version

Get the specific version of the EvaluatorVersion. The service returns 404 Not Found error if the EvaluatorVersion does not exist.

get_version(name: str, version: str, **kwargs: Any) -> EvaluatorVersion

Parameters

Name Description
name
Required
str

The name of the resource. Required.
version
Required
str

The specific version id of the EvaluatorVersion to retrieve. Required.

Returns

Type Description
EvaluatorVersion

EvaluatorVersion. The EvaluatorVersion is compatible with MutableMapping

Exceptions

Type Description
HttpResponseError

list_latest_versions

List the latest version of each evaluator.

list_latest_versions(*, type: Literal['builtin'] | Literal['custom'] | Literal['all'] | str | None = None, limit: int | None = None, **kwargs: Any) -> ItemPaged[EvaluatorVersion]

Keyword-Only Parameters

Name Description
type
str or str or str or str

Filter evaluators by type. Possible values: 'all', 'custom', 'builtin'. Is one of the following types: Literal["builtin"], Literal["custom"], Literal["all"], str Default value is None.

Default value: None
limit
int

A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20. Default value is None.

Default value: None

Returns

Type Description
ItemPaged[EvaluatorVersion]

An iterator like instance of EvaluatorVersion

Exceptions

Type Description
HttpResponseError

list_versions

List all versions of the given evaluator.

list_versions(name: str, *, type: Literal['builtin'] | Literal['custom'] | Literal['all'] | str | None = None, limit: int | None = None, **kwargs: Any) -> ItemPaged[EvaluatorVersion]

Parameters

Name Description
name
Required
str

The name of the resource. Required.

Keyword-Only Parameters

Name Description
type
str or str or str or str

Filter evaluators by type. Possible values: 'all', 'custom', 'builtin'. Is one of the following types: Literal["builtin"], Literal["custom"], Literal["all"], str Default value is None.

Default value: None
limit
int

A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20. Default value is None.

Default value: None

Returns

Type Description
ItemPaged[EvaluatorVersion]

An iterator like instance of EvaluatorVersion

Exceptions

Type Description
HttpResponseError

update_version

Update an existing EvaluatorVersion with the given version id.

update_version(name: str, version: str, evaluator_version: _models.EvaluatorVersion, *, content_type: str = 'application/json', **kwargs: Any) -> _models.EvaluatorVersion

Parameters

Name Description
name
Required
str

The name of the resource. Required.
version
Required
str

The version of the EvaluatorVersion to update. Required.
evaluator_version
Required
EvaluatorVersion or <xref:JSON> or IO[bytes]

Evaluator resource. Is one of the following types: EvaluatorVersion, JSON, IO[bytes] Required.

Returns

Type Description
EvaluatorVersion

EvaluatorVersion. The EvaluatorVersion is compatible with MutableMapping

Exceptions

Type Description
HttpResponseError