AzureFunctionToolCall Class

An Azure Function tool call.

Constructor

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

Variables

Name	Description
agent_reference	<xref:azure.ai.agentserver.responses.models.models.AgentReference> The agent that created the item.
response_id	str The response on which the item is created.
type	str or <xref:azure.ai.agentserver.responses.models.models.AZURE_FUNCTION_CALL> Required. AZURE_FUNCTION_CALL.
call_id	str The unique ID of the tool call generated by the model. Required.
name	str The name of the Azure Function being called. Required.
arguments	str A JSON string of the arguments to pass to the tool. Required.
status	str or <xref:azure.ai.agentserver.responses.models.models.ToolCallStatus> The status of the tool call. Required. Known values are: "in_progress", "completed", "incomplete", and "failed".
id	str Required.

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

agent_reference

The agent that created the item.

agent_reference: '_models.AgentReference' | None

arguments

A JSON string of the arguments to pass to the tool. Required.

arguments: str

call_id

The unique ID of the tool call generated by the model. Required.

call_id: str

id

Required.

id: str

name

The name of the Azure Function being called. Required.

name: str

response_id

The response on which the item is created.

response_id: str | None

status

"in_progress", "completed", "incomplete", and "failed".

status: str | _models.ToolCallStatus

type

Required. AZURE_FUNCTION_CALL.

type: AZURE_FUNCTION_CALL: 'azure_function_call'>]