AgentOptimizationCandidate Class

A candidate generated by an optimization job.

Constructor

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

Variables

Name	Description
candidate_id	str Server-assigned candidate identifier. Required.
job_id	str Identifier of the parent optimization job. Required.
name	str Display name of the candidate (e.g., 'baseline', 'instruction-v2'). Required.
status	str or AgentOptimizationCandidateStatus The candidate's current lifecycle state. Required. Known values are: "generating", "evaluating", "completed", and "failed".
started_at	datetime Timestamp when work on this candidate slot began, represented in Unix time. Required.
output	AgentOptimizationCandidateOutput Typed output generated for this candidate. The output type matches the parent job's optimization type. Omitted until output is available.
rationale	str Human-readable explanation of why the optimizer produced this candidate. Populated on candidate GET when available and omitted from LIST.
agent_version	str Foundry agent version associated with this candidate. Omitted when no temporary or evaluated agent version was created.
evaluation	AgentOptimizationCandidateEvaluation Comparative evaluation summary. Omitted when this candidate was not comparatively evaluated.
promotion	AgentOptimizationCandidatePromotionInfo Promotion metadata. Omitted if this candidate has not been promoted.

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_version

Foundry agent version associated with this candidate. Omitted when no temporary or evaluated agent version was created.

agent_version: str | None

candidate_id

Server-assigned candidate identifier. Required.

candidate_id: str

evaluation

Comparative evaluation summary. Omitted when this candidate was not comparatively evaluated.

evaluation: _models.AgentOptimizationCandidateEvaluation | None

job_id

Identifier of the parent optimization job. Required.

job_id: str

name

Display name of the candidate (e.g., 'baseline', 'instruction-v2'). Required.

name: str

output

Typed output generated for this candidate. The output type matches the parent job's optimization type. Omitted until output is available.

output: _models.AgentOptimizationCandidateOutput | None

promotion

Promotion metadata. Omitted if this candidate has not been promoted.

promotion: _models.AgentOptimizationCandidatePromotionInfo | None

rationale

Human-readable explanation of why the optimizer produced this candidate. Populated on candidate GET when available and omitted from LIST.

rationale: str | None

started_at

Timestamp when work on this candidate slot began, represented in Unix time. Required.

started_at: datetime

status

"generating", "evaluating", "completed", and "failed".

status: str | _models.AgentOptimizationCandidateStatus

Feedback

Was this page helpful?