Feature/azure ai agents v1

eng/.docsettings.yml

@@ -14,6 +14,7 @@ omitted_paths:
   - sdk/**/swagger/*
   - sdk/ml/azure-ai-ml/tests/*
   - sdk/vision/azure-ai-vision-imageanalysis/tests/*
+  - sdk/ai/azure-ai-agents/tests/*
   - sdk/ai/azure-ai-inference/tests/*
   - sdk/ai/azure-ai-projects/tests/*
   - sdk/storage/azure-storage-extensions/*

pylintrc

@@ -8,6 +8,7 @@ ignore-paths=
     azure\\mixedreality\\remoterendering\\_api_version.py,
     azure/mixedreality/remoterendering/_api_version.py,
     (?:.*[/\\]|^)projects/(models/_models.py|_model_base.py|operations/_operations.py|aio/operations/_operations.py)$,
+    (?:.*[/\\]|^)agents/(models/_models.py|_model_base.py|operations/_operations.py|aio/operations/_operations.py)$,
     # Exclude any path that contains the following directory names
     (?:.*[/\\]|^)(?:_vendor|_generated|_restclient|samples|examples|test|tests|doc|\.tox)(?:[/\\]|$)
 

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

@@ -0,0 +1,7 @@
+# Release History
+
+## 1.0.0b1 (Unreleased)
+
+### Features Added
+
+- Initial version

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

@@ -0,0 +1,101 @@
+# FunctionTool Specifications
+
+FunctionTool is the utility allowing developers to provide functions within their code and invoke during streaming or running.   
+
+## Example of Function
+
+Here is an example of a function:
+```python
+def fetch_weather(location: str) -> str:
+    """
+    Fetches the weather information for the specified location.
+
+    :param location (str): The location to fetch weather for.
+    :return: Weather information as a JSON string.
+    :rtype: str
+    """
+    # In a real-world scenario, you'd integrate with a weather API.
+    mock_weather_data = {"New York": "Sunny, 25°C", "London": "Cloudy, 18°C", "Tokyo": "Rainy, 22°C"}
+    weather = mock_weather_data.get(location, "Weather data not available for this location.")
+    weather_json = json.dumps({"weather": weather})
+    return weather_json
+```
+
+Here is an example to attach this function definition to create_agent
+
+```python
+functions = FunctionTool({fetch_weather})
+
+agent = agents_client.create_agent(
+    model=os.environ["MODEL_DEPLOYMENT_NAME"],
+    name="my-assistant",
+    instructions="You are a helpful assistant",
+    tools=functions.definitions,
+)
+```
+
+To verify that the SDK parsed the docstring properly, you can print the definition:
+
+```python
+[print(json.dumps(tool.as_dict(), indent=4)) for tool in functions.definitions]
+```
+
+Alternatively user can check the tools property in newly created agent:
+
+```python
+[print(json.dumps(tool.as_dict(), indent=4)) for tool in agent.tools if tool.type == "function"]
+```
+
+The terminal will display the definition as below:
+
+```json
+[
+    {
+        "type": "function",
+        "function": {
+            "name": "fetch_weather",
+            "description": "Fetches the weather information for the specified location.",
+            "parameters": {
+                "type": "object",
+                "properties": {
+                    "location": {
+                        "type": "string",
+                        "description": "The location to fetch weather for."
+                    }
+                },
+                "required": [
+                    "location"
+                ]
+            }
+        }
+    }
+]
+```
+
+## Requirements for FunctionTool
+
+To ensure `FunctionTool` operates correctly and generates accurate function definitions that agents can reliably call, adhere to the following standards:
+
+1. **Type Annotations**
+   - All function parameters and return types should be explicitly type-annotated using Python's type hinting.
+
+2. **Structured Docstrings**
+   - Utilize a consistent docstring format similar to the example above (see also related agent samples in this repository).
+   - Include clear descriptions for each function and parameter.
+
+3. **Supported Types**
+
+    `FunctionTool` maps common Python types to their JSON Schema equivalents, ensuring accurate representation without complex type details:
+
+   - **Strings and Numbers**
+     - `str` → `string`
+     - `int` → `integer`
+     - `float` → `number`
+     - `bool` → `boolean`
+
+   - **Collections**
+     - `list` → `array`
+     - `dict` → `object`
+
+   - **Nullable Types**
+     - `Optional[type]` includes `null`

sdk/ai/azure-ai-agents/LICENSE

@@ -0,0 +1,21 @@
+Copyright (c) Microsoft Corporation.
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED *AS IS*, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

sdk/ai/azure-ai-agents/MANIFEST.in

@@ -0,0 +1,7 @@
+include *.md
+include LICENSE
+include azure/ai/agents/py.typed
+recursive-include tests *.py
+recursive-include samples *.py *.md
+include azure/__init__.py
+include azure/ai/__init__.py