Skip to content

Commit 4378d83

Browse files
authored
Update pacakge README.md (#47790)
Also rename tsp-location.yaml to tsp-location.yaml.saved since the commit hash there is not from the Main branch, which will fail the release pipeline. Also replace term "isolation key" with correct term in emitted doc string. I will do a similar TypeSpec change.
1 parent f4d7bc2 commit 4378d83

4 files changed

Lines changed: 24 additions & 18 deletions

File tree

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

Lines changed: 16 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -3,15 +3,16 @@
33
The AI Projects client library is part of the Microsoft Foundry SDK, and provides easy access to
44
resources in your [Microsoft Foundry](https://ai.azure.com/) Project. Use it to:
55

6-
* **Create and run Agents** using methods on the `.agents` client property. This includes **Hosted Agents** (Preview), which let you run your own containerized agent runtime while using Microsoft Foundry for managed hosting and scaling.
7-
* **Enhance Agents with specialized tools**:
6+
* **Create and run Agents** using methods on the `.agents` client property. This includes **Hosted Agents**, which let you run your own containerized agent runtime while using Microsoft Foundry for managed hosting and scaling.
7+
* **Enhance Agents with specialized tools and toolbox tools** such as:
88
* Agent-to-Agent (A2A) (Preview)
99
* Azure AI Search
1010
* Azure Functions
1111
* Bing Custom Search (Preview)
1212
* Bing Grounding
1313
* Browser Automation (Preview)
1414
* Code Interpreter
15+
* Computer
1516
* Computer Use (Preview)
1617
* Fabric IQ (Preview)
1718
* File Search
@@ -22,11 +23,13 @@ resources in your [Microsoft Foundry](https://ai.azure.com/) Project. Use it to:
2223
* Microsoft SharePoint (Preview)
2324
* Model Context Protocol (MCP)
2425
* OpenAPI
26+
* Reminder Tool (Preview)
2527
* Toolbox Search (Preview)
2628
* Web Search
2729
* Web Search (Preview)
2830
* Work IQ (Preview)
2931
* **Get an OpenAI client** using `.get_openai_client()` method to run Responses, Conversations, Evaluations and Fine-Tuning operations with your Agent.
32+
* **Create and version toolboxes** that bundle collections of tools and skills for your agents, using `.toolboxes` operations.
3033
* **Fine-tune** AI Models on your data.
3134
* **Enumerate AI Models** deployed to your Foundry Project using `.deployments` operations.
3235
* **Enumerate connected Azure resources** in your Foundry project using `.connections` operations.
@@ -39,7 +42,8 @@ resources in your [Microsoft Foundry](https://ai.azure.com/) Project. Use it to:
3942
* **Run Red Team scans (preview)** to identify risks associated with your generative AI application, using `.beta.red_teams` operations.
4043
* **Create and manage routines (preview)** that execute triggered actions based on configured conditions, using `.beta.routines` operations.
4144
* **Manage skills (preview)** as reusable capabilities that can be included in toolboxes and agents, using `.beta.skills` operations.
42-
* **Create and version toolboxes (preview)** that bundle collections of tools and skills for your agents, using `.beta.toolboxes` operations.
45+
46+
**Important:** This stable package includes Preview features. Preview features available through stable methods require setting `allow_preview=True` when constructing the client, while Preview features exposed via the .beta sub-clients do not. Preview features may change or be removed in future versions and are not recommended for production use.
4347

4448
The client library uses version `v1` of the Microsoft Foundry [data plane REST APIs](https://aka.ms/azsdk/azure-ai-projects-v2/api-reference-v1).
4549

@@ -74,7 +78,7 @@ To report an issue with the client library, or request additional features, plea
7478
pip install azure-ai-projects
7579
```
7680

77-
Verify that you have version 2.2.0 or above installed by running:
81+
Verify that you have version 2.3.0 or above installed by running:
7882

7983
```bash
8084
pip show azure-ai-projects
@@ -167,23 +171,25 @@ The table below lists the operation groups supported by the client library, with
167171
| Topic | Foundry documentation | Samples folder |
168172
|---|---|---|
169173
| Agents (create, run, stream) | [Agents overview](https://learn.microsoft.com/azure/foundry/agents/overview) | `samples/agents/` |
170-
| Hosted agents (preview) | [Hosted agents concepts](https://learn.microsoft.com/azure/foundry/agents/concepts/hosted-agents), [Deploy your first hosted agent](https://learn.microsoft.com/azure/foundry/agents/quickstarts/quickstart-hosted-agent) | `samples/hosted_agents/` |
174+
| Hosted agents | [Hosted agents concepts](https://learn.microsoft.com/azure/foundry/agents/concepts/hosted-agents), [Deploy your first hosted agent](https://learn.microsoft.com/azure/foundry/agents/quickstarts/quickstart-hosted-agent) | `samples/hosted_agents/` |
171175
| Agents tools | [Tool catalog](https://learn.microsoft.com/azure/foundry/agents/concepts/tool-catalog) | `samples/agents/tools/` |
172-
| Agents optimization | | `samples/agents/optimization/` |
176+
| Agents optimization | [Prompt optimizer](https://learn.microsoft.com/azure/foundry/observability/how-to/prompt-optimizer), [Agent optimizer overview](https://learn.microsoft.com/azure/foundry/agents/concepts/agent-optimizer-overview) | `samples/agents/optimization/` |
173177
| Connections | [Add a new connection to your project](https://learn.microsoft.com/azure/foundry/how-to/connections-add?tabs=foundry-portal)| `samples/connections/` |
178+
| Client-side tracing | [Add client-side tracing to Foundry agents](https://learn.microsoft.com/azure/foundry/observability/how-to/trace-agent-client-side?tabs=python) | `samples/telemetry/` |
174179
| Datasets | | `samples/datasets/` |
175180
| Deployments | [Deployment types](https://learn.microsoft.com/azure/foundry/foundry-models/concepts/deployment-types) | `samples/deployments/` |
176181
| Evaluation | [Evaluate agents](https://learn.microsoft.com/azure/foundry/observability/how-to/evaluate-agent) | `samples/evaluations/` |
177182
| Files (upload, retrieve, list, delete) | [OpenAI Files API](https://platform.openai.com/docs/api-reference/files) | `samples/files/` |
178183
| Fine-tuning | [When to use fine-tuning](https://learn.microsoft.com/azure/foundry/openai/concepts/fine-tuning-considerations), [Fine-Tuning in AI Foundry (GitHub repo)](https://github.com/microsoft-foundry/fine-tuning) | `samples/finetuning/` |
179184
| Indexes | [Azure AI Search](https://learn.microsoft.com/azure/search/search-what-is-azure-search) | `samples/indexes/` |
180-
| Memory stores (preview) | | `samples/memories/` |
185+
| Memory stores (preview) | [What is memory?](https://learn.microsoft.com/azure/foundry/agents/concepts/what-is-memory?tabs=conversational-agent) | `samples/memories/` |
181186
| Models (preview) | | `samples/models/` |
182187
| Red teams (preview) | | `samples/red_team/` |
183188
| Responses | [Responses API](https://platform.openai.com/docs/api-reference/responses) | `samples/responses/` |
184-
| Routines (preview) | | |
185-
| Skills (preview) | | `samples/hosted_agents/` |
186-
| Toolboxes (preview) | [Curate intent-based toolbox in Foundry](https://learn.microsoft.com/azure/foundry/agents/how-to/tools/toolbox?pivots=python) | `samples/hosted_agents/` |
189+
| Routines (preview) | [Routines overview](https://learn.microsoft.com/azure/foundry/agents/concepts/routines) | `samples/routines/` |
190+
| Sessions | [Manage hosted sessions](https://learn.microsoft.com/azure/foundry/agents/how-to/manage-hosted-sessions?pivots=python) | `samples/hosted_agents/` |
191+
| Skills (preview) | | `samples/skills/` |
192+
| Toolboxes | [Curate intent-based toolbox in Foundry](https://learn.microsoft.com/azure/foundry/agents/how-to/tools/toolbox?pivots=python) | `samples/hosted_agents/`, `samples/toolboxes/` |
187193

188194

189195
## Client-side tracing

sdk/ai/azure-ai-projects/azure/ai/projects/aio/operations/_operations.py

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1640,7 +1640,7 @@ async def create_session(
16401640
"""Create a session.
16411641

16421642
Creates a new session for an agent endpoint. The endpoint resolves the backing agent version
1643-
from ``version_indicator`` and enforces session ownership using the provided isolation key for
1643+
from ``version_indicator`` and enforces session ownership using the provided user identity for
16441644
session-mutating operations.
16451645

16461646
:param agent_name: The name of the agent to create a session for. Required.
@@ -1665,7 +1665,7 @@ async def create_session(
16651665
"""Create a session.
16661666

16671667
Creates a new session for an agent endpoint. The endpoint resolves the backing agent version
1668-
from ``version_indicator`` and enforces session ownership using the provided isolation key for
1668+
from ``version_indicator`` and enforces session ownership using the provided user identity for
16691669
session-mutating operations.
16701670

16711671
:param agent_name: The name of the agent to create a session for. Required.
@@ -1687,7 +1687,7 @@ async def create_session(
16871687
"""Create a session.
16881688

16891689
Creates a new session for an agent endpoint. The endpoint resolves the backing agent version
1690-
from ``version_indicator`` and enforces session ownership using the provided isolation key for
1690+
from ``version_indicator`` and enforces session ownership using the provided user identity for
16911691
session-mutating operations.
16921692

16931693
:param agent_name: The name of the agent to create a session for. Required.
@@ -1715,7 +1715,7 @@ async def create_session(
17151715
"""Create a session.
17161716

17171717
Creates a new session for an agent endpoint. The endpoint resolves the backing agent version
1718-
from ``version_indicator`` and enforces session ownership using the provided isolation key for
1718+
from ``version_indicator`` and enforces session ownership using the provided user identity for
17191719
session-mutating operations.
17201720

17211721
:param agent_name: The name of the agent to create a session for. Required.

sdk/ai/azure-ai-projects/azure/ai/projects/operations/_operations.py

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -5060,7 +5060,7 @@ def create_session(
50605060
"""Create a session.
50615061

50625062
Creates a new session for an agent endpoint. The endpoint resolves the backing agent version
5063-
from ``version_indicator`` and enforces session ownership using the provided isolation key for
5063+
from ``version_indicator`` and enforces session ownership using the provided user identity for
50645064
session-mutating operations.
50655065

50665066
:param agent_name: The name of the agent to create a session for. Required.
@@ -5085,7 +5085,7 @@ def create_session(
50855085
"""Create a session.
50865086

50875087
Creates a new session for an agent endpoint. The endpoint resolves the backing agent version
5088-
from ``version_indicator`` and enforces session ownership using the provided isolation key for
5088+
from ``version_indicator`` and enforces session ownership using the provided user identity for
50895089
session-mutating operations.
50905090

50915091
:param agent_name: The name of the agent to create a session for. Required.
@@ -5107,7 +5107,7 @@ def create_session(
51075107
"""Create a session.
51085108

51095109
Creates a new session for an agent endpoint. The endpoint resolves the backing agent version
5110-
from ``version_indicator`` and enforces session ownership using the provided isolation key for
5110+
from ``version_indicator`` and enforces session ownership using the provided user identity for
51115111
session-mutating operations.
51125112

51135113
:param agent_name: The name of the agent to create a session for. Required.
@@ -5135,7 +5135,7 @@ def create_session(
51355135
"""Create a session.
51365136

51375137
Creates a new session for an agent endpoint. The endpoint resolves the backing agent version
5138-
from ``version_indicator`` and enforces session ownership using the provided isolation key for
5138+
from ``version_indicator`` and enforces session ownership using the provided user identity for
51395139
session-mutating operations.
51405140

51415141
:param agent_name: The name of the agent to create a session for. Required.
File renamed without changes.

0 commit comments

Comments
 (0)