Changes for Beta 7 release of Python Azure AI Projects SDK (#39877)

* Set version to beta 7

* Fix deserialization of RunStepDeltaFileSearchToolCall. (#39798)

* Regeerate code and update tests

* Revert some changes

* Fix sanitizer to run the tests on vector store

* Fix

* Fix spelling

* run black and fix split chinese characters in streaming (#39826)

* Add support for URL citation, and use "agent_id" instead of "assistant_id" in public SDK APIs (wire protocol still uses "assistant_id") (#39822)

* Add convenience method to access URL citations on the ThreadMessage class

* Overload test and rebase (#39237)

* Set release date in CHANGELOG.md

* Update README for Azure Function (#39976)

* Update README for Azure Function

* Update comment on Role assignment in package README.md (#39984)

* Fix toc links on https://pypi.org/project/azure-ai-projects/. Add link to page talking about role assignments

* Revert TOC changes

* More

* tracing update to samples (#39986)

* tracing update to samples

* fixing async sample

* updating snippet

---------

Co-authored-by: Marko Hietala <[email protected]>

---------

Co-authored-by: Darren Cohen <[email protected]>
Co-authored-by: Nikolay Rovinskiy <[email protected]>
Co-authored-by: Jarno Hakulinen <[email protected]>
Co-authored-by: M-Hietala <[email protected]>
Co-authored-by: Marko Hietala <[email protected]>

Author: 6 people

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

@@ -1,5 +1,26 @@
 # Release History
 
+## 1.0.0b7 (2025-03-06)
+
+### Features added
+
+* Add support for parsing URL citations in Agent text messages. See new classes `MessageTextUrlCitationAnnotation` and `MessageDeltaTextUrlCitationAnnotation`.
+* Add enum value `ConnectionType.API_KEY` to support enumeration of generic connections that uses API Key authentication.
+
+### Sample updates
+
+* Update sample `sample_agents_bing_grounding.py` with printout of URL citation.
+* Add new samples `sample_agents_stream_eventhandler_with_bing_grounding.py` and `sample_agents_stream_iteration_with_bing_grounding.py` with printout of URL citation.
+
+### Bugs Fixed
+
+* Fix a bug in deserialization of `RunStepDeltaFileSearchToolCall` returned during Agent streaming (see [GitHub issue 48333](https://github.com/Azure/azure-sdk-for-net/issues/48333)).
+* Fix for Exception raised while parsing Agent streaming response, in some rare cases, for multibyte UTF-8 languages like Chinese.
+
+### Breaking Changes
+
+* Rename input argument `assistant_id` to `agent_id` in all Agent methods to align with the "Agent" terminology. Similarly, rename all `assistant_id` properties on classes.
+
 ## 1.0.0b6 (2025-02-14)
 
 ### Features added

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

@@ -2,5 +2,5 @@
   "AssetsRepo": "Azure/azure-sdk-assets",
   "AssetsRepoPrefixPath": "python",
   "TagPrefix": "python/ai/azure-ai-projects",
-  "Tag": "python/ai/azure-ai-projects_85b26dc606"
+  "Tag": "python/ai/azure-ai-projects_04dc35e78c"
 }

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

@@ -1,3 +1,4 @@
+# pylint: disable=line-too-long,useless-suppression
 # coding=utf-8
 # --------------------------------------------------------------------------
 # Copyright (c) Microsoft Corporation. All rights reserved.
@@ -62,7 +63,7 @@ def __init__(
         credential: "TokenCredential",
         **kwargs: Any
     ) -> None:
-        _endpoint = "{endpoint}/agents/v1.0/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{projectName}"  # pylint: disable=line-too-long
+        _endpoint = "{endpoint}/agents/v1.0/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{projectName}"
         self._config = AIProjectClientConfiguration(
             endpoint=endpoint,
             subscription_id=subscription_id,

sdk/ai/azure-ai-projects/azure/ai/projects/_client.py

@@ -1,3 +1,4 @@
+# pylint: disable=line-too-long,useless-suppression
 # ------------------------------------
 # Copyright (c) Microsoft Corporation.
 # Licensed under the MIT License.

sdk/ai/azure-ai-projects/azure/ai/projects/_patch.py

@@ -1,4 +1,4 @@
-# pylint: disable=too-many-lines
+# pylint: disable=line-too-long,useless-suppression,too-many-lines
 # --------------------------------------------------------------------------
 #
 # Copyright (c) Microsoft Corporation. All rights reserved.
@@ -1361,7 +1361,7 @@ def xml_key_extractor(attr, attr_desc, data):  # pylint: disable=unused-argument
         # Iter and wrapped, should have found one node only (the wrap one)
         if len(children) != 1:
             raise DeserializationError(
-                "Tried to deserialize an array not wrapped, and found several nodes '{}'. Maybe you should declare this array as wrapped?".format(  # pylint: disable=line-too-long
+                "Tried to deserialize an array not wrapped, and found several nodes '{}'. Maybe you should declare this array as wrapped?".format(
                     xml_name
                 )
             )

sdk/ai/azure-ai-projects/azure/ai/projects/_serialization.py

@@ -6,4 +6,4 @@
 # Changes may cause incorrect behavior and will be lost if the code is regenerated.
 # --------------------------------------------------------------------------
 
-VERSION = "1.0.0b6"
+VERSION = "1.0.0b7"

sdk/ai/azure-ai-projects/azure/ai/projects/_version.py

@@ -1,3 +1,4 @@
+# pylint: disable=line-too-long,useless-suppression
 # coding=utf-8
 # --------------------------------------------------------------------------
 # Copyright (c) Microsoft Corporation. All rights reserved.
@@ -62,7 +63,7 @@ def __init__(
         credential: "AsyncTokenCredential",
         **kwargs: Any
     ) -> None:
-        _endpoint = "{endpoint}/agents/v1.0/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{projectName}"  # pylint: disable=line-too-long
+        _endpoint = "{endpoint}/agents/v1.0/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{projectName}"
         self._config = AIProjectClientConfiguration(
             endpoint=endpoint,
             subscription_id=subscription_id,

sdk/ai/azure-ai-projects/azure/ai/projects/aio/_client.py

@@ -1,3 +1,4 @@
+# pylint: disable=line-too-long,useless-suppression
 # ------------------------------------
 # Copyright (c) Microsoft Corporation.
 # Licensed under the MIT License.

sdk/ai/azure-ai-projects/azure/ai/projects/aio/_patch.py

@@ -1,4 +1,4 @@
-# pylint: disable=too-many-lines
+# pylint: disable=line-too-long,useless-suppression,too-many-lines
 # coding=utf-8
 # --------------------------------------------------------------------------
 # Copyright (c) Microsoft Corporation. All rights reserved.
@@ -449,11 +449,11 @@ async def list_agents(
         return deserialized  # type: ignore
 
     @distributed_trace_async
-    async def get_agent(self, assistant_id: str, **kwargs: Any) -> _models.Agent:
+    async def get_agent(self, agent_id: str, **kwargs: Any) -> _models.Agent:
         """Retrieves an existing agent.
 
-        :param assistant_id: Identifier of the agent. Required.
-        :type assistant_id: str
+        :param agent_id: Identifier of the agent. Required.
+        :type agent_id: str
         :return: Agent. The Agent is compatible with MutableMapping
         :rtype: ~azure.ai.projects.models.Agent
         :raises ~azure.core.exceptions.HttpResponseError:
@@ -472,7 +472,7 @@ async def get_agent(self, assistant_id: str, **kwargs: Any) -> _models.Agent:
         cls: ClsType[_models.Agent] = kwargs.pop("cls", None)
 
         _request = build_agents_get_agent_request(
-            assistant_id=assistant_id,
+            agent_id=agent_id,
             api_version=self._config.api_version,
             headers=_headers,
             params=_params,
@@ -516,7 +516,7 @@ async def get_agent(self, assistant_id: str, **kwargs: Any) -> _models.Agent:
     @overload
     async def update_agent(
         self,
-        assistant_id: str,
+        agent_id: str,
         *,
         content_type: str = "application/json",
         model: Optional[str] = None,
@@ -533,8 +533,8 @@ async def update_agent(
     ) -> _models.Agent:
         """Modifies an existing agent.
 
-        :param assistant_id: The ID of the agent to modify. Required.
-        :type assistant_id: str
+        :param agent_id: The ID of the agent to modify. Required.
+        :type agent_id: str
         :keyword content_type: Body Parameter content-type. Content type parameter for JSON body.
          Default value is "application/json".
         :paramtype content_type: str
@@ -584,12 +584,12 @@ async def update_agent(
 
     @overload
     async def update_agent(
-        self, assistant_id: str, body: JSON, *, content_type: str = "application/json", **kwargs: Any
+        self, agent_id: str, body: JSON, *, content_type: str = "application/json", **kwargs: Any
     ) -> _models.Agent:
         """Modifies an existing agent.
 
-        :param assistant_id: The ID of the agent to modify. Required.
-        :type assistant_id: str
+        :param agent_id: The ID of the agent to modify. Required.
+        :type agent_id: str
         :param body: Required.
         :type body: JSON
         :keyword content_type: Body Parameter content-type. Content type parameter for JSON body.
@@ -602,12 +602,12 @@ async def update_agent(
 
     @overload
     async def update_agent(
-        self, assistant_id: str, body: IO[bytes], *, content_type: str = "application/json", **kwargs: Any
+        self, agent_id: str, body: IO[bytes], *, content_type: str = "application/json", **kwargs: Any
     ) -> _models.Agent:
         """Modifies an existing agent.
 
-        :param assistant_id: The ID of the agent to modify. Required.
-        :type assistant_id: str
+        :param agent_id: The ID of the agent to modify. Required.
+        :type agent_id: str
         :param body: Required.
         :type body: IO[bytes]
         :keyword content_type: Body Parameter content-type. Content type parameter for binary body.
@@ -621,7 +621,7 @@ async def update_agent(
     @distributed_trace_async
     async def update_agent(
         self,
-        assistant_id: str,
+        agent_id: str,
         body: Union[JSON, IO[bytes]] = _Unset,
         *,
         model: Optional[str] = None,
@@ -638,8 +638,8 @@ async def update_agent(
     ) -> _models.Agent:
         """Modifies an existing agent.
 
-        :param assistant_id: The ID of the agent to modify. Required.
-        :type assistant_id: str
+        :param agent_id: The ID of the agent to modify. Required.
+        :type agent_id: str
         :param body: Is either a JSON type or a IO[bytes] type. Required.
         :type body: JSON or IO[bytes]
         :keyword model: The ID of the model to use. Default value is None.
@@ -721,7 +721,7 @@ async def update_agent(
             _content = json.dumps(body, cls=SdkJSONEncoder, exclude_readonly=True)  # type: ignore
 
         _request = build_agents_update_agent_request(
-            assistant_id=assistant_id,
+            agent_id=agent_id,
             content_type=content_type,
             api_version=self._config.api_version,
             content=_content,
@@ -765,11 +765,11 @@ async def update_agent(
         return deserialized  # type: ignore
 
     @distributed_trace_async
-    async def delete_agent(self, assistant_id: str, **kwargs: Any) -> _models.AgentDeletionStatus:
+    async def delete_agent(self, agent_id: str, **kwargs: Any) -> _models.AgentDeletionStatus:
         """Deletes an agent.
 
-        :param assistant_id: Identifier of the agent. Required.
-        :type assistant_id: str
+        :param agent_id: Identifier of the agent. Required.
+        :type agent_id: str
         :return: AgentDeletionStatus. The AgentDeletionStatus is compatible with MutableMapping
         :rtype: ~azure.ai.projects.models.AgentDeletionStatus
         :raises ~azure.core.exceptions.HttpResponseError:
@@ -788,7 +788,7 @@ async def delete_agent(self, assistant_id: str, **kwargs: Any) -> _models.AgentD
         cls: ClsType[_models.AgentDeletionStatus] = kwargs.pop("cls", None)
 
         _request = build_agents_delete_agent_request(
-            assistant_id=assistant_id,
+            agent_id=agent_id,
             api_version=self._config.api_version,
             headers=_headers,
             params=_params,
@@ -1825,7 +1825,7 @@ async def create_run(
         self,
         thread_id: str,
         *,
-        assistant_id: str,
+        agent_id: str,
         include: Optional[List[Union[str, _models.RunAdditionalFieldList]]] = None,
         content_type: str = "application/json",
         model: Optional[str] = None,
@@ -1849,8 +1849,8 @@ async def create_run(
 
         :param thread_id: Identifier of the thread. Required.
         :type thread_id: str
-        :keyword assistant_id: The ID of the agent that should run the thread. Required.
-        :paramtype assistant_id: str
+        :keyword agent_id: The ID of the agent that should run the thread. Required.
+        :paramtype agent_id: str
         :keyword include: A list of additional fields to include in the response.
          Currently the only supported value is
          ``step_details.tool_calls[*].file_search.results[*].content`` to fetch the file search result
@@ -1997,7 +1997,7 @@ async def create_run(
         thread_id: str,
         body: Union[JSON, IO[bytes]] = _Unset,
         *,
-        assistant_id: str = _Unset,
+        agent_id: str = _Unset,
         include: Optional[List[Union[str, _models.RunAdditionalFieldList]]] = None,
         model: Optional[str] = None,
         instructions: Optional[str] = None,
@@ -2022,8 +2022,8 @@ async def create_run(
         :type thread_id: str
         :param body: Is either a JSON type or a IO[bytes] type. Required.
         :type body: JSON or IO[bytes]
-        :keyword assistant_id: The ID of the agent that should run the thread. Required.
-        :paramtype assistant_id: str
+        :keyword agent_id: The ID of the agent that should run the thread. Required.
+        :paramtype agent_id: str
         :keyword include: A list of additional fields to include in the response.
          Currently the only supported value is
          ``step_details.tool_calls[*].file_search.results[*].content`` to fetch the file search result
@@ -2117,12 +2117,12 @@ async def create_run(
         cls: ClsType[_models.ThreadRun] = kwargs.pop("cls", None)
 
         if body is _Unset:
-            if assistant_id is _Unset:
-                raise TypeError("missing required argument: assistant_id")
+            if agent_id is _Unset:
+                raise TypeError("missing required argument: agent_id")
             body = {
                 "additional_instructions": additional_instructions,
                 "additional_messages": additional_messages,
-                "assistant_id": assistant_id,
+                "assistant_id": agent_id,
                 "instructions": instructions,
                 "max_completion_tokens": max_completion_tokens,
                 "max_prompt_tokens": max_prompt_tokens,
@@ -2767,7 +2767,7 @@ async def cancel_run(self, thread_id: str, run_id: str, **kwargs: Any) -> _model
     async def create_thread_and_run(
         self,
         *,
-        assistant_id: str,
+        agent_id: str,
         content_type: str = "application/json",
         thread: Optional[_models.AgentThreadCreationOptions] = None,
         model: Optional[str] = None,
@@ -2788,8 +2788,8 @@ async def create_thread_and_run(
     ) -> _models.ThreadRun:
         """Creates a new agent thread and immediately starts a run using that new thread.
 
-        :keyword assistant_id: The ID of the agent for which the thread should be created. Required.
-        :paramtype assistant_id: str
+        :keyword agent_id: The ID of the agent for which the thread should be created. Required.
+        :paramtype agent_id: str
         :keyword content_type: Body Parameter content-type. Content type parameter for JSON body.
          Default value is "application/json".
         :paramtype content_type: str
@@ -2903,7 +2903,7 @@ async def create_thread_and_run(
         self,
         body: Union[JSON, IO[bytes]] = _Unset,
         *,
-        assistant_id: str = _Unset,
+        agent_id: str = _Unset,
         thread: Optional[_models.AgentThreadCreationOptions] = None,
         model: Optional[str] = None,
         instructions: Optional[str] = None,
@@ -2925,8 +2925,8 @@ async def create_thread_and_run(
 
         :param body: Is either a JSON type or a IO[bytes] type. Required.
         :type body: JSON or IO[bytes]
-        :keyword assistant_id: The ID of the agent for which the thread should be created. Required.
-        :paramtype assistant_id: str
+        :keyword agent_id: The ID of the agent for which the thread should be created. Required.
+        :paramtype agent_id: str
         :keyword thread: The details used to create the new thread. If no thread is provided, an empty
          one will be created. Default value is None.
         :paramtype thread: ~azure.ai.projects.models.AgentThreadCreationOptions
@@ -3014,10 +3014,10 @@ async def create_thread_and_run(
         cls: ClsType[_models.ThreadRun] = kwargs.pop("cls", None)
 
         if body is _Unset:
-            if assistant_id is _Unset:
-                raise TypeError("missing required argument: assistant_id")
+            if agent_id is _Unset:
+                raise TypeError("missing required argument: agent_id")
             body = {
-                "assistant_id": assistant_id,
+                "assistant_id": agent_id,
                 "instructions": instructions,
                 "max_completion_tokens": max_completion_tokens,
                 "max_prompt_tokens": max_prompt_tokens,
@@ -5144,7 +5144,8 @@ async def _list_connections(
         """List the details of all the connections (not including their credentials).
 
         :keyword category: Category of the workspace connection. Known values are: "AzureOpenAI",
-         "Serverless", "AzureBlob", "AIServices", and "CognitiveSearch". Default value is None.
+         "Serverless", "AzureBlob", "AIServices", "CognitiveSearch", and "API Key". Default value is
+         None.
         :paramtype category: str or ~azure.ai.projects.models.ConnectionType
         :keyword include_all: Indicates whether to list datastores. Service default: do not list
          datastores. Default value is None.
@@ -5404,7 +5405,6 @@ def __init__(self, *args, **kwargs) -> None:
     async def _get_app_insights(
         self, app_insights_resource_url: str, **kwargs: Any
     ) -> _models._models.GetAppInsightsResponse:
-        # pylint: disable=line-too-long
         """Gets the properties of the specified Application Insights resource.
 
         :param app_insights_resource_url: The AppInsights Azure resource Url. It should have the