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_previewwas added
to the constructor ofAIProjectClient. Caller must set it to True to opt-in to preview features.
This includes creating an Hosted Agent or Workflow Agent. Methods on the.betasub-client (for example
.beta.memory_stores.create()) do not require settingallow_preview=Truesince it's implied by the sub-client name.
When preview features are enabled, the client libraries sends the HTTP request headerFoundry-Features
with the appropriate value in all relevant calls to the service.
Breaking Changes
- Input argument
foundry_featureswas removed from all methods that supported it. Use the newallow_preview
instead on client constructor (see above). - Class
TextResponseFormatConfigurationrenamed toTextResponseFormat. - Class
TextResponseFormatConfigurationResponseFormatTextrenamed toTextResponseFormatTest. - Class
TextResponseFormatConfigurationResponseFormatJsonObjectrenamed toTextResponseFormatJsonObject. - Class
CodeInterpreterContainerAutowas renamed toAutoCodeInterpreterToolParam,
and has a new optional propertynetwork_policyof typeContainerNetworkPolicyParam. - class
ImageGenActionEnumwas renamed toImageGenAction. - Rename
ToolChoiceParamType.WEB_SEARCH_PREVIEW2025_03_11toToolChoiceParamType.WEB_SEARCH_PREVIEW_2025_03_11. - Rename
RankerVersionType.DEFAULT2024_11_15toRankerVersionType.DEFAULT_2024_11_15. - Rename method
.beta.evaluators.list_latest_versions()to.beta.evaluators.list(). - Rename property
idon classInsighttoinsight_id. - Rename property
idon classScheduletoschedule_id. - Rename input argument
idtoinsight_idin.beta.insights.get()method. - Rename input argument
idtoschedule_idin.beta.schedulesmethods. - Updated datetime-typed fields (
start_time,end_time,trigger_at,trigger_time,created_at,modified_at)
acrossCronTrigger,RecurrenceTrigger,OneTimeTrigger,ScheduleRun, andEvaluatorVersionclasses fromstr
todatetime.datetimewith format="rfc3339".
Other Changes
- The input
itemsargument in the methods.beta.memory_stores.begin_update_memories()and.beta.memory_stores.search_memories
was change from typeOptional[List[dict[str, Any]]]toOptional[Union[str, ResponseInputParam]]. The classResponseInputParam
can be imported usingfrom openai.types.responses import EasyInputMessageParam. This is not a breaking change, since the caller
can still pass inList[dict[str, Any].