Skip to content

Python: Clarify require_confirmation docstring to reflect confirm_changes HITL gating #6884

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
Serjbory wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Python: Clarify require_confirmation docstring to reflect confirm_changes HITL gating #6884

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
10 changes: 8 additions & 2 deletions python/packages/ag-ui/agent_framework_ag_ui/_agent.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,10 @@ def __init__(
state_schema: Optional state schema for state management; accepts dict or Pydantic model/class
predict_state_config: Configuration for predictive state updates
use_service_session: Whether the agent session is service-managed
require_confirmation: Whether predictive updates require user confirmation before applying
require_confirmation: When True (default), emit a ``confirm_changes`` tool call for
approval-gated tools so a human-in-the-loop frontend can prompt for approval, and require
confirmation for predictive state updates. When False, no ``confirm_changes`` call is
emitted; tools remain gated server-side.
snapshot_store: Optional AG-UI Thread Snapshot store. Snapshot persistence remains inactive unless
endpoint setup also provides an explicit Snapshot Scope resolver.
"""
Expand Down Expand Up @@ -94,7 +97,10 @@ def __init__(
description: Optional description
state_schema: Optional state schema for state management; accepts dict or Pydantic model/class
predict_state_config: Configuration for predictive state updates
require_confirmation: Whether predictive updates require user confirmation before applying
require_confirmation: When True (default), emit a ``confirm_changes`` tool call for
approval-gated tools so a human-in-the-loop frontend can prompt for approval, and require
confirmation for predictive state updates. When False, no ``confirm_changes`` call is
emitted; tools remain gated server-side.
use_service_session: Whether the agent session is service-managed
snapshot_store: Optional AG-UI Thread Snapshot store. Snapshot persistence remains inactive unless
endpoint setup also provides an explicit Snapshot Scope resolver.
Expand Down