AgentOptimizationJob Class

Agent optimization job resource — a long-running job that produces candidate changes to a Foundry agent configuration.

Constructor

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

Variables

Name	Description
id	str Server-assigned unique identifier. Required.
result	AgentOptimizationJobResult Result produced on success.
status	str or JobStatus Current lifecycle status. Required. Known values are: "queued", "in_progress", "succeeded", "failed", and "cancelled".
error	ApiError Error details — populated only on failure.
display_name	str Human-readable label. Omitted when no label is needed; it has no uniqueness, routing, or idempotency semantics.
target_configuration	AgentOptimizationTargetConfiguration Foundry agent whose configuration is optimized. Omitted when the workflow does not target a registered Foundry agent.
optimization_model_configuration	AgentOptimizationModelConfiguration Model used to generate candidate changes. An existing deployment name is also accepted. Required.
optimization_configuration	AgentOptimizationConfigurationBase Type-specific optimization configuration. Required.
run_duration_ms	timedelta Duration for which the job has been running, in milliseconds. Required.
created_at	datetime The timestamp when the job was created, represented in Unix time. Required.
updated_at	datetime The timestamp when the job was last updated, represented in Unix time. Required.
warnings	list[str] Non-fatal warnings emitted during optimization. Omitted when no warnings were produced.

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

created_at

The timestamp when the job was created, represented in Unix time. Required.

created_at: datetime

display_name

Human-readable label. Omitted when no label is needed; it has no uniqueness, routing, or idempotency semantics.

display_name: str | None

error

Error details — populated only on failure.

error: _models.ApiError | None

id

Server-assigned unique identifier. Required.

id: str

optimization_configuration

Type-specific optimization configuration. Required.

optimization_configuration: _models.AgentOptimizationConfigurationBase

optimization_model_configuration

Model used to generate candidate changes. An existing deployment name is also accepted. Required.

optimization_model_configuration: _models.AgentOptimizationModelConfiguration

result

Result produced on success.

result: _models.AgentOptimizationJobResult | None

run_duration_ms

Duration for which the job has been running, in milliseconds. Required.

run_duration_ms: timedelta

status

"queued", "in_progress", "succeeded", "failed", and "cancelled".

status: str | _models.JobStatus

target_configuration

Foundry agent whose configuration is optimized. Omitted when the workflow does not target a registered Foundry agent.

target_configuration: _models.AgentOptimizationTargetConfiguration | None

updated_at

The timestamp when the job was last updated, represented in Unix time. Required.

updated_at: datetime

warnings

Non-fatal warnings emitted during optimization. Omitted when no warnings were produced.

warnings: list[str] | None

Comentários

Esta página foi útil?