|
1 | 1 | # Release History |
2 | 2 |
|
3 | | -## 2.3.0 (Unreleased) |
| 3 | +## 2.3.0 (2026-07-01) |
4 | 4 |
|
5 | 5 | ### Features Added |
6 | 6 |
|
7 | | -* Two new methods `enable` and `disable` on the `.agents` subclient. |
8 | | -* New Agent tool type `REMINDER_PREVIEW`. |
9 | | -* Hosted agents are now stable. There is no need to set `allow_preview=True` on the `AIProjectClient` constructor to create a Hosted agent. |
10 | | -* Toolboxes operations are now stable. The have moved from `.beta.toolboxes` subclient to the `.toolboxes` subclient. |
11 | | -* Session and Session files operations are now stable. They have moved from the `.beta.agents` subclient to the `.agents` subclient. |
12 | | -* Agent code operations are now stable. This includes `create_version_from_code` and `download_code`. They have moved from the `.beta.agents` subclient to the `.agents` subclient. |
| 7 | +* Hosted Agent methods are now stable. There is no need to set `allow_preview=True` on the `AIProjectClient` constructor to create a Hosted Agent. |
| 8 | +* Session and Session Files methods are now stable. They have moved from the `.beta.agents` subclient to the `.agents` subclient. |
| 9 | +* Agent code methods are now stable. This includes `.agents.create_version_from_code` and `.agents.download_code` methods. They have moved from the `.beta.agents` subclient to the `.agents` subclient. |
| 10 | +* Toolboxes methods are now stable. They have moved from `.beta.toolboxes` subclient to the `.toolboxes` subclient. |
| 11 | +* Two new methods `.agents.enable` and `.agents.disable`. |
| 12 | +* New toolbox tool `ReminderPreviewToolboxTool`. |
| 13 | +* New concept of Draft Agent Version: |
| 14 | + * Optional boolean argument `draft` added to method `.agents.create_version`. |
| 15 | + * Optional boolean property `draft` added to class `AgentVersionDetails`. |
| 16 | + * Optional boolean argument `include_drafts` added to method `.agents.list_versions`. |
| 17 | +* Optional property `defer_loading` added to a few Agent tool classes. |
| 18 | +* Optional property `supported_evaluation_levels` added to class `EvaluatorVersion`. |
| 19 | +* Class `BotServiceTenantAuthorizationScheme` added (derived from `AgentEndpointAuthorizationScheme`). |
| 20 | +* Class `EndpointBasedEvaluatorDefinition` added (derived from `EvaluatorDefinition`). |
13 | 21 |
|
14 | 22 | ### Breaking Changes |
15 | 23 |
|
16 | | -* Toolbox operation `create_version` now defines `tools` of type `List[ToolboxTool]` instead of `List[Tool]`. |
17 | | -* Input argument `path` renamed to `remote_path` in methods `.agents.delete_session_file`, `.agents.download_session_file`, `.agents.list_session_files` and `.agents.upload_session_file`. |
18 | | -* Agent Optimization methods `.beta.agents.*optimization*` were re-written. Updated from v1 to v2 preview, focusing on cleanup to better align with Foundry job guidelines and platform standards. The v1 surface accumulated unused candidate sub-resources, internal-detail properties, and custom operation patterns inconsistent with the Foundry platform. The v2 API removes redundant models and operations, adopts shared Foundry job patterns (`JobLike<>`, standard job verbs), and introduces typed discriminated unions for dataset inputs and evaluator references. |
19 | | -* Method `.beta.agents.list_optimization_candidates` now returns `ItemPaged[OptimizationCandidate]` instead of `AgentsPagedResultOptimizationCandidate`. The `after` parameter has been removed (use continuation-token-based paging instead). |
20 | | -* Property `default_ttl_seconds` on class `MemoryStoreDefaultOptions` has changed from type `int` to type `datetime.timedelta`. |
21 | | -* Method ".beta.agents.patch_agent_details` moved out of the beta sub-client and renamed to `.agents.update_details`. |
| 24 | +All breaking changes are associated with beta features, or beta features that are being promoted to stable. |
22 | 25 |
|
| 26 | +* Toolbox method `create_version` now defines `tools` of type `List[ToolboxTool]` instead of `List[Tool]`. A new set of Toolbox tools classes, |
| 27 | +all derived from `ToolboxTool`, have been defined. |
| 28 | +* Input argument structure for method `create_version_from_code` has been simplified. The same information is passed in, but in a modified way. Also, the `code` type has changed from `FileType` to `IO[bytes]`, and the `code_zip_sha256` was made optional (it will be calculated by the method if not provided by the caller). |
| 29 | +* Agent Optimization methods `.beta.agents.*optimization*` were re-written to better align with Foundry job guidelines and platform standards. The old version accumulated unused candidate sub-resources, internal-detail properties, and custom operation patterns inconsistent with the Foundry platform. The new version removes redundant models and operations, adopts shared Foundry job patterns (`JobLike<>`, standard job verbs), and introduces typed discriminated unions for dataset inputs and evaluator references. |
| 30 | +* Argument `agent_session_id` on Session Files methods was renamed to `session_id`. |
| 31 | +* Method `.beta.agents.list_optimization_candidates` now returns `ItemPaged[OptimizationCandidate]` instead of `AgentsPagedResultOptimizationCandidate`. The `after` parameter has been removed (use continuation-token-based paging instead). |
| 32 | +* Method `.agents.patch_agent_details` was renamed to `.agents.update_details`. |
| 33 | +* Optional property `default_ttl_seconds` on class `MemoryStoreDefaultOptions` has changed from type `int` to type `datetime.timedelta`. |
| 34 | +* Optional properties `description`, `name` and `tool_configs` have been removed from preview tools (classes derived from class `Tool`, with name ending in `PreviewTool`). |
| 35 | +* Optional properties `description`, `name` and `tool_configs` are now documented as deprecated in stable Agent tools, to be removed in a future version (classes derived from class `Tool` with names not ending with `PreviewTool`). |
| 36 | +* Optional property `protocols` on class `AgentEndpointConfig` was renamed to `protocol_configuration`. |
| 37 | +* Optional property `tools` removed from `HostedAgentDefinition`. |
| 38 | +* Optional property `system_data` removed from `ModelVersion`. |
| 39 | +* `AgentProtocol` class was removed. The `protocol` property in class `ProtocolVersionRecord` is now of type `Union[str, AgentEndpointProtocol]`. |
23 | 40 |
|
24 | 41 | ### Sample updates |
25 | 42 |
|
26 | | -* Added `sample_routines_crud.py` to demonstrate CRUD operations. |
| 43 | +* Added agent optimization samples under `samples/agents/optimization/`: |
| 44 | + * `sample_optimization_job_basic.py` demonstrating how to create an optimization job, poll it to completion, and read the results. |
| 45 | + * `sample_optimization_job_cancel.py` demonstrating how to create and immediately cancel an optimization job. |
| 46 | + * `sample_optimization_job_list_get_delete.py` demonstrating how to list optimization jobs with filters, get a job by ID, and delete a job. |
| 47 | +* Added `sample_routines_crud.py` to demonstrate routines CRUD operations. |
27 | 48 | * Added `sample_routines_with_timer_trigger.py` to demonstrate triggering a routine with a timer. |
28 | | -* Added `sample_routines_with_schedule_trigger.py` to demonstrate triggering a routine on a recurring cron schedule via `ScheduleRoutineTrigger`. |
| 49 | +* Added `sample_routines_with_schedule_trigger.py` to demonstrate triggering a routine on a recurring Cron schedule via `ScheduleRoutineTrigger`. |
29 | 50 | * Added `sample_routines_with_dispatch.py` to demonstrate manually firing a routine on demand via `routines.dispatch(...)` using a `CustomRoutineTrigger`. |
30 | 51 | * Added new Hosted Agent sample `sample_toolbox_with_skill.py` under `samples/hosted_agents/`, demonstrating a code-based Hosted Agent that uses Toolbox MCP skills. |
31 | 52 | * Updated `sample_dataset_generation_job_traces_for_evaluation.py` and `sample_dataset_generation_job_traces_for_finetuning.py` to create a temporary agent, seed conversations, retry the data generation job over the trace window, and clean up all created resources. |
32 | | -* Updated `sample_memory_crud.py` and `sample_memory_crud_async.py` to demonstrate memory item CRUD (`create_memory`, `get_memory`, `update_memory`, `list_memories`, `delete_memory`) in addition to memory store CRUD. |
33 | 53 | * Updated the rubric evaluator generation samples (`sample_rubric_evaluator_generation_basic.py`, `sample_rubric_evaluator_generation_iterate.py`, `sample_rubric_evaluator_generation_lifecycle.py`, `sample_rubric_evaluator_generation_all_sources.py`) to use the typed `EvaluatorGenerationJob` / `EvaluatorGenerationInputs` / `*EvaluatorGenerationJobSource` models. The job inputs are now nested under `inputs` per the service contract, and the traces source uses `datetime` values for `start_time` / `end_time`. |
34 | 54 | * Updated Hosted Agent code-upload samples (`sample_create_hosted_agent_from_code.py`, `sample_create_hosted_agent_from_code_async.py`) to target runtime `python_3_14`, since `python_3_12` is no longer supported. |
35 | 55 | * Updated Hosted Agent echo-agent assets (`samples/hosted_agents/assets/echo-agent/main.py`, `echo-agent-prebuilt.zip`) to use `@app.response_handler`, resolving a response-handling issue. The remote-build code-upload sample now builds the echo-agent zip from `samples/hosted_agents/assets/echo-agent/` at runtime instead of relying on a checked-in `echo-agent.zip`, so users can update the agent code and rerun the sample with their changes. |
|
0 commit comments