通过

你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

Evaluation Class

Evaluation Definition.

Constructor

Evaluation(*args: Any, **kwargs: Any)

Variables

Name Description
name
str

Identifier of the evaluation. Required.
data
InputData

Data for evaluation. Required.
display_name
str

Display Name for evaluation. It helps to find the evaluation easily in AI Foundry. It does not need to be unique.
description
str

Description of the evaluation. It can be used to store additional information about the evaluation and is mutable.
status
str

Status of the evaluation. It is set by service and is read-only.
tags
dict[str, str]

Evaluation's tags. Unlike properties, tags are fully mutable.
properties
dict[str, str]

Evaluation's properties. Unlike tags, properties are add-only. Once added, a property cannot be removed.
evaluators
dict[str, EvaluatorConfiguration]

Evaluators to be used for the evaluation. Required.
target
EvaluationTarget

Specifies the type and configuration of the entity used for this evaluation.

Methods

as_dict

Return a dict that can be turned into json using json.dump.
clear

Remove all items from D.
copy
get

Get the value for key if key is in the dictionary, else default. :param str key: The key to look up. :param any default: The value to return if key is not in the dictionary. Defaults to None :returns: D[k] if k in D, else d. :rtype: any
items
keys
pop

Removes specified key and return the corresponding value. :param str key: The key to pop. :param any default: The value to return if key is not in the dictionary :returns: The value corresponding to the key. :rtype: any :raises KeyError: If key is not found and default is not given.
popitem

Removes and returns some (key, value) pair :returns: The (key, value) pair. :rtype: tuple :raises KeyError: if D is empty.
setdefault

Same as calling D.get(k, d), and setting D[k]=d if k not found :param str key: The key to look up. :param any default: The value to set if key is not in the dictionary :returns: D[k] if k in D, else d. :rtype: any
update

Updates D from mapping/iterable E and F. :param any args: Either a mapping object or an iterable of key-value pairs.
values

as_dict

Return a dict that can be turned into json using json.dump.

as_dict(*, exclude_readonly: bool = False) -> Dict[str, Any]

Keyword-Only Parameters

Name Description
exclude_readonly
bool

Whether to remove the readonly properties.

Default value: False

Returns

Type Description
dict

A dict JSON compatible object

clear

Remove all items from D.

clear() -> None

copy 

copy() -> Model

get

Get the value for key if key is in the dictionary, else default. :param str key: The key to look up. :param any default: The value to return if key is not in the dictionary. Defaults to None :returns: D[k] if k in D, else d. :rtype: any

get(key: str, default: Any = None) -> Any

Parameters

Name Description
key
Required
default
Default value: None

items 

items() -> ItemsView[str, Any]

Returns

Type Description
ItemsView

set-like object providing a view on D's items

keys 

keys() -> KeysView[str]

Returns

Type Description
KeysView

a set-like object providing a view on D's keys

pop

Removes specified key and return the corresponding value. :param str key: The key to pop. :param any default: The value to return if key is not in the dictionary :returns: The value corresponding to the key. :rtype: any :raises KeyError: If key is not found and default is not given.

pop(key: str, default: ~typing.Any = <object object>) -> Any

Parameters

Name Description
key
Required
default

popitem

Removes and returns some (key, value) pair :returns: The (key, value) pair. :rtype: tuple :raises KeyError: if D is empty.

popitem() -> Tuple[str, Any]

setdefault

Same as calling D.get(k, d), and setting D[k]=d if k not found :param str key: The key to look up. :param any default: The value to set if key is not in the dictionary :returns: D[k] if k in D, else d. :rtype: any

setdefault(key: str, default: ~typing.Any = <object object>) -> Any

Parameters

Name Description
key
Required
default

update

Updates D from mapping/iterable E and F. :param any args: Either a mapping object or an iterable of key-value pairs.

update(*args: Any, **kwargs: Any) -> None

values 

values() -> ValuesView[Any]

Returns

Type Description
ValuesView

an object providing a view on D's values

Attributes

data

Data for evaluation. Required.

data: _models.InputData

description

Description of the evaluation. It can be used to store additional information about the evaluation and is mutable.

description: str | None

display_name

Display Name for evaluation. It helps to find the evaluation easily in AI Foundry. It does not need to be unique.

display_name: str | None

evaluators

Evaluators to be used for the evaluation. Required.

evaluators: Dict[str, _models.EvaluatorConfiguration]

name

Identifier of the evaluation. Required.

name: str

properties

Evaluation's properties. Unlike tags, properties are add-only. Once added, a property cannot be removed.

properties: Dict[str, str] | None

status

Status of the evaluation. It is set by service and is read-only.

status: str | None

tags

Evaluation's tags. Unlike properties, tags are fully mutable.

tags: Dict[str, str] | None

target

Specifies the type and configuration of the entity used for this evaluation.

target: _models.EvaluationTarget | None