FunctionCallOutputItemParam Class

Function tool call output.

Constructor

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

Variables

Name	Description
id	str
call_id	str The unique ID of the function tool call generated by the model. Required.
type	str or <xref:azure.ai.agentserver.responses.models.models.FUNCTION_CALL_OUTPUT> The type of the function tool call output. Always function_call_output. Required. FUNCTION_CALL_OUTPUT.
output	str or list[<xref:azure.ai.agentserver.responses.models.models.InputTextContentParam> or <xref:azure.ai.agentserver.responses.models.models.InputImageContentParamAutoParam> or <xref:azure.ai.agentserver.responses.models.models.InputFileContentParam>] Text, image, or file output of the function tool call. Required. Is either a str type or a [Union["_models.InputTextContentParam", "_models.InputImageContentParamAutoParam", "_models.InputFileContentParam"]] type.
status	str or <xref:azure.ai.agentserver.responses.models.models.FunctionCallItemStatus> Known values are: "in_progress", "completed", and "incomplete".

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

call_id

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

call_id: str

id

id: str | None

output

Text, image, or file output of the function tool call. Required. Is either a str type or a [Union["_models.InputTextContentParam", "_models.InputImageContentParamAutoParam", "_models.InputFileContentParam"]] type.

output: str | list[typing.Union[ForwardRef('_models.InputTextContentParam'), ForwardRef('_models.InputImageContentParamAutoParam'), ForwardRef('_models.InputFileContentParam')]]

status

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

status: str | _models.FunctionCallItemStatus | None

type

The type of the function tool call output. Always function_call_output. Required. FUNCTION_CALL_OUTPUT.

type: FUNCTION_CALL_OUTPUT: 'function_call_output'>]