CodeInterpreterToolCallItemResource Class

A tool call to run code.

Constructor

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

Variables

Name	Description
id	str Required.
created_by	CreatedBy The information about the creator of the item.
type	str or <xref:azure.ai.projects.models.CODE_INTERPRETER_CALL> Required.
status	str or str or str or str or str Required. Is one of the following types: Literal["in_progress"], Literal["completed"], Literal["incomplete"], Literal["interpreting"], Literal["failed"]
container_id	str The ID of the container used to run the code. Required.
code	str The code to run, or null if not available. Required.
outputs	list[CodeInterpreterOutput] The outputs generated by the code interpreter, such as logs or images. Can be null if no outputs are available. 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

code

The code to run, or null if not available. Required.

code: str

container_id

The ID of the container used to run the code. Required.

container_id: str

created_by

The information about the creator of the item.

created_by: '_models.CreatedBy' | None

id

Required.

id: str

outputs

The outputs generated by the code interpreter, such as logs or images. Can be null if no outputs are available. Required.

outputs: list['_models.CodeInterpreterOutput']

status

Literal["in_progress"], Literal["completed"], Literal["incomplete"], Literal["interpreting"], Literal["failed"]

status: Literal['in_progress', 'completed', 'incomplete', 'interpreting', 'failed']

type

Required.

type: CODE_INTERPRETER_CALL: 'code_interpreter_call'>]