HostedAgentDefinition Class

The hosted agent definition.

You probably want to use the sub-classes and not this class directly. Known sub-classes are: ImageBasedHostedAgentDefinition

Constructor

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

Variables

Name	Description
rai_config	RaiConfig Configuration for Responsible AI (RAI) content filtering and safety features.
kind	str or <xref:azure.ai.projects.models.HOSTED> Required.
tools	list[Tool] An array of tools the hosted agent's model may call while generating a response. You can specify which tool to use by setting the tool_choice parameter.
container_protocol_versions	list[ProtocolVersionRecord] The protocols that the agent supports for ingress communication of the containers. Required.
cpu	str The CPU configuration for the hosted agent. Required.
memory	str The memory configuration for the hosted agent. Required.
environment_variables	dict[str, str] Environment variables to set in the hosted agent container.

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

container_protocol_versions

The protocols that the agent supports for ingress communication of the containers. Required.

container_protocol_versions: list['_models.ProtocolVersionRecord']

cpu

The CPU configuration for the hosted agent. Required.

cpu: str

environment_variables

Environment variables to set in the hosted agent container.

environment_variables: dict[str, str] | None

kind

Required.

kind: HOSTED: 'hosted'>]

memory

The memory configuration for the hosted agent. Required.

memory: str

rai_config

Configuration for Responsible AI (RAI) content filtering and safety features.

rai_config: '_models.RaiConfig' | None

tools

An array of tools the hosted agent's model may call while generating a response. You can specify which tool to use by setting the tool_choice parameter.

tools: list['_models.Tool'] | None