* Bump Python package versions for 1.2.0 release
Released tier bumps 1.1.1 -> 1.2.0 (core, openai, foundry, root) to
reflect additive public APIs landed since 1.1.0: functional workflow API
(#4238) and FunctionTool SKIP_PARSING sentinel (#5424). All beta packages
stamped 1.0.0b260424, alpha packages 1.0.0a260424. All 26 non-core
agent-framework-core floors raised to >=1.2.0,<2. CHANGELOG consolidates
the never-tagged 1.1.1 entries with the post-merge additions into [1.2.0].
* Update CHANGELOG footer links for 1.2.0
Advance [Unreleased] comparison base from python-1.1.0 to python-1.2.0
and add a [1.2.0] reference link comparing python-1.1.0...python-1.2.0
so the heading links resolve correctly.
* Fix CHANGELOG: restore [1.1.1] section and add proper [1.2.0]
Previous commit incorrectly renamed the [1.1.1] header to [1.2.0], which
wiped the historical 1.1.1 entries and wrongly attributed them to 1.2.0.
This restores [1.1.1] to its origin/main content and adds a new [1.2.0]
section above containing only the commits in python-1.1.1..HEAD:
- #4238 functional workflow API
- #5142 GitHub Copilot OpenTelemetry
- #2403 A2A bridge support
- #5070 oauth_consent_request events in Foundry clients
- #5447 FoundryAgent hosted agent sessions
- #5459 hosting server dependency upgrade + types
- #5389 AG-UI reasoning/multimodal parsing fix
- #5440 stop [TOOLBOXES] warning spam
- #5455 user agent prefix fix
Also corrects the [1.2.0] compare base to python-1.1.1 (not 1.1.0) and
adds the missing [1.1.1] reference link.
* Fix Foundry clients not surfacing oauth_consent_request events (#5054)
Override _parse_chunk_from_openai in both RawFoundryChatClient and
RawFoundryAgentChatClient to intercept response.output_item.added
events with item.type == 'oauth_consent_request'. The consent link
is validated (HTTPS required) and converted to
Content.from_oauth_consent_request, which the AG-UI layer already
knows how to emit as a CUSTOM event.
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
* Address PR review feedback for #5054 OAuth consent parsing
- Extract shared helper (try_parse_oauth_consent_event) to avoid
duplicated logic between RawFoundryChatClient and
RawFoundryAgentChatClient
- Use urllib.parse.urlparse() for HTTPS validation instead of
case-sensitive startswith check
- Sanitize log messages to avoid leaking consent_link tokens;
log only item id
- Add model=self.model to ChatResponseUpdate to match parent behavior
- Add assertions on role, raw_representation, and model in happy-path
tests
- Add test for empty-string consent_link
- Add test verifying non-oauth events delegate to super()
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
* Handle response.oauth_consent_requested top-level event (#5054)
Add support for the top-level response.oauth_consent_requested stream
event in addition to the response.output_item.added variant. The
service may emit either form; handle both so the consent link is
reliably surfaced.
Extract _validate_consent_link helper within _oauth_helpers.py to
reduce nesting.
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
* Address review feedback for #5054: Python: [Bug]: `FoundryAgent` (Responses API) Does Not Surface `oauth_consent_request` as a CUSTOM AG-UI Event
* Address review feedback: defensive getattr and dedicated helper tests (#5054)
- Use getattr(event, 'type', None) in try_parse_oauth_consent_event
for defensive access against malformed events without a type attribute
- Add test_oauth_helpers.py with unit tests for _validate_consent_link
and try_parse_oauth_consent_event covering edge cases:
- HTTPS URL with empty netloc (https:///path)
- Warning log messages for rejected consent links
- Event objects missing 'type' attribute
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
* Address review feedback for #5054: Python: [Bug]: `FoundryAgent` (Responses API) Does Not Surface `oauth_consent_request` as a CUSTOM AG-UI Event
* Fix mypy: match _parse_chunk_from_openai signature with superclass
Add seen_reasoning_delta_item_ids parameter to _parse_chunk_from_openai
overrides in both RawFoundryChatClient and RawFoundryAgentChatClient to
match the updated superclass signature on main. Update super() calls and
test assertions accordingly.
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
---------
Co-authored-by: Copilot <copilot@github.com>
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Co-authored-by: Evan Mattson <evan.mattson@microsoft.com>
* Add functional workflow api
* cleanup
* More cleanup
* address copilot feedback
* Address PR feedbacK
* updates
* PR feedback
* Address review comments on functional workflow samples
- Swap 05/06 get-started samples: agent workflow first (motivates
why workflows exist), simple text workflow second
- Rename text_pipeline → text_workflow, poem_pipeline → poem_workflow
- Add @step to agent workflow sample (05) to demonstrate caching
- Switch agent samples to AzureOpenAIResponsesClient with Foundry
- Remove .as_agent() from agent_integration.py to focus on the key
difference between inline agent calls vs @step-cached calls
- Add commented-out Agent.run example in hitl_review.py
- Add clarifying comment in _functional.py that event streaming is
buffered (not true per-token streaming)
- Add naive_group_chat.py functional sample: round-robin group chat
as a plain Python loop
- Update READMEs to reflect new file names and group chat sample
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
* Fix pyright type errors
* Address PR review comments on functional workflow API
1. Allow request_info inside @step: Auto-inject RunContext into step
functions that declare a RunContext parameter (by type or name 'ctx'),
and expose get_run_context() for programmatic access.
2. Handle None responses: Log a warning when a response value is None,
and document the behavior in request_info docstring.
3. Add executor_bypassed event type: Replace executor_invoked +
executor_completed with a single executor_bypassed event when a step
replays from cache, making cached vs live execution explicit.
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
* Add regression tests for PR review comments on functional workflow API
The three review comments (request_info in @step, None response handling,
executor_bypassed event type) were already addressed in 7da7db4e. This
commit adds cross-cutting regression tests that exercise the interactions
between these features:
- HITL in step with caching: preceding step bypassed on resume
- Full checkpoint lifecycle with HITL step (interrupt -> resume -> restore)
- None response inside step-level request_info logs warning
- WorkflowInterrupted from step does not emit executor_failed
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
* Address PR #4238 review comments on functional workflow API
Comment 1 (request_info in @step): Already supported. Added comment in
StepWrapper.__call__ explaining why WorkflowInterrupted (BaseException)
safely bypasses the except Exception handler.
Comment 2 (None response): Added docstring to _get_response clarifying
the (found, value) return tuple semantics and None handling.
Comment 3 (bypass event type): executor_bypassed is already a dedicated
event type in WorkflowEventType. Updated comment at the bypass site to
make the deliberate event type choice explicit.
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
* Add experimental API warnings to functional workflow module
Mark all public classes and decorators (workflow, step, RunContext,
FunctionalWorkflow, StepWrapper, FunctionalWorkflowAgent) as
experimental and subject to change or removal.
* Address PR #4238 review comments from @eavanvalkenburg
- RunContext docstring leads with purpose (opt-in handle for HITL,
custom events, state) so readers importing it from the public surface
understand its role before the mechanics (#2993513452).
- Rename `06_first_functional_workflow.py` to
`06_functional_workflow_basics.py`; the previous filename was
confusing since it followed `05_functional_workflow_with_agents.py`
(#2993531979).
- Simplify `05_functional_workflow_with_agents.py` to call agents
directly without a @step wrapper; the step-vs-no-step contrast lives
in `03-workflows/functional/agent_integration.py`, keeping the
get-started sample minimal (#2993525532).
- Switch functional samples to `FoundryChatClient` for consistency with
the rest of 01-get-started and 03-workflows (follow-up on #2876988570).
- Use walrus in `hitl_review.py` final-state assertion (#2993572182).
- Add expected-output block to `basic_streaming_pipeline.py` (#2993557609).
- Clarify in `parallel_pipeline.py` that `@step` composes with
`asyncio.gather` (#2993597282).
- `naive_group_chat.py` threads `list[Message]` between turns instead
of stringifying the transcript, preserving role/authorship (#2993583231).
Drive-by: pre-commit hook sorts an unrelated import block in
`samples/04-hosting/foundry-hosted-agents/responses/02_local_tools/main.py`.
* Fix 10 functional-workflow API bugs from /ultrareview pass
- bug_001: `ctx.request_info()` without an explicit `request_id` now derives
a deterministic `auto::<index>` id from the call-counter, so HITL resume
works correctly on the documented default path. A uuid was regenerated on
every replay, making resume impossible.
- bug_002: `StepWrapper.__call__` no longer deepcopies arguments on the
cache-hit replay branch. The copy is only performed on the live-execution
path (for the event log) and falls back to the original mapping if deepcopy
fails, so steps whose args aren't deepcopyable (locks, sockets, sessions)
can still resume from checkpoint.
- bug_007: `_set_responses` now prunes each resolved `request_id` from
`_pending_requests`, and the cache-hit branch in `request_info` does the
same. Previously, answered requests were re-serialized into every
subsequent checkpoint and the final checkpoint falsely claimed pending
requests even after the workflow completed.
- bug_008: `_compute_signature_hash` now mixes the function's `co_code` and
`co_names` into the checkpoint signature, so changes to the workflow body
invalidate older checkpoints even when steps are accessed via module /
class attributes (which `_discover_step_names` can't see statically).
`RunContext._record_observed_step` records observed step names for
diagnostics.
- bug_010: `FunctionalWorkflow.run()` docstring corrected — says "at least
one of message/responses/checkpoint_id" and explicitly notes `responses`
may be combined with `checkpoint_id` (the validator already allowed this).
- bug_013: `FunctionalWorkflowAgent` now surfaces `request_info` events as
`FunctionApprovalRequestContent` items (mirroring graph `WorkflowAgent`),
threads `responses=` and `checkpoint_id=` through to the underlying
workflow, and exposes `pending_requests`. Previously `.as_agent()`
returned empty `AgentResponse` for HITL workflows — effectively unusable.
- bug_014: `FunctionalWorkflow` now clears `_last_message`,
`_last_step_cache`, and `_last_pending_request_ids` on clean completion.
`run()` validates that `responses=` keys intersect the currently-pending
request set (or raises with a clear error) instead of silently replaying
against stale singleton state from a prior run.
- bug_015: `FunctionalWorkflow.as_agent` signature now matches graph
`Workflow.as_agent`: accepts `name`, `description`, `context_providers`,
and `**kwargs`. `FunctionalWorkflowAgent` stores the overrides.
- bug_017: `RunContext.set_state` raises `ValueError` for underscore-
prefixed keys (the framework's `_step_cache` / `_original_message` keys
would silently clobber user state on checkpoint save and user
underscore-prefixed state was dropped on restore). Docstring documents
the reserved prefix.
- merged_bug_003: Workflow function arity is validated at decoration time.
Multiple non-ctx parameters raise `ValueError` immediately (previously
every arg past the first was silently dropped at call time). Passing a
non-None `message` to a ctx-only workflow raises `ValueError` instead of
silently discarding the message.
Test coverage: +18 regression tests covering every fix. Full workflow
suite now 766 passed, 1 skipped, 2 xfailed; full core suite 2338 passed.
* Deslop functional.py fix commit
- Remove dead instrumentation added in the prior commit that was never
consumed: `RunContext._observed_step_names`,
`RunContext._record_observed_step`, `FunctionalWorkflow._runtime_step_names`,
and `FunctionalWorkflowAgent._extra_kwargs`. The signature hash relies on
`co_code` alone, which covers the attribute-access case without the
collection-scaffolding.
- Trim over-explanatory comments that restated what the code does or what
it no longer does. Keep only the comments that answer "why" for the
non-obvious bits (deterministic id contract, defensive deepcopy, stale
replay guard).
- Compress the `_compute_signature_hash` and FunctionalWorkflow `__init__`
block docstrings without losing the user-facing reasoning.
Net -49 lines. Regression lock preserved (766 passed, 1 skipped, 2 xfailed).
* Fix functional workflow review feedback
---------
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <copilot@github.com>
* fixes to FoundryAgent to connect to new hosted agents
Co-authored-by: Copilot <copilot@github.com>
* fix mypy
Co-authored-by: Copilot <copilot@github.com>
* Python: remove Foundry service session helpers
Remove the public hosted-agent service session CRUD helpers from FoundryAgent and drop the related feature-stage inventory entry.
Update the hosted-agent sample to create and delete service sessions directly through the preview AIProjectClient APIs, and tighten a few test harnesses surfaced by full workspace validation.
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
* fix from merge
* fix hosted env detection
Co-authored-by: Copilot <copilot@github.com>
* reverted sample update
* fix tests and code
Co-authored-by: Copilot <copilot@github.com>
* remove aenter
* skipping some tests
Co-authored-by: Copilot <copilot@github.com>
---------
Co-authored-by: Copilot <copilot@github.com>
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Eduard van Valkenburg
·
2026-04-24 09:25:03 +00:00
* Python: Add OpenTelemetry integration for GitHubCopilotAgent
- Split GitHubCopilotAgent into RawGitHubCopilotAgent (core, no OTel) and
GitHubCopilotAgent(AgentTelemetryLayer, RawGitHubCopilotAgent) with tracing
- Add default_options property to expose model for span attributes
- Export RawGitHubCopilotAgent from all public namespaces
- Add github_copilot_with_observability.py sample and update README
* Python: Fix OTEL_SERVICE_NAME default in GitHub Copilot README
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
* Python: Add unit tests for RawGitHubCopilotAgent.default_options property
* Python: Address review feedback on GitHubCopilotAgent OTel integration
- Add middleware param to GitHubCopilotAgent.run() overloads so per-call
middleware is explicitly forwarded through AgentTelemetryLayer
- Remove github_copilot_with_observability.py sample per feedback; replace
with inline snippet + link to observability samples in README
* Python: Address review feedback on log_level and session kwargs typing
- Add middleware param to RawGitHubCopilotAgent.run() overloads for interface
compatibility with AgentTelemetryLayer
- Fix import in README observability snippet to use agent_framework.github
* Python: Add AgentMiddlewareLayer to GitHubCopilotAgent MRO
Follow FoundryAgent pattern: AgentMiddlewareLayer runs outside the telemetry
span so middleware execution time is not captured in traces. Overloads removed
as AgentMiddlewareLayer.run() handles dispatch via MRO.
* Python: Add explicit __init__ to GitHubCopilotAgent for auto-complete and docstrings
* Python: Address review feedback on middleware warning and test assertions
- Add assert "timeout" not in opts to test_default_options_includes_model_for_telemetry
to document the intentional asymmetry where timeout is extracted into _settings
and not returned in default_options.
- Replace silent del middleware with a logged warning when per-run middleware is
passed to RawGitHubCopilotAgent, making it clear that the GitHub Copilot SDK
handles tool execution internally and chat/function middleware cannot be injected.
* Python: Use Self for __aenter__ return type in RawGitHubCopilotAgent
Address review feedback: use typing.Self (3.11+) / typing_extensions.Self
(3.10) for __aenter__ so subclasses like GitHubCopilotAgent get the correct
return type from async context manager usage.
---------
Co-authored-by: Claude Sonnet 4.6 <noreply@anthropic.com>
* feat: Add Agent Framework to A2A bridge support
- Implement A2A event adapter for converting agent messages to A2A protocol
- Add A2A execution context for managing agent execution state
- Implement A2A executor for running agents in A2A environment
- Add comprehensive unit tests for event adapter, execution context, and executor
- Update agent framework core A2A module exports and type stubs
- Integrate thread management utilities for async execution
- Add getting started sample for A2A agent framework integration
- Update dependencies in uv.lock
This integration enables agent framework agents to communicate and execute within the A2A (Agent to Agent) infrastructure.
* fix: Update references from agent_thread_storage to _agent_thread_storage in A2A executor tests
* Refactor A2A agent framework and improve code structure
- Reordered imports in various files for consistency and clarity.
- Updated `__all__` definitions to maintain a consistent order across modules.
- Simplified method signatures by removing unnecessary line breaks.
- Enhanced readability by adjusting formatting in several sections.
- Removed redundant comments and example scenarios in the execution context.
- Improved handling of agent messages in the event adapter.
- Added type hints for better clarity and type checking.
- Cleaned up test cases for better organization and readability.
* fix: Lint fix new line added
* test: Add unit tests for AgentThreadStorage and InMemoryAgentThreadStorage
* refactor: Update type hints to use new syntax for Union and List
* fix: Validate RequestContext for context_id and message before execution
* Refactor tests and remove A2aExecutionContext references
- Deleted the test file for A2aExecutionContext as it is no longer needed.
- Updated A2aExecutor tests to remove dependencies on A2aExecutionContext and adjusted method calls accordingly.
- Modified event adapter tests to use ChatMessage instead of AgentRunResponseUpdate.
- Removed A2aExecutionContext from imports in agent_framework.a2a module and updated type hints accordingly.
* Refactor A2AExecutor tests and remove event adapter
- Updated test cases to use A2AExecutor instead of A2aExecutor for consistency.
- Removed mock_event_adapter fixture and related tests as A2aEventAdapter is deprecated.
- Consolidated event handling tests into TestA2AExecutorEventAdapter.
- Adjusted imports in various files to reflect the removal of deprecated components.
- Ensured all references to A2aExecutor are updated to A2AExecutor across the codebase.
* refactor: Remove AgentThreadStorage and InMemoryAgentThreadStorage classes from threads and tests
* feat: A2AExecutor to have its own override able save and get threads methods for persistent storage.
* fix: linter bugs
* removed unnecessary changes form core package
* new line added
* Refactor A2AExecutor tests and update imports
- Consolidated mock agent fixtures in test_a2a_executor.py to simplify agent mocking.
- Removed redundant tests related to thread storage and agent types, focusing on A2AExecutor's core functionality.
- Updated test assertions to reflect changes in message handling with new Message and Content classes.
- Enhanced integration tests to ensure compatibility with the new agent framework structure.
- Added A2AExecutor to the module exports in __init__.py and __init__.pyi for better accessibility.
* Update A2A documentation: enhance usage examples for A2AAgent and A2AExecutor
* Updated uv lock
* Fix metadata assertion in TestA2AExecutorHandleEvents and reorder load_dotenv call in agent_framework_to_a2a.py
* Update agent card configuration: add default input and output modes, and fix agent creation method
* Fix assertion for metadata in TestA2AExecutorHandleEvents
* Fix formatting issues in TestA2AExecutorExecute and TestA2AExecutorIntegration
* Enhance A2AExecutor documentation with examples and clarify agent execution process
* Revert uv lock to main
* Refactor A2AExecutor: Improve formatting and streamline constructor parameters
* Apply suggestions from code review
Co-authored-by: Eduard van Valkenburg <eavanvalkenburg@users.noreply.github.com>
* Refactor A2AExecutor to use SupportsAgentRun and enhance logging; update agent framework sample for flight and hotel booking capabilities
* Enhance A2AExecutor with streaming support and custom run arguments; update tests for initialization and execution scenarios
* Enhance A2AExecutor event handling with streamed artifact tracking; update tests for new behavior
* Refactor A2AExecutor to enforce type hints for stream and run_kwargs attributes
* Refactor A2AExecutor and tests: replace AsyncMock with MagicMock for response stream handling; clean up imports in agent_framework_to_a2a.py
* refactor: streamline imports and improve code readability across multiple files
* feat: enhance A2AExecutor cancel method with context validation and fixed review comments
* feat: implement get_uri_data utility function for extracting base64 data from data URIs and update references
* fix: update import path for get_uri_data utility function in A2AExecutor and A2AAgent
* fix: correct error message handling in A2AExecutor and update test assertions
---------
Co-authored-by: Eduard van Valkenburg <eavanvalkenburg@users.noreply.github.com>
* Fix AG-UI reasoning role and multimodal media value field parsing
Fix two spec compliance issues in the AG-UI integration:
1. ReasoningMessageStartEvent now uses role='reasoning' instead of
role='assistant', matching the AG-UI specification for reasoning
messages.
2. _parse_multimodal_media_part now reads the 'value' field from source
dicts (with fallback to 'data' for backward compatibility), matching
the current AG-UI InputContentSource specification.
Bump ag-ui-protocol dependency from ==0.1.13 to >=0.1.16,<0.2 to pick
up the SDK fix that accepts role='reasoning' in ReasoningMessageStartEvent.
Fix pre-existing pyright reportMissingImports errors for orjson in sample
files, and fix import ordering in foundry-hosted-agents sample.
Fixes#5340
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
* Python: Fix AG-UI reasoning role and multimodal media parsing to follow specification
Fixes#5340
* Remove unintended .maf-runtime-ready marker file
Address PR review feedback: the .maf-runtime-ready file is not referenced anywhere in the repo and was left over from automation.
Fixes#5340
* Python: Fix duplicate AG-UI multimodal 'value' parsing in snapshot path
The snapshot normalization path used a second copy of the multimodal source
parsing logic that still read the deprecated 'data' field. When clients sent
base64 media with source={"type": "base64", "value": ...}, the snapshot event
emitted by the server dropped the payload, causing AG-UI-compatible clients
to crash on ingest.
Extract the shared source-field extraction into _extract_multimodal_source_fields
so both _parse_multimodal_media_part and the snapshot _legacy_binary_part stay
in sync with the AG-UI spec. Add snapshot-path regression tests covering
value-only, value-preferred-over-data, and the legacy data-field fallback.
Addresses review feedback on #5389 from @Rickyneer.
---------
Co-authored-by: Copilot <copilot@github.com>
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
* Python: Foundry: make response tool sanitizer internal, drop TOOLBOXES warning
sanitize_foundry_response_tool runs on every tool passed to the Foundry
Responses API, so its @experimental(TOOLBOXES) decorator was emitting a
[TOOLBOXES] ExperimentalWarning for any FoundryChatClient call, even when
no toolbox was involved. The function isn't in __all__ and has no external
callers. Rename to _sanitize_foundry_response_tool and drop the decorator;
the actual toolbox-facing public helpers remain gated.
* Python: Foundry: silence pyright on intentional cross-module private import
* improved parsing of tool call results and tweaks
* Address PR review: skip_parsing flag, broader registry close, comment fix
- FunctionTool.invoke now takes a boolean skip_parsing flag instead of the
SKIP_PARSING sentinel; the sentinel is still accepted as result_parser at
construction time to opt out of parsing for every call. The two paths are
equivalent.
- _SandboxRegistry.close now invokes any sandbox close/shutdown hook on the
entry's own worker thread (PyO3 unsendable), then shuts the worker down,
then cleans up the per-entry temporary directories.
- Clarified the _SandboxWorker.shutdown comment to describe the actual
ThreadPoolExecutor.shutdown(wait=False, cancel_futures=False) semantics.
- Hyperlight host callback uses skip_parsing=True (the new flag).
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
* Drop redundant 'is not SKIP_PARSING' guard that mypy 1.x flags
After callable(configured_parser) the sentinel is already excluded; the extra
identity check tripped mypy's non-overlapping identity warning.
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
* fixed sandbox working on copy of tool
---------
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Eduard van Valkenburg
·
2026-04-23 08:14:51 +00:00
* Bump Python version for a release.
* Revert lockstep bumps on unchanged connectors
Per PR review: only connectors that changed (or whose published metadata
changed) should get new versions. Keeps released tier at 1.1.1, a2a/ag-ui
at 1.0.0b260422, foundry-hosting at 1.0.0a260422; reverts the 19 unchanged
betas and 2 unchanged alphas to 1.0.0b260421/1.0.0a260421. Reverts all 26
non-core agent-framework-core floors to >=1.1.0,<2 since no connector
actually depends on a 1.1.1 API or bug fix.
* Restore lockstep prerelease bumps and raise core floors to >=1.1.1
Reverses the lean-revert: all beta packages stamped 1.0.0b260423 and alpha
packages stamped 1.0.0a260423 (Asia date, matching release cut time). All
26 non-core packages raise agent-framework-core lower bound from >=1.1.0,<2
to >=1.1.1,<2 to signal the validated cohort for this release. CHANGELOG
date updated to 2026-04-23.
* Pass thread_id as session_id when constructing AgentSession in AG-UI
run_agent_stream() was constructing AgentSession without passing the
client's thread_id as session_id, causing every request to receive a
random UUID. This broke session continuity for HistoryProvider
implementations that rely on session_id matching the client's thread_id.
Pass session_id=thread_id in both the service-session and non-service
code paths so the session identity is consistent with the AG-UI client.
Fixes#5357
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
* Add test for service_session with no thread_id edge case (#5357)
When use_service_session=True but no thread_id/threadId is in the payload,
verify session_id is a generated UUID and service_session_id is None.
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
---------
Co-authored-by: Copilot <copilot@github.com>
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
* Propagate session.service_session_id as A2A context_id
When A2AAgent is used behind the AG-UI protocol, the client thread_id is
stored in session.service_session_id but was never forwarded as the A2A
context_id. This broke session continuity across the AG-UI → A2A boundary.
Add an optional context_id keyword argument to _prepare_message_for_a2a()
and pass session.service_session_id from run(). The explicit
message.additional_properties["context_id"] still takes precedence.
Fixes#5345
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
* Add integration tests for session context_id wiring in run() (#5345)
- Enhance MockA2AClient.send_message to capture last_message for assertions
- Add test_run_passes_session_service_session_id_as_context_id: verifies
run() passes session.service_session_id through to A2A message context_id
- Add test_run_message_context_id_takes_precedence_over_session: verifies
explicit message context_id wins over session fallback
- Update _prepare_message_for_a2a docstring to document context_id param
and its precedence rules
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
* Address review feedback for #5345: Python: [Bug]: Inconvenient passing of context_id / thread_id in A2A/AG-UI implementations
---------
Co-authored-by: Copilot <copilot@github.com>
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
* fix(foundry): reconcile toolbox hosted-tool payloads with Responses API
* docs(foundry): update create_sample_toolbox docstring to reflect all tools created
* Fix streaming response losing created_at from response.completed event (#5347)
The streaming path in _parse_chunk_from_openai did not extract created_at
from the response.completed event, unlike the non-streaming path in
_parse_responses_response. This caused durabletask persistence warnings
when created_at was None.
Extract created_at in the response.completed case and pass it to the
returned ChatResponseUpdate.
Also fix pre-existing pyright errors for optional orjson import in sample
files.
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
* Fix orjson import suppression to use pyright instead of mypy (#5347)
Replace `# type: ignore[import-not-found]` with
`# pyright: ignore[reportMissingImports]` on optional orjson imports
in conversation sample files, matching the repo's Pyright strict
configuration.
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
---------
Co-authored-by: Copilot <copilot@github.com>
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
* Fix OpenAIEmbeddingClient with /openai/v1 endpoint (#5068)
When base_url ends with /openai/v1/ and a credential is provided,
load_openai_service_settings was creating an AsyncAzureOpenAI client.
The Azure SDK rewrites deployment-based endpoints (including /embeddings)
by inserting /deployments/{model}/ into the URL, producing 404s on the
OpenAI-compatible /openai/v1 endpoint.
Use AsyncOpenAI instead of AsyncAzureOpenAI when the resolved base_url
targets /openai/v1, converting the Azure token provider to an async
api_key callable. The responses_mode path is unaffected because the
Responses API (/responses) is not in the SDK's rewrite list.
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
* Python: Fix OpenAIEmbeddingClient to use AsyncOpenAI for /openai/v1 endpoints
Fixes#5068
* Address review feedback: improve test coverage and remove unrelated changes
- Revert unrelated formatting change in test_a2a_agent.py
- Fix test_init_with_openai_v1_base_url_and_api_key_uses_openai_client to
exercise the Azure settings path (via AZURE_OPENAI_BASE_URL env var)
instead of the plain OpenAI path, covering the elif api_key branch
- Add _ensure_async_token_provider unit tests for both sync and async
token providers
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
* Address review feedback for #5068: Python: [Bug]: `OpenAIEmbeddingClient` does not work with `/openai/v1` endpoint
---------
Co-authored-by: MAF Dashboard Bot <maf-dashboard-bot@users.noreply.github.com>
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Co-authored-by: Evan Mattson <35585003+moonbox3@users.noreply.github.com>
* feat(evals): add ground_truth support for similarity evaluator
- Include expected_output as ground_truth in Foundry JSONL dataset rows
- Add ground_truth to item schema and data mapping for similarity evaluator
- Add expected_output parameter to evaluate_workflow
- Add similarity Pattern 3 to evaluate_agent and evaluate_workflow samples
- Add tests for ground_truth in dataset, schema, and evaluate_workflow
* Apply suggestions from code review
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
* fix: wrap long line to satisfy ruff E501
---------
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
* Add set_stop_loss tool to concurrent_builder_tool_approval sample
Add a second approval-gated tool (set_stop_loss) to the concurrent workflow
tool approval sample to demonstrate handling approval requests for different
tools in the same concurrent workflow.
Changes:
- Add set_stop_loss(symbol, stop_price) with approval_mode='always_require'
- Include new tool in both agents' tool lists
- Update agent instructions and prompt to encourage stop-loss usage
- Update docstring to reflect two approval-gated tools
- Update sample output to show mixed approval requests
Fixes#4874
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
* Print tool name and arguments in concurrent sample's process_event_stream (#4874)
Align process_event_stream in concurrent_builder_tool_approval.py to print
the tool name and arguments when collecting approval requests, matching the
sample output comment and the sequential_builder_tool_approval.py pattern.
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
* Add None-guard for function_call access in tool approval sample (#4874)
Add explicit None-checks before accessing function_call.name and
function_call.arguments in concurrent_builder_tool_approval.py. The
function_call field is typed Content | None, so direct attribute access
without a guard could raise AttributeError and required type: ignore
comments. The None-guard is consistent with the pattern used in
_agent_run.py and removes the suppression comments.
Also add a regression test verifying that function_call defaults to None
and that the None-guard pattern is safe.
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
* Apply same function_call None-guard to sibling tool-approval samples (#4874)
Apply the same fix to sequential_builder_tool_approval.py and
group_chat_builder_tool_approval.py, which had the identical pattern
of accessing function_call.name/arguments without a None-guard.
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
---------
Co-authored-by: Copilot <copilot@github.com>
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
* Python: Wrapper + Samples 1st (#5177)
* Experiment
* Update dependency and add non streaming
* Add more samples
* Rename samples
* Add invocations
* Comments 1
* Comments 2
* Comments 3
* Improve README
* Add local shell sample
* WIP: Add eval and memory samples
* Update user agent prefix
* Update user agent prefix doc
* Update dependency (#5215)
* Add tests and more content types (#5235)
* Add tests
* fix tests and sample
* Fix formatting
* Remove function approval contents
* Python: Refine samples and upgrade packages (#5261)
* Refine samples and upgrade pacakges
* Upgrade to a new package that fixes a bug
* Update model env var
* Move samples (#5281)
* Python: Upgrade agentserver packages (#5284)
* Upgrade agentserver packages
* Fix new types
* Python: Add special handling for workflows (#5298)
* Add special handling for workflows
* Address comments
* Improve samples (#5372)
* Python: Add more types (#5378)
* Add more type supports
* Upgrade packages
* Remove TODOs in README
* Fix README
* Comments and mypy
* User agent scoped
* Fix README
* Fix pre commit
* Fix pre commit 2
* Fix pre commit 3
* Fix pre commit 4
* Fix pre commit 5
* Fix pre commit 6
* Add azure-monitor-opentelemetry to dev deps
Fixes Samples & Markdown CI failure. The PR's new transitive dep on
azure-monitor-opentelemetry-exporter (via azure-ai-agentserver-core) makes
pyright resolve the azure.monitor.opentelemetry namespace, flipping the
check_md_code_blocks diagnostic for `configure_azure_monitor` from
reportMissingImports (filtered) to reportAttributeAccessIssue (not filtered).
Installing the umbrella azure-monitor-opentelemetry package in dev makes
pyright resolve the symbol correctly, matching the install guidance the
observability README already gives users.
---------
Co-authored-by: Evan Mattson <evan.mattson@microsoft.com>
* Expose forwarded_props to agents and tools via session metadata (#5239)
Include forwarded_props from AG-UI request input_data in session.metadata
(agent runner) and function_invocation_kwargs (workflow runner) so that
agents, tools, and workflow executors can access request-level metadata
such as invocation source flags from CopilotKit.
- Add forwarded_props to base_metadata in _agent_run.py when present
- Add 'forwarded_props' to AG_UI_INTERNAL_METADATA_KEYS to filter it
from LLM-bound client metadata
- Extract forwarded_props in _workflow_run.py and pass via
function_invocation_kwargs to workflow.run()
- Accept both snake_case and camelCase keys (forwarded_props/forwardedProps)
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
* fix(ag-ui): pass stream=True as literal to satisfy pyright overload resolution (#5239)
The previous fix passed stream=True via **kwargs dict, which prevented
pyright from resolving the Workflow.run() overload to the streaming
variant. Pass stream=True as an explicit keyword argument so pyright
can correctly infer the ResponseStream return type.
Also remove unused pytest import in test file.
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
* fix: address PR review feedback for forwarded_props (#5239)
- Use key-presence checks instead of truthiness for forwarded_props so
empty dict {} is forwarded correctly
- Gate function_invocation_kwargs on workflow.run() signature inspection
to avoid TypeError for workflows without **kwargs
- Change _build_safe_metadata to drop (with warning) keys whose
serialized values exceed 512 chars instead of truncating into invalid
JSON
- Rewrite metadata tests to exercise _build_safe_metadata directly with
JSON-decodability and truncation assertions
- Add workflow tests for empty dict forwarded_props, stream=True
assertion, and signature-gated kwarg dropping
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
* test: add stream=True assertions to CapturingWorkflow tests (#5239)
Guard against accidental removal of the explicit stream=True kwarg
in all forwarded_props CapturingWorkflow test cases.
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
* Address review feedback for #5239: Python: Expose forwardedProps to agents and tools via session metadata
---------
Co-authored-by: Copilot <copilot@github.com>
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
* Add support for the Foundry Toolbox in MAF
Introduces a Foundry Toolbox integration: FoundryChatClient gains a
get_toolbox() helper plus select_toolbox_tools(), normalize_tools in
the core package flattens tool-collection wrappers (ToolboxVersionObject
and generic iterables, while leaving Pydantic BaseModel instances
alone), and the new agent_framework.foundry namespace re-exports the
toolbox helpers. Ships with unit tests, a sample, and a design doc.
azure-ai-projects is pinned to the public >=2.0.0,<3.0 range and the
lockfile resolves from public PyPI. The toolbox test module skips when
Toolbox* types are unavailable so CI stays green until the public 2.1.0
SDK lands. OMC tooling directories (.omc/, .omx/) are gitignored.
* Update to latest azure ai projects package
* Improve sample
* Rename ADR to 0025
* Update ADR
* Apply suggestion from @alliscode
Co-authored-by: Ben Thomas <ben.thomas@microsoft.com>
* Improve samples
* Update test
---------
Co-authored-by: Ben Thomas <ben.thomas@microsoft.com>
* Fix CopilotStudioAgent to reuse existing conversation on session (#5285)
CopilotStudioAgent unconditionally called _start_new_conversation() in both
_run_impl and _run_stream_impl, ignoring any existing service_session_id on
the session. Add a guard to only start a new conversation when there is no
existing service_session_id, matching the pattern used by other agents.
Also fix pre-existing pyright reportMissingImports errors for orjson in
file_history_provider samples.
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
* Revert out-of-scope sample file changes
Remove unrelated orjson type-ignore comment changes from sample files
that were outside the scope of the conversation-ID reuse fix.
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
---------
Co-authored-by: Copilot <copilot@github.com>
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
* feat: add finish_reason support to AgentResponse and AgentResponseUpdate
Add finish_reason field to AgentResponse and AgentResponseUpdate classes,
propagate it through _process_update() and map_chat_to_agent_update(),
and add comprehensive unit tests.
Fixes#4622
* feat: add finish_reason to AgentResponse and AgentResponseUpdate
* style: add copyright header to test_finish_reason.py
* docs: add finish_reason to AgentResponse and AgentResponseUpdate docstrings
* refactor: move finish_reason tests into test_types.py per review feedback
Move all finish_reason test cases from the separate test_finish_reason.py
file into test_types.py as requested by eavanvalkenburg. Tests are placed
in a new '# region finish_reason' section at the end of the file.
* fix: use model instead of model_id in _process_update
Address PR review feedback from @eavanvalkenburg — ChatResponse and
ChatResponseUpdate both use 'model', not 'model_id'.
* fix: resolve SIM102 lint error in _process_update
Combine nested if statements for AgentResponse finish_reason check
to satisfy ruff SIM102 rule, with line wrapping to stay under 120 chars.
* fix: resolve pyright reportArgumentType in map_chat_to_agent_update
Add type: ignore[arg-type] for FinishReason NewType widening when
passing ChatResponseUpdate.finish_reason to AgentResponseUpdate.
Matches existing patterns in the codebase (40+ similar ignores).
* Fix url_citation annotations dropped in streaming (#5029)
Add url_citation branch to the streaming annotation handler in
_parse_chunk_from_openai, mirroring the existing non-streaming path.
The handler creates an Annotation with type='citation', title, url,
and annotated_regions (TextSpanRegion), wrapped in Content.from_text.
Update test_streaming_annotation_added_with_unknown_type to use a
truly unknown type, and add new tests for url_citation (with and
without url).
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
* Address review feedback for #5029: Python: [Bug]: url_citation annotations silently dropped in Foundry streaming (SharePoint grounding citations lost)
---------
Co-authored-by: Copilot <copilot@github.com>
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Co-authored-by: Evan Mattson <35585003+moonbox3@users.noreply.github.com>
Fixes#5246
When a custom @executor transforms agent output and sends a plain str,
the downstream AgentExecutor.from_str handler loses the full conversation
context. This adds a with_text() helper that creates a new
AgentExecutorResponse with replaced text while preserving the prior
conversation chain, so AgentExecutor.from_response is invoked instead.
- Add with_text(text) method to AgentExecutorResponse dataclass
- Add 3 regression tests in test_full_conversation.py
Co-authored-by: Evan Mattson <35585003+moonbox3@users.noreply.github.com>
The local MCP server can't be used for hosted tools tests because
Anthropic's backend needs to reach the MCP URL from their infrastructure
(not localhost on the CI runner). Revert to learn.microsoft.com/api/mcp
but catch BadRequestError, InternalServerError, APIConnectionError, and
APITimeoutError and pytest.skip so upstream outages don't block the
merge queue.
* Python: use local MCP server for hosted tools test and broaden image assertion
The hosted tools integration test was hitting rate limits on the external
learn.microsoft.com MCP server, causing persistent failures that retries
couldn't recover from. Switch to the local MCP server already spun up in
CI via LOCAL_MCP_URL, skipping when the env var isn't set.
Also broaden the image description assertion to accept common synonyms
(cottage, mansion, villa, etc.) instead of just "house", since the model
legitimately uses varied vocabulary for the same image.
* Address review feedback: validate LOCAL_MCP_URL scheme and use word boundaries
- Skip hosted tools test when LOCAL_MCP_URL lacks http/https scheme,
matching the pattern used in test_mcp.py.
- Use regex word boundaries for image assertion to avoid false matches
like "villain" matching "villa".
* Add agent-framework-gemini package
* Add AGENTS.md documentation
* Add LICENSE file
* Add README.md for agent-framework-gemini package
* Add Google Gemini API keys to .env.example
* Add Google Gemini chat client implementation
* Add tests for GeminiChatClient
* Add Google Gemini agent examples
* Fix client inheritence order
* Update Gemini agent examples
* Update documentation
* Update AGENTS.md
* Add tests for JSON string handling in GeminiChatClient
* Add final response assembly test in GeminiChatClient
* Add tests for handling empty candidates in GeminiChatClient
* Improve Pydantic response handling in GeminiChatClient
* Add tests for function result resolution and callable tool normalization
* Add test for function result resolution when call_id is generated
* Refactor GeminiChatClient to correct inheritance order
Also updates constructor parameter order for environment file handling
* Enhance documentation and clarify Gemini-specific fields
* Update ThinkingConfig with new attributes and type
* Add tests for GoogleSearch and GoogleMaps configs
* Suppress valid-type mypy error on GeminiChatOptionsT
* Move service_url method near overrides
* Order _prepare_config kwargs by base then Gemini-specific
* Use FunctionCallingConfigMode for clarity and type safety
* Fix code_execution doc
* Add agent-framework-gemini to project dependencies
* Remove package from core dependencies
Initial release will be done without agent-framework-gemini in
core[all].
* Move integration tests into one file
* Remove __init__.py file from gemini tests directory
* Introduce RawGeminiChatClient as lightweight chat client
Updated GeminiChatClient to inherit from RawGeminiChatClient, maintaining full functionality with added features.
* Updated variable names from `model_id` to `model`
Across the codebase, including environment variables and client initialization. Adjusted related tests and sample scripts to reflect this change, ensuring consistency in the usage of the Gemini model identifier.
* Update AGENTS.md
* Update Gemini package to alpha status
* Fix docstrings in Gemini tests
* Change 'model_id' to 'model' in response handling
* Fix model property change in response handling
* Add built-in tool factory methods to Gemini client
Replaces boolean tool options (code_execution, google_search_grounding,
google_maps_grounding) with static factory methods that return types.Tool
objects: get_code_interpreter_tool, get_web_search_tool, get_mcp_tool,
get_file_search_tool, and get_maps_grounding_tool.
Simplifies _prepare_tools to a single translation boundary between
FunctionTool (framework) and FunctionDeclaration (Gemini API), with
types.Tool objects passed through unchanged.
* Surface code execution parts
_parse_parts now maps executable_code and code_execution_result
parts to text Content objects so callers can see the code run
and its output. Unknown part types log at debug level rather than
being silently dropped.
* Update Gemini client documentation
* Unify Gemini model name
Co-authored-by: Eduard van Valkenburg <eavanvalkenburg@users.noreply.github.com>
* Update Agent Framework core version
Co-authored-by: Eduard van Valkenburg <eavanvalkenburg@users.noreply.github.com>
* Add Python 3.14 in classifiers
* Replace kwargs with parameters in tool factories
* Refactor chat options handling in Gemini client
* Add tests for handling unknown and consumed keys
* Update Gemini documentation
Now reflects new options and built-in tool factory methods
* Change build system to flit
Co-authored-by: Eduard van Valkenburg <eavanvalkenburg@users.noreply.github.com>
* Fix build system in pyproject.toml
* Fix type checking for generate_content_stream
---------
Co-authored-by: Eduard van Valkenburg <eavanvalkenburg@users.noreply.github.com>
* Python: Skip get_final_response in OTel _finalize_stream when stream errored
When a streaming error occurs, _finalize_stream (a cleanup hook registered by
AgentTelemetryLayer) was unconditionally calling get_final_response(), which
triggers all registered result hooks including after_run context providers.
This caused providers to fire incorrectly on error paths.
Guard against this by checking result_stream._consumed: True only after
StopAsyncIteration (normal completion), False when an exception was raised.
The fix applies to both the chat client and agent telemetry layers.
Closes#5231
* Python: Expose consumed/stream_error on ResponseStream and capture error in OTel span
Address Copilot review feedback on #5232:
- Add `_stream_error: Exception | None` to ResponseStream, set in __anext__'s
except branch so cleanup hooks can inspect the failure.
- Expose public `consumed` and `stream_error` properties to avoid coupling
observability.py to private stream internals.
- Update both _finalize_stream closures (chat and agent layers) to use the
public properties and call capture_exception() with the stream error before
returning early, ensuring the OTel span records the failure rather than
closing silently.
* Python: Address Copilot review feedback on stream error handling
- Use stream_error is not None as the guard in _finalize_stream instead of
not consumed, so the early-return path is keyed precisely to actual errors
rather than any non-normal completion state.
- Clear _stream_error after _run_cleanup_hooks() completes to avoid retaining
the exception traceback (and any large object graphs it references) on the
stream instance beyond the cleanup phase.
* Python: Remove consumed/stream_error properties, use private attrs directly
Per review feedback: since observability.py and _types.py are in the same
package, accessing _stream_error directly is fine and the public properties
are unnecessary.
* Python: Fix Pyright reportPrivateUsage via inline ignore comments
Keep _stream_error private (consistent with rest of ResponseStream), and
suppress reportPrivateUsage at the call sites in observability.py with
inline pyright: ignore comments — access is intentional within the package.
* AG-UI deterministic state updates from tool results
* fix(ag-ui): address PR #5201 review comments
1. Add missing AGUIEventConverter, AGUIHttpService, __version__ to
_IMPORTS in core ag_ui lazy-export list to match the .pyi stub.
2. Coalesce predictive and deterministic state snapshots into a single
StateSnapshotEvent when both mechanisms are active on the same tool
result, reducing redundant snapshot traffic.
3. Update state_update() docstring to clarify that a predictive snapshot
may be emitted before the deterministic one when predict_state_config
is active.
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
---------
Co-authored-by: Copilot <copilot@github.com>
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
* Fix HandoffBuilder dropping function-level middleware when cloning agents (#5173)
_clone_chat_agent() was using agent.agent_middleware (agent-level only)
instead of agent.middleware (all types), which silently dropped any
function middleware registered on the original agent.
Changed to use agent.middleware to preserve all middleware types
(agent, function, and chat) during cloning.
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
* Python: Fix HandoffBuilder dropping function-level middleware when cloning agents
Fixes#5173
* Fix false-positive middleware regression test (#5173)
The test used isinstance(m, FunctionMiddleware) which matched
_AutoHandoffMiddleware (always appended during build) instead of the
user's @function_middleware decorator. Assert directly that
tracking_middleware is present in the cloned agent's middleware list.
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
* Address review feedback for #5173: Python: [Bug]: HandoffBuilder drops function-level middleware when cloning agents
---------
Co-authored-by: Copilot <copilot@github.com>
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
* Python: Add allowed_checkpoint_types support to CosmosCheckpointStorage (#5200)
Add allowed_checkpoint_types parameter to CosmosCheckpointStorage for
parity with FileCheckpointStorage. This ensures both providers use the
same restricted pickle deserialization by default.
Changes:
- Accept allowed_checkpoint_types kwarg in __init__, stored as frozenset
- Convert _document_to_checkpoint from @staticmethod to instance method
- Forward allowed_types to decode_checkpoint_value on all load paths
- Update class docstring to describe the new parameter
- Add tests covering built-in safe types, app type opt-in/blocking,
and all load paths (load, list_checkpoints, get_latest)
- Add changelog entry noting the breaking behavior change
BREAKING CHANGE: CosmosCheckpointStorage now uses restricted pickle
deserialization by default. Checkpoints containing application-defined
types will require passing those types via allowed_checkpoint_types.
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
* Python: Add `allowed_checkpoint_types` support to `CosmosCheckpointStorage` for parity with `FileCheckpointStorage`
Fixes#5200
* Address PR review: add pickle security warning and fix docstring examples
- Reintroduce explicit security warning about pickle deserialization risks
- Convert Example:: block to .. code-block:: python with imports for
consistency with other docstring examples
- Note: PR title should be updated to include [BREAKING] prefix per
changelog convention (comment #3, requires GitHub UI change)
Fixes#5200
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
---------
Co-authored-by: Copilot <copilot@github.com>
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Evan Mattson ·
Giles Odigwe ·
Eduard van Valkenburg ·
Dineshsuriya D ·
Shubham Kumar ·
Tao Chen ·
S3rj ·
chetantoshniwal ·
L. Elaine Dazzio ·
Kartik Madan ·
Chinedum Echeta ·
Björn Holtvogt ·
Copilot ·