Add SharePoint delta tool call. (#42623)

* Add SharePoint delta tool call.

* Add CodeIterpreter tests and Improve code interpreter.

* Generate code from the main branch.

Author: nick863

sdk/ai/azure-ai-agents/CHANGELOG.md

@@ -10,6 +10,9 @@
 - Added delete operation for `ThreadMessages`.
 - Add `RunStepDetailsActivity`, describing MCP function parameters.
 - Add `RunStepDeltaCustomBingGroundingToolCall`, describing `BingCustomSearchTool` updates in streaming scenario.
+- Add `RunStepDeltaMicrosoftFabricToolCall`, describing `FabricTool` updates in streaming scenario.
+- Add `RunStepDeltaSharepointToolCall`, describing `SharepointTool` updates in streaming scenario.
+- Improve code interpreter tool to take the list of `VectorStoreDataSource` as an input for enterprise file search.
 
 ### Bugs Fixed
 
@@ -18,6 +21,7 @@
 ### Sample updates
 
 - The file search samples were updated to demonstrate retrieving text associated with citations.
+- The SharePoint tool sample was updated to demonstrate retrieving text associated with citations and render references correctly.
 - Added samples for file search citation with streaming.
 - Bing Grounding and Bing Custom Search samples were fixed to correctly present references.
 

sdk/ai/azure-ai-agents/README.md

@@ -876,7 +876,7 @@ Here is an example:
 <!-- SNIPPET:sample_agents_browser_automation.create_agent_with_browser_automation -->
 
 ```python
-connection_id = os.environ["AZURE_PLAYWRIGHT_CONNECTION_ID"]
+connection_id = project_client.connections.get(os.environ["AZURE_PLAYWRIGHT_CONNECTION_NAME"]).id
 
 # Initialize Browser Automation tool and add the connection id
 browser_automation = BrowserAutomationTool(connection_id=connection_id)
@@ -911,7 +911,7 @@ Here is an example:
 <!-- SNIPPET:sample_agents_fabric.create_agent_with_fabric_tool -->
 
 ```python
-conn_id = os.environ["FABRIC_CONNECTION_ID"]
+conn_id = project_client.connections.get(os.environ["FABRIC_CONNECTION_NAME"]).id
 
 print(conn_id)
 

sdk/ai/azure-ai-agents/apiview-properties.json

@@ -152,6 +152,7 @@
         "azure.ai.agents.models.RunStepDeltaMicrosoftFabricToolCall": "Azure.AI.Agents.RunStepDeltaMicrosoftFabricToolCall",
         "azure.ai.agents.models.RunStepDeltaOpenAPIObject": "Azure.AI.Agents.RunStepDeltaOpenAPIObject",
         "azure.ai.agents.models.RunStepDeltaOpenAPIToolCall": "Azure.AI.Agents.RunStepDeltaOpenAPIToolCall",
+        "azure.ai.agents.models.RunStepDeltaSharepointToolCall": "Azure.AI.Agents.RunStepDeltaSharepointToolCall",
         "azure.ai.agents.models.RunStepDeltaToolCallObject": "Azure.AI.Agents.RunStepDeltaToolCallObject",
         "azure.ai.agents.models.RunStepDetailsActivity": "Azure.AI.Agents.RunStepDetailsActivity",
         "azure.ai.agents.models.RunStepError": "Azure.AI.Agents.RunStepError",

sdk/ai/azure-ai-agents/assets.json

@@ -2,5 +2,5 @@
   "AssetsRepo": "Azure/azure-sdk-assets",
   "AssetsRepoPrefixPath": "python",
   "TagPrefix": "python/ai/azure-ai-agents",
-  "Tag": "python/ai/azure-ai-agents_3c8c500083"
+  "Tag": "python/ai/azure-ai-agents_cf22042479"
 }

sdk/ai/azure-ai-agents/azure/ai/agents/models/__init__.py

@@ -161,6 +161,7 @@
     RunStepDeltaMicrosoftFabricToolCall,
     RunStepDeltaOpenAPIObject,
     RunStepDeltaOpenAPIToolCall,
+    RunStepDeltaSharepointToolCall,
     RunStepDeltaToolCall,
     RunStepDeltaToolCallObject,
     RunStepDetails,
@@ -403,6 +404,7 @@
     "RunStepDeltaMicrosoftFabricToolCall",
     "RunStepDeltaOpenAPIObject",
     "RunStepDeltaOpenAPIToolCall",
+    "RunStepDeltaSharepointToolCall",
     "RunStepDeltaToolCall",
     "RunStepDeltaToolCallObject",
     "RunStepDetails",

sdk/ai/azure-ai-agents/azure/ai/agents/models/_models.py

@@ -5112,7 +5112,7 @@ class RunStepDeltaToolCall(_Model):
     RunStepDeltaCodeInterpreterToolCall, RunStepDeltaConnectedAgentToolCall,
     RunStepDeltaDeepResearchToolCall, RunStepDeltaMicrosoftFabricToolCall,
     RunStepDeltaFileSearchToolCall, RunStepDeltaFunctionToolCall, RunStepDeltaMcpToolCall,
-    RunStepDeltaOpenAPIToolCall
+    RunStepDeltaOpenAPIToolCall, RunStepDeltaSharepointToolCall
 
     :ivar index: The index of the tool call detail in the run step's tool_calls array. Required.
     :vartype index: int
@@ -6071,6 +6071,46 @@ def __init__(self, *args: Any, **kwargs: Any) -> None:
         super().__init__(*args, type="openapi", **kwargs)
 
 
+class RunStepDeltaSharepointToolCall(RunStepDeltaToolCall, discriminator="sharepoint_grounding"):
+    """Represents the SharePoint tool call in a streaming run step.
+
+    :ivar index: The index of the tool call detail in the run step's tool_calls array. Required.
+    :vartype index: int
+    :ivar id: The ID of the tool call, used when submitting outputs to the run. Required.
+    :vartype id: str
+    :ivar type: The object type, which is always 'sharepoint_grounding'. Required. Default value is
+     "sharepoint_grounding".
+    :vartype type: str
+    :ivar sharepoint_grounding: SharePoint tool input and output. Required.
+    :vartype sharepoint_grounding: dict[str, str]
+    """
+
+    type: Literal["sharepoint_grounding"] = rest_discriminator(name="type", visibility=["read", "create", "update", "delete", "query"])  # type: ignore
+    """The object type, which is always 'sharepoint_grounding'. Required. Default value is
+     \"sharepoint_grounding\"."""
+    sharepoint_grounding: Dict[str, str] = rest_field(visibility=["read", "create", "update", "delete", "query"])
+    """SharePoint tool input and output. Required."""
+
+    @overload
+    def __init__(
+        self,
+        *,
+        index: int,
+        id: str,  # pylint: disable=redefined-builtin
+        sharepoint_grounding: Dict[str, str],
+    ) -> None: ...
+
+    @overload
+    def __init__(self, mapping: Mapping[str, Any]) -> None:
+        """
+        :param mapping: raw JSON to initialize the model.
+        :type mapping: Mapping[str, Any]
+        """
+
+    def __init__(self, *args: Any, **kwargs: Any) -> None:
+        super().__init__(*args, type="sharepoint_grounding", **kwargs)
+
+
 class RunStepDeltaToolCallObject(RunStepDeltaDetail, discriminator="tool_calls"):
     """Represents an invocation of tool calls as part of a streaming run step.
 
@@ -6601,7 +6641,7 @@ class RunStepSharepointToolCall(RunStepToolCall, discriminator="sharepoint_groun
     :ivar type: The object type, which is always 'sharepoint_grounding'. Required. Default value is
      "sharepoint_grounding".
     :vartype type: str
-    :ivar share_point: Reserved for future use. Required.
+    :ivar share_point: SharePoint tool input and output. Required.
     :vartype share_point: dict[str, str]
     """
 
@@ -6611,7 +6651,7 @@ class RunStepSharepointToolCall(RunStepToolCall, discriminator="sharepoint_groun
     share_point: Dict[str, str] = rest_field(
         name="sharepoint_grounding", visibility=["read", "create", "update", "delete", "query"]
     )
-    """Reserved for future use. Required."""
+    """SharePoint tool input and output. Required."""
 
     @overload
     def __init__(

sdk/ai/azure-ai-agents/azure/ai/agents/models/_patch.py

@@ -1431,31 +1431,68 @@ class CodeInterpreterTool(Tool[CodeInterpreterToolDefinition]):
 
     :param file_ids: A list of file IDs to interpret.
     :type file_ids: list[str]
+    :param data_sources: The list of data sources for the enterprise file search.
+    :type data_sources: list[VectorStoreDataSource]
+    :raises: ValueError if both file_ids and data_sources are provided.
     """
 
-    def __init__(self, file_ids: Optional[List[str]] = None):
-        if file_ids is None:
-            self.file_ids = set()
-        else:
+    _INVALID_CONFIGURATION = "file_ids and data_sources are mutually exclusive."
+
+    def __init__(
+        self,
+        file_ids: Optional[List[str]] = None,
+        data_sources: Optional[List[VectorStoreDataSource]] = None,
+    ):
+        if file_ids and data_sources:
+            raise ValueError(CodeInterpreterTool._INVALID_CONFIGURATION)
+        self.file_ids = set()
+        if file_ids:
             self.file_ids = set(file_ids)
+        self.data_sources: Dict[str, VectorStoreDataSource] = {}
+        if data_sources:
+            self.data_sources = {ds.asset_identifier: ds for ds in data_sources}
 
     def add_file(self, file_id: str) -> None:
         """
         Add a file ID to the list of files to interpret.
 
         :param file_id: The ID of the file to interpret.
         :type file_id: str
+        :raises: ValueError if data_sources are provided.
         """
+        if self.data_sources:
+            raise ValueError(CodeInterpreterTool._INVALID_CONFIGURATION)
         self.file_ids.add(file_id)
 
+    def add_data_source(self, data_source: VectorStoreDataSource) -> None:
+        """
+        Add a data source to the list of data sources to interpret.
+
+        :param data_source: The new data source.
+        :type data_source: VectorStoreDataSource
+        :raises: ValueError if file_ids are provided.
+        """
+        if self.file_ids:
+            raise ValueError(CodeInterpreterTool._INVALID_CONFIGURATION)
+        self.data_sources[data_source.asset_identifier] = data_source
+
     def remove_file(self, file_id: str) -> None:
         """
         Remove a file ID from the list of files to interpret.
 
         :param file_id: The ID of the file to remove.
         :type file_id: str
         """
-        self.file_ids.remove(file_id)
+        self.file_ids.discard(file_id)
+
+    def remove_data_source(self, asset_identifier: str) -> None:
+        """
+        Remove The asset from data_sources.
+
+        :param asset_identifier: The asset identifier to remove.
+        :type asset_identifier: str
+        """
+        self.data_sources.pop(asset_identifier, None)
 
     @property
     def definitions(self) -> List[CodeInterpreterToolDefinition]:
@@ -1473,9 +1510,13 @@ def resources(self) -> ToolResources:
 
         :rtype: ToolResources
         """
-        if not self.file_ids:
+        if not self.file_ids and not self.data_sources:
             return ToolResources()
-        return ToolResources(code_interpreter=CodeInterpreterToolResource(file_ids=list(self.file_ids)))
+        if self.file_ids:
+            return ToolResources(code_interpreter=CodeInterpreterToolResource(file_ids=list(self.file_ids)))
+        return ToolResources(
+            code_interpreter=CodeInterpreterToolResource(data_sources=list(self.data_sources.values()))
+        )
 
     def execute(self, tool_call: Any) -> Any:
         pass

sdk/ai/azure-ai-agents/azure_ai_agents_tests.env

@@ -21,3 +21,4 @@ AZURE_AI_AGENTS_TESTS_DEEP_RESEARCH_MODEL=
 AZURE_AI_AGENTS_TESTS_BING_CUSTOM_CONNECTION_ID=
 AZURE_AI_AGENTS_TESTS_BING_CONFIGURATION_NAME=
 AZURE_AI_AGENTS_TESTS_FABRIC_CONNECTION_ID=
+AZURE_AI_AGENTS_TESTS_SHAREPOINT_CONNECTION_ID=

sdk/ai/azure-ai-agents/cspell.json

@@ -16,6 +16,7 @@
       "oupfoo",
       "abcdabcdabcda",
       "abcdefghijklm",
+      "azureai"
     ],
     "ignorePaths": [
       "*.csv",

sdk/ai/azure-ai-agents/samples/agents_tools/sample_agents_browser_automation.py

@@ -22,10 +22,8 @@
        page of your Azure AI Foundry portal.
     2) MODEL_DEPLOYMENT_NAME - The deployment name of the AI model, as found under the "Name" column in
        the "Models + endpoints" tab in your Azure AI Foundry project.
-    3) AZURE_PLAYWRIGHT_CONNECTION_ID - The ID of the Azure Playwright Workspaces connection, in the format of:
-       /subscriptions/{subscription-id}/resourceGroups/{resource-group-name}/providers/Microsoft.MachineLearningServices/workspaces/{workspace-name}/connections/{connection-name}
-       You can also get the connection ID programmatically from AIProjectClient, using the call
-       `project_client.connections.get("<playwright-connection-name>").id`.
+    3) AZURE_PLAYWRIGHT_CONNECTION_NAME - The name of a connection to the Azure Playwright Workspace as it is
+       listed in Azure AI Foundry connected resources.
 """
 
 import os
@@ -41,7 +39,7 @@
 project_client = AIProjectClient(endpoint=os.environ["PROJECT_ENDPOINT"], credential=DefaultAzureCredential())
 
 # [START create_agent_with_browser_automation]
-connection_id = os.environ["AZURE_PLAYWRIGHT_CONNECTION_ID"]
+connection_id = project_client.connections.get(os.environ["AZURE_PLAYWRIGHT_CONNECTION_NAME"]).id
 
 # Initialize Browser Automation tool and add the connection id
 browser_automation = BrowserAutomationTool(connection_id=connection_id)