Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -91,7 +91,17 @@ Note:

---

## Step 5: Commit and push
## Step 5: Revert changes to file pyproject.toml

After the emit, there will be changes to `pyproject.toml` that are not needed. Revert any changes to `pyproject.toml` by running:

```
git restore pyproject.toml
```

---

## Step 6: Commit and push

Stage all changes (excluding file names that start with `.env`), commit, and push the topic branch:

Expand All @@ -105,7 +115,7 @@ git push -u origin <topic-branch>

---

## Step 6: Run post-emitter fixes
## Step 7: Run post-emitter fixes

After a successful emit, run the post-emitter fix script located in the `sdk/ai/azure-ai-projects` folder:

Expand All @@ -119,7 +129,7 @@ This script applies azure-ai-projects-specific corrections to the emitted code (

---

## Step 7: Commit and push
## Step 8: Commit and push

Stage all changes (excluding file names that start with `.env`), commit, and push the topic branch:

Expand All @@ -133,7 +143,7 @@ git push -u origin <topic-branch>

---

## Step 8: Fix patched code related to preview feature headers
## Step 9: Fix patched code related to preview feature headers

The emitted code may have introduced another beta sub-client (a new property on class `BetaOperations`). It may have also added another enum value to the existing internal class `_FoundryFeaturesOptInKeys`. This means that the client library needs to set a new HTTP request header when making REST API calls to the service, to opt-in to the new service features which are still in preview. If that's the case, do the following:

Expand All @@ -149,7 +159,7 @@ Important: Under the `azure\ai\projects` folder, you are only allowed to edit Py

---

## Step 9: Update samples and tests
## Step 10: Update samples and tests

If there were any breaking changes in existing APIs, like class or method renames:
* update the patched code accordingly in the client library to reflect those changes. Changes should be made to Python source file names that start with "_patch", under the `azure\ai\projects` folder.
Expand All @@ -158,13 +168,13 @@ If there were any breaking changes in existing APIs, like class or method rename

---

## Step 10: Install package from sources
## Step 11: Install package from sources

In the folder `sdk\ai\azure-ai-projects`, run `pip install -e .` to install the package from sources. If there are any errors, stop and report the error to the user. Do not continue.

---

## Step 11: Update CHANGELOG.md
## Step 12: Update CHANGELOG.md

Use the **`azsdk-common-generate-sdk-locally`** skill's changelog capability (`azsdk_package_update_changelog_content`) to update `CHANGELOG.md` in the `sdk/ai/azure-ai-projects` folder with a summary of changes from the TypeSpec emit. Some guidelines to follow:
* Start by examining the public SDK API surface of the latest released version of the azure-ai-projects package. The source code for this version can be found in the Main branch of the `azure-sdk-for-python` repository, in the folder `sdk\ai\azure-ai-projects`.
Expand All @@ -175,7 +185,7 @@ Use the **`azsdk-common-generate-sdk-locally`** skill's changelog capability (`a

---

## Step 12: Commit and push
## Step 13: Commit and push

Stage all changes (excluding file names that start with `.env`), commit, and push the topic branch:

Expand All @@ -189,7 +199,7 @@ git push -u origin <topic-branch>

---

## Step 13: Create a Pull Request
## Step 14: Create a Pull Request

Create a draft PR from the **topic branch** to the **base branch** (recorded in Step 2):

Expand All @@ -206,7 +216,7 @@ Open a new tab in the default browser and navigate to the PR URL.

---

## Step 14: Optionally run tests locally
## Step 15: Optionally run tests locally

Prompt the user with this message: "Tests will run as part of the Pull Request. However, you can optionally run tests locally in a Python virtual environment, right now. It will take a few minutes. Do you want to run tests locally? (yes/no)"

Expand Down
23 changes: 17 additions & 6 deletions sdk/ai/azure-ai-projects/CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,16 +1,25 @@
# Release History

## 2.3.0 (Unreleased)
## 2.2.0 (Unreleased)

### Features Added

* New Agent tool `FabricIQPreviewTool`.
* New Agent tool `ToolboxSearchPreviewTool`.
* New optional string properties `description` and `name` added to Agent tools which did not have them before.
* Support integration of external Agents (in preview). See new `ExternalAgentDefinition` class.
* New Agent tool in preview `FabricIQPreviewTool`.
Comment thread
dargilco marked this conversation as resolved.
* New Agent tool in preview `ToolboxSearchPreviewTool`.
* New optional string properties `description` and `name` added to Agent tools classes which did not have them before.
* New optional `tool_configs` added to Agent tool classes.
* New `.beta.datasets` sub-client with data generation job operations: `create_generation_job`, `get_generation_job`, `list_generation_jobs`, `cancel_generation_job`, `delete_generation_job`.
* New evaluator generation job operations on `.beta.evaluators`: `create_generation_job`, `get_generation_job`, `list_generation_jobs`, `cancel_generation_job`, `delete_generation_job`.
* New methods on `.beta.agents` sub-client for code-based hosted agents: `update_agent_from_code()`, `create_agent_version_from_code()`, `download_agent_version_code()`, `download_agent_code()`.
* New `.beta.models` sub-client to handle AI model weights: `list_versions`, `list`, `get`, `delete`, `update`, `create_async`, `pending_upload`, `get_credentials`.
* New `.beta.routines` sub-client with routine operations: `create_or_update`, `get`, `enable`, `disable`, `list`, `delete`, `list_runs`, `dispatch_async`.
* New methods on `.beta.evaluators` for evaluator generation jobs: `create_generation_job`, `get_generation_job`, `list_generation_jobs`, `cancel_generation_job`, `delete_generation_job`.
* New methods on `.beta.agents` for code-based hosted agents: `create_version_from_code`, `download_agent_code`.
* New methods on `.beta.agents` for optimization jobs: `create_optimization_job`, `get_optimization_job`, `list_optimization_jobs`, `cancel_optimization_job`, `list_optimization_candidates`.
* New methods on `.beta.memory_stores` to handle individual memory items:`.beta.memory_stores`: `get_memory`, `delete_memory`.
* New read-only property `content_hash` on `CodeConfiguration`, returning the SHA-256 hex digest of the uploaded code zip.
* New optional `force` parameter on `agents.delete` and `agents.delete_version` methods.
* New optional `blueprint_reference` parameters on `agents.create_version` method.


### Breaking Changes

Expand All @@ -27,6 +36,8 @@ Breaking changes in beta classes:
* Renamed class `SessionDirectoryListResponse` to `SessionDirectoryListResult`.
* Renamed class `SessionFileWriteResponse` to `SessionFileWriteResult`.
* Renamed class `SkillObject` to `SkillDetails`.
* Renamed class `Target` to `EvaluationTarget`.
* Renamed class `TargetConfig` to `RedTeamTargetConfig`.
* Removed class `FabricIQPreviewToolParameters`.
* Removed class `WorkIQPreviewToolParameters`.

Expand Down
Loading
Loading