通过

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

AgentEvaluationResult Class

Result for the agent evaluation evaluator run.

Constructor

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

Variables

Name Description
evaluator
str

Evaluator's name. This is the name of the evaluator that was used to evaluate the agent's completion. Required.
evaluator_id
str

Identifier of the evaluator. Required.
score
float

Score of the given evaluator. No restriction on range. Required.
status
str

Status of the evaluator result. Options: Running, Completed, Failed, NotApplicable. Required.
reason
str

Reasoning for the evaluation result.
version
str

Version of the evaluator that was used to evaluate the agent's completion.
thread_id
str

The unique identifier of the thread.
run_id
str

The unique identifier of the run. Required.
error
str

A string explaining why there was an error, if applicable.
additional_details
dict[str, str]

Additional properties relevant to the evaluator. These will differ between evaluators.

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

additional_details

Additional properties relevant to the evaluator. These will differ between evaluators.

additional_details: Dict[str, str] | None

error

A string explaining why there was an error, if applicable.

error: str | None

evaluator

Evaluator's name. This is the name of the evaluator that was used to evaluate the agent's completion. Required.

evaluator: str

evaluator_id

Identifier of the evaluator. Required.

evaluator_id: str

reason

Reasoning for the evaluation result.

reason: str | None

run_id

The unique identifier of the run. Required.

run_id: str

score

Score of the given evaluator. No restriction on range. Required.

score: float

status

Running, Completed, Failed, NotApplicable. Required.

status: str

thread_id

The unique identifier of the thread.

thread_id: str | None

version

Version of the evaluator that was used to evaluate the agent's completion.

version: str | None