Skip to content

Commit ceb4106

Browse files
committed
Update docs metadata
1 parent ef093e4 commit ceb4106

File tree

2 files changed

+16
-25
lines changed

2 files changed

+16
-25
lines changed

docs-ref-services/preview/ai-agents-readme.md

Lines changed: 12 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
11
---
22
title: Azure AI Agents client library for Python
33
keywords: Azure, python, SDK, API, azure-ai-agents, ai
4-
ms.date: 05/13/2025
4+
ms.date: 05/14/2025
55
ms.topic: reference
66
ms.devlang: python
77
ms.service: ai
88
---
99
<!-- PIPY LONG DESCRIPTION BEGIN -->
10-
# Azure AI Agents client library for Python - version 1.0.0b2
10+
# Azure AI Agents client library for Python - version 1.0.0b3
1111

1212

1313
Use the AI Agents client library (in preview) to:
@@ -380,9 +380,9 @@ for message in messages:
380380

381381
You can enhance your Agents by defining callback functions as function tools. These can be provided to `create_agent` via either the `toolset` parameter or the combination of `tools` and `tool_resources`. Here are the distinctions:
382382

383-
For more details about requirements and specification of functions, refer to [Function Tool Specifications](https://github.com/Azure/azure-sdk-for-python/blob/azure-ai-agents_1.0.0b2/sdk/ai/azure-ai-projects/FunctionTool.md)
383+
For more details about requirements and specification of functions, refer to [Function Tool Specifications](https://github.com/Azure/azure-sdk-for-python/blob/azure-ai-agents_1.0.0b3/sdk/ai/azure-ai-projects/FunctionTool.md)
384384

385-
Here is an example to use [user functions](https://github.com/Azure/azure-sdk-for-python/blob/azure-ai-agents_1.0.0b2/sdk/ai/azure-ai-projects/samples/agents/user_functions.py) in `toolset`:
385+
Here is an example to use [user functions](https://github.com/Azure/azure-sdk-for-python/blob/azure-ai-agents_1.0.0b3/sdk/ai/azure-ai-projects/samples/agents/user_functions.py) in `toolset`:
386386
<!-- SNIPPET:sample_agents_stream_eventhandler_with_toolset.create_agent_with_function_tool -->
387387

388388
```python
@@ -401,7 +401,7 @@ agent = agents_client.create_agent(
401401

402402
<!-- END SNIPPET -->
403403

404-
For asynchronous functions, you must import `AgentsClient` from `azure.ai.agents.aio` and use `AsyncFunctionTool`. Here is an example using [asynchronous user functions](https://github.com/Azure/azure-sdk-for-python/blob/azure-ai-agents_1.0.0b2/sdk/ai/azure-ai-projects/samples/agents/async_samples/user_async_functions.py):
404+
For asynchronous functions, you must import `AgentsClient` from `azure.ai.agents.aio` and use `AsyncFunctionTool`. Here is an example using [asynchronous user functions](https://github.com/Azure/azure-sdk-for-python/blob/azure-ai-agents_1.0.0b3/sdk/ai/azure-ai-projects/samples/agents/async_samples/user_async_functions.py):
405405

406406
```python
407407
from azure.ai.agents.aio import AgentsClient
@@ -426,8 +426,8 @@ agent = await agents_client.create_agent(
426426

427427
<!-- END SNIPPET -->
428428

429-
Notice that if `enable_auto_function_calls` is called, the SDK will invoke the functions automatically during `create_and_process` or streaming. If you prefer to execute them manually, refer to [`sample_agents_stream_eventhandler_with_functions.py`](https://github.com/Azure/azure-sdk-for-python/blob/azure-ai-agents_1.0.0b2/sdk/ai/azure-ai-projects/samples/agents/sample_agents_stream_eventhandler_with_functions.py) or
430-
[`sample_agents_functions.py`](https://github.com/Azure/azure-sdk-for-python/blob/azure-ai-agents_1.0.0b2/sdk/ai/azure-ai-projects/samples/agents/sample_agents_functions.py)
429+
Notice that if `enable_auto_function_calls` is called, the SDK will invoke the functions automatically during `create_and_process` or streaming. If you prefer to execute them manually, refer to [`sample_agents_stream_eventhandler_with_functions.py`](https://github.com/Azure/azure-sdk-for-python/blob/azure-ai-agents_1.0.0b3/sdk/ai/azure-ai-projects/samples/agents/sample_agents_stream_eventhandler_with_functions.py) or
430+
[`sample_agents_functions.py`](https://github.com/Azure/azure-sdk-for-python/blob/azure-ai-agents_1.0.0b3/sdk/ai/azure-ai-projects/samples/agents/sample_agents_functions.py)
431431

432432
### Create Agent With Azure Function Call
433433

@@ -892,7 +892,7 @@ message = agents_client.messages.create(
892892

893893
To process your message, you can use `runs.create`, `runs.create_and_process`, or `runs.stream`.
894894

895-
`create_run` requests the Agent to process the message without polling for the result. If you are using `function tools` regardless as `toolset` or not, your code is responsible for polling for the result and acknowledging the status of `Run`. When the status is `requires_action`, your code is responsible for calling the function tools. For a code sample, visit [`sample_agents_functions.py`](https://github.com/Azure/azure-sdk-for-python/blob/azure-ai-agents_1.0.0b2/sdk/ai/azure-ai-projects/samples/agents/sample_agents_functions.py).
895+
`create_run` requests the Agent to process the message without polling for the result. If you are using `function tools` regardless as `toolset` or not, your code is responsible for polling for the result and acknowledging the status of `Run`. When the status is `requires_action`, your code is responsible for calling the function tools. For a code sample, visit [`sample_agents_functions.py`](https://github.com/Azure/azure-sdk-for-python/blob/azure-ai-agents_1.0.0b3/sdk/ai/azure-ai-projects/samples/agents/sample_agents_functions.py).
896896

897897
Here is an example of `runs.create` and poll until the run is completed:
898898

@@ -1004,7 +1004,7 @@ with agents_client.runs.stream(thread_id=thread.id, agent_id=agent.id, event_han
10041004

10051005
<!-- END SNIPPET -->
10061006

1007-
As you can see, this SDK parses the events and produces various event types similar to OpenAI agents. In your use case, you might not be interested in handling all these types and may decide to parse the events on your own. To achieve this, please refer to [override base event handler](https://github.com/Azure/azure-sdk-for-python/blob/azure-ai-agents_1.0.0b2/sdk/ai/azure-ai-projects/samples/agents/sample_agents_stream_with_base_override_eventhandler.py).
1007+
As you can see, this SDK parses the events and produces various event types similar to OpenAI agents. In your use case, you might not be interested in handling all these types and may decide to parse the events on your own. To achieve this, please refer to [override base event handler](https://github.com/Azure/azure-sdk-for-python/blob/azure-ai-agents_1.0.0b3/sdk/ai/azure-ai-projects/samples/agents/sample_agents_stream_with_base_override_eventhandler.py).
10081008

10091009
```
10101010
Note: Multiple streaming processes may be chained behind the scenes.
@@ -1152,15 +1152,6 @@ from azure.monitor.opentelemetry import configure_azure_monitor
11521152
application_insights_connection_string = os.environ["APPLICATIONINSIGHTS_CONNECTION_STRING"]
11531153
configure_azure_monitor(connection_string=application_insights_connection_string)
11541154

1155-
try:
1156-
from azure.ai.agents.telemetry import AIAgentsInstrumentor
1157-
1158-
agents_instrumentor = AIAgentsInstrumentor()
1159-
if not agents_instrumentor.is_instrumented():
1160-
agents_instrumentor.instrument()
1161-
except Exception as exc: # pylint: disable=broad-exception-caught
1162-
print(f"Could not call `AIAgentsInstrumentor().instrument()`. Exception: {exc}")
1163-
11641155
scenario = os.path.basename(__file__)
11651156
tracer = trace.get_tracer(__name__)
11661157

@@ -1243,7 +1234,7 @@ To report an issue with the client library, or request additional features, plea
12431234

12441235
## Next steps
12451236

1246-
Have a look at the [Samples](https://github.com/Azure/azure-sdk-for-python/tree/azure-ai-agents_1.0.0b2/sdk/ai/azure-ai-projects/samples) folder, containing fully runnable Python code for synchronous and asynchronous clients.
1237+
Have a look at the [Samples](https://github.com/Azure/azure-sdk-for-python/tree/azure-ai-agents_1.0.0b3/sdk/ai/azure-ai-projects/samples) folder, containing fully runnable Python code for synchronous and asynchronous clients.
12471238

12481239
Explore the [AI Starter Template](https://aka.ms/azsdk/azure-ai-projects/python/ai-starter-template). This template creates an Azure AI Foundry hub, project and connected resources including Azure OpenAI Service, AI Search and more. It also deploys a simple chat application to Azure Container Apps.
12491240

@@ -1268,9 +1259,9 @@ additional questions or comments.
12681259
[samples]: https://aka.ms/azsdk/azure-ai-projects/python/samples/
12691260
[code_of_conduct]: https://opensource.microsoft.com/codeofconduct/
12701261
[entra_id]: https://learn.microsoft.com/azure/ai-services/authentication?tabs=powershell#authenticate-with-microsoft-entra-id
1271-
[azure_identity_credentials]: https://github.com/Azure/azure-sdk-for-python/tree/azure-ai-agents_1.0.0b2/sdk/identity/azure-identity#credentials
1262+
[azure_identity_credentials]: https://github.com/Azure/azure-sdk-for-python/tree/azure-ai-agents_1.0.0b3/sdk/identity/azure-identity#credentials
12721263
[azure_identity_pip]: https://pypi.org/project/azure-identity/
1273-
[default_azure_credential]: https://github.com/Azure/azure-sdk-for-python/tree/azure-ai-agents_1.0.0b2/sdk/identity/azure-identity#defaultazurecredential
1264+
[default_azure_credential]: https://github.com/Azure/azure-sdk-for-python/tree/azure-ai-agents_1.0.0b3/sdk/identity/azure-identity#defaultazurecredential
12741265
[pip]: https://pypi.org/project/pip/
12751266
[azure_sub]: https://azure.microsoft.com/free/
12761267
[evaluators]: https://learn.microsoft.com/azure/ai-studio/how-to/develop/evaluate-sdk

metadata/preview/azure-ai-agents.json

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"Name": "azure-ai-agents",
3-
"Version": "1.0.0b2",
3+
"Version": "1.0.0b3",
44
"DevVersion": null,
55
"DirectoryPath": "sdk/ai/azure-ai-agents",
66
"ServiceDirectory": "ai",
@@ -10,17 +10,17 @@
1010
"SdkType": "client",
1111
"IsNewSdk": true,
1212
"ArtifactName": "azure-ai-agents",
13-
"ReleaseStatus": "2025-05-13",
13+
"ReleaseStatus": "2025-05-14",
1414
"IncludedForValidation": false,
1515
"AdditionalValidationPackages": [
1616
""
1717
],
1818
"ArtifactDetails": {
1919
"safeName": "azureaiagents",
20+
"name": "azure-ai-agents",
2021
"triggeringPaths": [
2122
"/sdk/ai/ci.yml"
22-
],
23-
"name": "azure-ai-agents"
23+
]
2424
},
2525
"CIParameters": {
2626
"CIMatrixConfigs": []

0 commit comments

Comments
 (0)
pFad - Phonifier reborn

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.


Alternative Proxies:

Alternative Proxy

pFad Proxy

pFad v3 Proxy

pFad v4 Proxy