github Azure/azure-sdk-for-python azure-ai-projects_2.0.0

10 hours ago

2.0.0 (2026-03-06)

First stable release of the client library that uses the Generally Available (GA) version "v1" of the Foundry REST APIs.

Features Added

  • To enable preview (beta) operations, a new optional boolean input argument named allow_preview was added
    to the constructor of AIProjectClient. Caller must set it to True to opt-in to preview features.
    This includes creating an Hosted Agent or Workflow Agent. Methods on the .beta sub-client (for example
    .beta.memory_stores.create()) do not require setting allow_preview=True since it's implied by the sub-client name.
    When preview features are enabled, the client libraries sends the HTTP request header Foundry-Features
    with the appropriate value in all relevant calls to the service.

Breaking Changes

  • Input argument foundry_features was removed from all methods that supported it. Use the new allow_preview
    instead on client constructor (see above).
  • Class TextResponseFormatConfiguration renamed to TextResponseFormat.
  • Class TextResponseFormatConfigurationResponseFormatText renamed to TextResponseFormatTest.
  • Class TextResponseFormatConfigurationResponseFormatJsonObject renamed to TextResponseFormatJsonObject.
  • Class CodeInterpreterContainerAuto was renamed to AutoCodeInterpreterToolParam,
    and has a new optional property network_policy of type ContainerNetworkPolicyParam.
  • class ImageGenActionEnum was renamed to ImageGenAction.
  • Rename ToolChoiceParamType.WEB_SEARCH_PREVIEW2025_03_11 to ToolChoiceParamType.WEB_SEARCH_PREVIEW_2025_03_11.
  • Rename RankerVersionType.DEFAULT2024_11_15 to RankerVersionType.DEFAULT_2024_11_15.
  • Rename method .beta.evaluators.list_latest_versions() to .beta.evaluators.list().
  • Rename property id on class Insight to insight_id.
  • Rename property id on class Schedule to schedule_id.
  • Rename input argument id to insight_id in .beta.insights.get() method.
  • Rename input argument id to schedule_id in .beta.schedules methods.
  • Updated datetime-typed fields (start_time, end_time, trigger_at, trigger_time, created_at, modified_at)
    across CronTrigger, RecurrenceTrigger, OneTimeTrigger, ScheduleRun, and EvaluatorVersion classes from str
    to datetime.datetime with format="rfc3339".

Other Changes

  • The input items argument in the methods .beta.memory_stores.begin_update_memories() and .beta.memory_stores.search_memories
    was change from type Optional[List[dict[str, Any]]] to Optional[Union[str, ResponseInputParam]]. The class ResponseInputParam
    can be imported using from openai.types.responses import EasyInputMessageParam. This is not a breaking change, since the caller
    can still pass in List[dict[str, Any].

Don't miss a new azure-sdk-for-python release

NewReleases is sending notifications on new releases.