Azure · glharper · Sep 25, 2024 · Sep 25, 2024 · Sep 26, 2024 · Sep 26, 2024
@@ -39,8 +39,8 @@ class AgentsNamedToolChoiceType(str, Enum, metaclass=CaseInsensitiveEnumMeta):
     """Tool type ``file_search``"""
     BING_GROUNDING = "bing_grounding"
     """Tool type ``bing_grounding``"""
-    MICROSOFT_FABRIC = "microsoft_fabric"
-    """Tool type ``microsoft_fabric``"""
+    MICROSOFT_FABRIC = "fabric_aiskill"
+    """Tool type ``fabric_aiskill``"""
     SHAREPOINT = "sharepoint_grounding"
     """Tool type ``sharepoint_grounding``"""
     AZURE_AI_SEARCH = "azure_ai_search"

@@ -223,7 +223,7 @@ class AgentsNamedToolChoice(_model_base.Model):
 
     :ivar type: the type of tool. If type is ``function``\\ , the function name must be set.
      Required. Known values are: "function", "code_interpreter", "file_search", "bing_grounding",
-     "microsoft_fabric", "sharepoint_grounding", and "azure_ai_search".
+     "fabric_aiskill", "sharepoint_grounding", and "azure_ai_search".
     :vartype type: str or ~azure.ai.projects.models.AgentsNamedToolChoiceType
     :ivar function: The name of the function to call.
     :vartype function: ~azure.ai.projects.models.FunctionName
@@ -232,7 +232,7 @@ class AgentsNamedToolChoice(_model_base.Model):
     type: Union[str, "_models.AgentsNamedToolChoiceType"] = rest_field()
     """the type of tool. If type is ``function``, the function name must be set. Required. Known
      values are: \"function\", \"code_interpreter\", \"file_search\", \"bing_grounding\",
-     \"microsoft_fabric\", \"sharepoint_grounding\", and \"azure_ai_search\"."""
+     \"fabric_aiskill\", \"sharepoint_grounding\", and \"azure_ai_search\"."""
     function: Optional["_models.FunctionName"] = rest_field()
     """The name of the function to call."""
 
@@ -2410,28 +2410,28 @@ def __init__(self, *args: Any, **kwargs: Any) -> None:
         super().__init__(*args, **kwargs)
 
 
-class MicrosoftFabricToolDefinition(ToolDefinition, discriminator="microsoft_fabric"):
+class MicrosoftFabricToolDefinition(ToolDefinition, discriminator="fabric_aiskill"):
     """The input definition information for a Microsoft Fabric tool as used to configure an agent.
 
 
-    :ivar type: The object type, which is always 'microsoft_fabric'. Required. Default value is
-     "microsoft_fabric".
+    :ivar type: The object type, which is always 'fabric_aiskill'. Required. Default value is
+     "fabric_aiskill".
     :vartype type: str
-    :ivar microsoft_fabric: The list of connections used by the Microsoft Fabric tool. Required.
-    :vartype microsoft_fabric: ~azure.ai.projects.models.ToolConnectionList
+    :ivar fabric_aiskill: The list of connections used by the Microsoft Fabric tool. Required.
+    :vartype fabric_aiskill: ~azure.ai.projects.models.ToolConnectionList
     """
 
-    type: Literal["microsoft_fabric"] = rest_discriminator(name="type")  # type: ignore
-    """The object type, which is always 'microsoft_fabric'. Required. Default value is
-     \"microsoft_fabric\"."""
-    microsoft_fabric: "_models.ToolConnectionList" = rest_field()
+    type: Literal["fabric_aiskill"] = rest_discriminator(name="type")  # type: ignore
+    """The object type, which is always 'fabric_aiskill'. Required. Default value is
+     \"fabric_aiskill\"."""
+    fabric_aiskill: "_models.ToolConnectionList" = rest_field()
     """The list of connections used by the Microsoft Fabric tool. Required."""
 
     @overload
     def __init__(
         self,
         *,
-        microsoft_fabric: "_models.ToolConnectionList",
+        fabric_aiskill: "_models.ToolConnectionList",
     ) -> None: ...
 
     @overload
@@ -2442,7 +2442,7 @@ def __init__(self, mapping: Mapping[str, Any]) -> None:
         """
 
     def __init__(self, *args: Any, **kwargs: Any) -> None:
-        super().__init__(*args, type="microsoft_fabric", **kwargs)
+        super().__init__(*args, type="fabric_aiskill", **kwargs)
 
 
 class OpenAIFile(_model_base.Model):
@@ -2963,7 +2963,7 @@ def __init__(self, *args: Any, **kwargs: Any) -> None:
 
 
 class RequiredToolCall(_model_base.Model):
-    """An abstract representation a a tool invocation needed by the model to continue a run.
+    """An abstract representation of a tool invocation needed by the model to continue a run.
 
     You probably want to use the sub-classes and not this class directly. Known sub-classes are:
     RequiredFunctionToolCall
@@ -4498,7 +4498,7 @@ def __init__(self, *args: Any, **kwargs: Any) -> None:
         super().__init__(*args, **kwargs)
 
 
-class RunStepMicrosoftFabricToolCall(RunStepToolCall, discriminator="microsoft_fabric"):
+class RunStepMicrosoftFabricToolCall(RunStepToolCall, discriminator="fabric_aiskill"):
     """A record of a call to a Microsoft Fabric tool, issued by the model in evaluation of a defined
     tool, that represents
     executed Microsoft Fabric operations.
@@ -4507,17 +4507,17 @@ class RunStepMicrosoftFabricToolCall(RunStepToolCall, discriminator="microsoft_f
     :ivar id: The ID of the tool call. This ID must be referenced when you submit tool outputs.
      Required.
     :vartype id: str
-    :ivar type: The object type, which is always 'microsoft_fabric'. Required. Default value is
-     "microsoft_fabric".
+    :ivar type: The object type, which is always 'fabric_aiskill'. Required. Default value is
+     "fabric_aiskill".
     :vartype type: str
     :ivar microsoft_fabric: Reserved for future use. Required.
     :vartype microsoft_fabric: dict[str, str]
     """
 
-    type: Literal["microsoft_fabric"] = rest_discriminator(name="type")  # type: ignore
-    """The object type, which is always 'microsoft_fabric'. Required. Default value is
-     \"microsoft_fabric\"."""
-    microsoft_fabric: Dict[str, str] = rest_field()
+    type: Literal["fabric_aiskill"] = rest_discriminator(name="type")  # type: ignore
+    """The object type, which is always 'fabric_aiskill'. Required. Default value is
+     \"fabric_aiskill\"."""
+    microsoft_fabric: Dict[str, str] = rest_field(name="fabric_aiskill")
     """Reserved for future use. Required."""
 
     @overload
@@ -4536,7 +4536,7 @@ def __init__(self, mapping: Mapping[str, Any]) -> None:
         """
 
     def __init__(self, *args: Any, **kwargs: Any) -> None:
-        super().__init__(*args, type="microsoft_fabric", **kwargs)
+        super().__init__(*args, type="fabric_aiskill", **kwargs)
 
 
 class RunStepSharepointToolCall(RunStepToolCall, discriminator="sharepoint_grounding"):
@@ -5198,7 +5198,7 @@ def __init__(self, *args: Any, **kwargs: Any) -> None:
 
 class ToolConnectionList(_model_base.Model):
     """A set of connection resources currently used by either the ``bing_grounding``\\ ,
-    ``microsoft_fabric``\\ , or ``sharepoint_grounding`` tools.
+    ``fabric_aiskill``\\ , or ``sharepoint_grounding`` tools.
 
     :ivar connection_list: The connections attached to this tool. There can be a maximum of 1
      connection

@@ -55,6 +55,7 @@
     MessageTextContent,
     MessageTextFileCitationAnnotation,
     MessageTextFilePathAnnotation,
+    MicrosoftFabricToolDefinition,
     OpenAIPageableListOfThreadMessage,
     RequiredFunctionToolCall,
     RunStep,
@@ -510,25 +511,15 @@ class AzureAISearchTool(Tool):
     A tool that searches for information using Azure AI Search.
     """
 
-    def __init__(self):
-        self.index_list = []
-
-    def add_index(self, index: str, name: str):
-        """
-        Add an index ID to the list of indices used to search.
-
-        :param str index: The index connection id.
-        :param str name: The index name.
-        """
-        # TODO
-        self.index_list.append(IndexResource(index_connection_id=index, index_name=name))
+    def __init__(self, index_connection_id: str, index_name: str):
+        self.index_list = [IndexResource(index_connection_id=index_connection_id, index_name=index_name)]
 
     @property
     def definitions(self) -> List[ToolDefinition]:
         """
         Get the Azure AI search tool definitions.
 
-        :rtype: List[ToolDefinition]
+        :return: A list of tool definitions.
         """
         return [AzureAISearchToolDefinition()]
 
@@ -537,13 +528,16 @@ def resources(self) -> ToolResources:
         """
         Get the Azure AI search resources.
 
-        :rtype: ToolResources
+        :return: ToolResources populated with azure_ai_search associated resources.
         """
         return ToolResources(azure_ai_search=AzureAISearchResource(index_list=self.index_list))
 
     def execute(self, tool_call: Any) -> Any:
-        pass
+        """
+        AI Search tool does not execute client-side.
+        """
 
+        pass
 
 class ConnectionTool(Tool):
     """
@@ -587,6 +581,20 @@ def definitions(self) -> List[ToolDefinition]:
         return [BingGroundingToolDefinition(bing_grounding=ToolConnectionList(connection_list=self.connection_ids))]
 
 
+class FabricTool(ConnectionTool):
+    """
+    A tool that searches for information using Microsoft Fabric.
+    """
+
+    @property
+    def definitions(self) -> List[ToolDefinition]:
+        """
+        Get the Microsoft Fabric tool definitions.
+
+        :rtype: List[ToolDefinition]
+        """
+        return [MicrosoftFabricToolDefinition(fabric_aiskill=ToolConnectionList(connection_list=self.connection_ids))]
+
 class SharepointTool(ConnectionTool):
     """
     A tool that searches for information using Sharepoint.
@@ -1432,6 +1440,7 @@ def get_last_text_message_by_sender(self, sender: str) -> Optional[MessageTextCo
     "FunctionTool",
     "BingGroundingTool",
     "SharepointTool",
+    "FabricTool",
     "AzureAISearchTool",
     "SASTokenCredential",
     "Tool",

@@ -9,6 +9,8 @@
 DESCRIPTION:
     This sample demonstrates how to use agent operations with the 
     Azure AI Search tool from the Azure Agents service using a synchronous client.
+    To learn how to set up an Azure AI Search resource,
+    visit https://learn.microsoft.com/azure/search/search-get-started-portal
 
 USAGE:
     python sample_agents_azure_ai_search.py
@@ -36,30 +38,18 @@
     conn_str=os.environ["PROJECT_CONNECTION_STRING"],
 )
 
-# [START create_agent_with_azure_ai_search_tool]
-conn_list = project_client.connections.list()
-conn_id = ""
-for conn in conn_list:
-    if conn.connection_type == "CognitiveSearch":
-        conn_id = conn.id
-        break
-
-print(conn_id)
-
 # Initialize agent AI search tool and add the search index connection id
-ai_search = AzureAISearchTool()
-ai_search.add_index(conn_id, "sample_index")
+ai_search = AzureAISearchTool(index_connection_id="myconnectionid", index_name="myindexname")
 
 # Create agent with AI search tool and process assistant run
 with project_client:
     agent = project_client.agents.create_agent(
-        model="gpt-4-1106-preview",
+        model="gpt-4o",
         name="my-assistant",
         instructions="You are a helpful assistant",
         tools=ai_search.definitions,
         headers={"x-ms-enable-preview": "true"},
     )
-    # [END create_agent_with_azure_ai_search_tool]
     print(f"Created agent, ID: {agent.id}")
 
     # Create thread for communication
@@ -70,7 +60,7 @@
     message = project_client.agents.create_message(
         thread_id=thread.id,
         role="user",
-        content="Hello, send an email with the datetime and weather information in New York?",
+        content="What inventory is available currently?",
     )
     print(f"Created message, ID: {message.id}")
 

@@ -0,0 +1,80 @@
+# ------------------------------------
+# Copyright (c) Microsoft Corporation.
+# Licensed under the MIT License.
+# ------------------------------------
+
+"""
+FILE: sample_agents_fabric.py
+
+DESCRIPTION:
+    This sample demonstrates how to use agent operations with the Microsoft Fabric grounding tool from
+    the Azure Agents service using a synchronous client.
+
+USAGE:
+    python sample_agents_fabric.py
+
+    Before running the sample:
+
+    pip install azure-ai-projects azure-identity
+
+    Set this environment variables with your own values:
+    PROJECT_CONNECTION_STRING - the Azure AI Project connection string, as found in your AI Studio Project.
+"""
+
+import os
+from azure.ai.projects import AIProjectClient
+from azure.identity import DefaultAzureCredential
+from azure.ai.projects.models import FabricTool
+
+
+# Create an Azure AI Client from a connection string, copied from your AI Studio project.
+# At the moment, it should be in the format "<HostName>;<AzureSubscriptionId>;<ResourceGroup>;<HubName>"
+# Customer needs to login to Azure subscription via Azure CLI and set the environment variables
+
+project_client = AIProjectClient.from_connection_string(
+    credential=DefaultAzureCredential(),
+    conn_str=os.environ["PROJECT_CONNECTION_STRING"],
+)
+
+conn_id = "your-connection-id"
+
+# Initialize agent fabric tool and add the connection id
+fabric = FabricTool(connection_id=conn_id)
+
+# Create agent with the fabric tool and process assistant run
+with project_client:
+    agent = project_client.agents.create_agent(
+        model="gpt-4o",
+        name="my-assistant",
+        instructions="You are a helpful assistant",
+        tools=fabric.definitions,
+        headers={"x-ms-enable-preview": "true"},
+    )
+    print(f"Created agent, ID: {agent.id}")
+
+    # Create thread for communication
+    thread = project_client.agents.create_thread()
+    print(f"Created thread, ID: {thread.id}")
+
+    # Create message to thread
+    message = project_client.agents.create_message(
+        thread_id=thread.id,
+        role="user",
+        content="How does wikipedia explain Euler's Identity?",
+    )
+    print(f"Created message, ID: {message.id}")
+
+    # Create and process agent run in thread with tools
+    run = project_client.agents.create_and_process_run(thread_id=thread.id, assistant_id=agent.id)
+    print(f"Run finished with status: {run.status}")
+
+    if run.status == "failed":
+        print(f"Run failed: {run.last_error}")
+
+    # Delete the assistant when done
+    project_client.agents.delete_agent(agent.id)
+    print("Deleted agent")
+
+    # Fetch and log all messages
+    messages = project_client.agents.list_messages(thread_id=thread.id)
+    print(f"Messages: {messages}")