FabricIQPreviewTool Class

A FabricIQ server-side tool.

Constructor

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

Variables

Name Description
type
str or <xref:azure.ai.projects.models.FABRIC_IQ_PREVIEW>

The object type, which is always 'fabric_iq_preview'. Required. FABRIC_IQ_PREVIEW.

project_connection_id
str

The ID of the FabricIQ project connection. Required.

server_label
str

(Optional) The label of the FabricIQ MCP server to connect to.

server_url
str

(Optional) The URL of the FabricIQ MCP server. If not provided, the URL from the project connection will be used.

require_approval

(Optional) Whether the agent requires approval before executing actions. Default is always. Is either a MCPToolRequireApproval type or a str type.

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

Whether to remove the readonly properties.

Default value: False

Returns

Type Description

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

a set-like object providing a view on the mapping's items

keys

keys() -> KeysView[str]

Returns

Type Description

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

an object providing a view on the mapping's values

Attributes

project_connection_id

The ID of the FabricIQ project connection. Required.

project_connection_id: str

require_approval

(Optional) Whether the agent requires approval before executing actions. Default is always. Is either a MCPToolRequireApproval type or a str type.

require_approval: _models.MCPToolRequireApproval | str | None

server_label

(Optional) The label of the FabricIQ MCP server to connect to.

server_label: str | None

server_url

(Optional) The URL of the FabricIQ MCP server. If not provided, the URL from the project connection will be used.

server_url: str | None

type

The object type, which is always 'fabric_iq_preview'. Required. FABRIC_IQ_PREVIEW.

type: FABRIC_IQ_PREVIEW: 'fabric_iq_preview'>]