AgentOptimizationConfiguration Class

Configuration for optimizing an agent for measured quality.

Constructor

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

Variables

Name	Description
type	str or <xref:azure.ai.projects.models.AGENT_OPTIMIZATION> Optimization type discriminator. Required. Comparative agent optimization.
goal	str or AgentOptimizationGoal Optimization goal. If omitted, the service defaults to improve_quality. "improve_quality"
evaluation_configuration	AgentOptimizationEvaluationConfiguration Quality measurement configuration. Required.
candidate_search_configuration	AgentOptimizationCandidateSearchConfiguration Configuration for candidate search and screening. Required.
baseline_agent_configuration	AgentOptimizationBaselineAgentConfiguration Caller-supplied baseline agent configuration. Omitted when all baseline values can be resolved from the target agent.
agent_optimization_space	AgentOptimizationSpace Agent attributes and alternatives available to the search. Required.

Methods

as_dict	Return a dict that can be turned into json using json.dump.
clear	Remove all items from the dictionary.
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: The value for key if key is in the dictionary, else default. :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 the dictionary is empty.
setdefault	Return the value for key if key is in the dictionary; otherwise set the key to default and return default. :param str key: The key to look up. :param any default: The value to set if key is not in the dictionary :returns: The value for key if key is in the dictionary, else default. :rtype: any
update	Update the dictionary from a mapping or an iterable of key-value pairs. :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 the dictionary.

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: The value for key if key is in the dictionary, else default. :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	a set-like object providing a view on the mapping's items

keys

keys() -> KeysView[str]

Returns

Type	Description
KeysView	a set-like object providing a view on the mapping'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 the dictionary is empty.

popitem() -> tuple[str, Any]

setdefault

Return the value for key if key is in the dictionary; otherwise set the key to default and return default. :param str key: The key to look up. :param any default: The value to set if key is not in the dictionary :returns: The value for key if key is in the dictionary, else default. :rtype: any

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

Parameters

Name	Description
key Required
default

update

Update the dictionary from a mapping or an iterable of key-value pairs. :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 the mapping's values

Attributes

agent_optimization_space

Agent attributes and alternatives available to the search. Required.

agent_optimization_space: _models.AgentOptimizationSpace

baseline_agent_configuration

Caller-supplied baseline agent configuration. Omitted when all baseline values can be resolved from the target agent.

baseline_agent_configuration: _models.AgentOptimizationBaselineAgentConfiguration | None

candidate_search_configuration

Configuration for candidate search and screening. Required.

candidate_search_configuration: _models.AgentOptimizationCandidateSearchConfiguration

evaluation_configuration

Quality measurement configuration. Required.

evaluation_configuration: _models.AgentOptimizationEvaluationConfiguration

goal

Optimization goal. If omitted, the service defaults to improve_quality. "improve_quality"

goal: str | _models.AgentOptimizationGoal | None

type

Optimization type discriminator. Required. Comparative agent optimization.

type: AGENT_OPTIMIZATION: 'agent_optimization'>]