mirror of
https://github.com/microsoft/agent-framework.git
synced 2026-06-16 21:04:09 +08:00
westey
bad05a2bdc
* Add initial harness console for python * Add textual to project * Add planning and approval flows with list selector * Address PR comments * Fix list selection bug * Fix PR #6312 round 2 review comments - Escape untrusted agent text with rich.markup.escape() in observers (text_output, planning_output, reasoning_display) to prevent markup injection - Remove non-functional 'Always approve' choices from tool_approval.py (framework lacks CreateAlwaysApproveToolResponse support) - Remove textual from root pyproject.toml dev deps (sample-specific) - Add PEP 723 inline script metadata to harness_research.py - Narrow except Exception to except NoMatches in list_selection.py Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> * Fix build error * Fix build errors --------- Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
72 lines
2.4 KiB
Python
72 lines
2.4 KiB
Python
# Copyright (c) Microsoft. All rights reserved.
|
|
|
|
"""Pydantic models for structured planning output.
|
|
|
|
These models define the JSON schema that the agent produces when in planning
|
|
mode via `response_format`. The schema enables consistent rendering of
|
|
clarification questions and approval requests in the console UI.
|
|
"""
|
|
|
|
from __future__ import annotations
|
|
|
|
from enum import Enum
|
|
|
|
from pydantic import BaseModel, Field
|
|
|
|
|
|
class PlanningResponseType(str, Enum):
|
|
"""Type of planning response from the agent."""
|
|
|
|
CLARIFICATION = "clarification"
|
|
"""The agent needs clarification and presents options for the user to choose from."""
|
|
|
|
APPROVAL = "approval"
|
|
"""The agent is seeking approval to proceed with execution."""
|
|
|
|
|
|
class PlanningQuestion(BaseModel):
|
|
"""A single question or item within a PlanningResponse.
|
|
|
|
For clarification: contains the question text and optional choices.
|
|
For approval: contains the plan summary for the user to approve.
|
|
"""
|
|
|
|
message: str = Field(
|
|
description=(
|
|
"For clarifications, this has the question that needs to be clarified "
|
|
"with the user. For approvals, this would contain a summary of the "
|
|
"execution plan that the user needs to approve."
|
|
),
|
|
)
|
|
choices: list[str] | None = Field(
|
|
default=None,
|
|
description=(
|
|
"For clarifications, this has a list of options that the user can "
|
|
"choose from. null for approvals."
|
|
),
|
|
)
|
|
|
|
|
|
class PlanningResponse(BaseModel):
|
|
"""Structured response from the agent while in planning mode.
|
|
|
|
Used with structured output (`response_format`) to enable consistent
|
|
rendering of clarification questions and approval requests.
|
|
"""
|
|
|
|
type: PlanningResponseType = Field(
|
|
description=(
|
|
"Use 'clarification' when you need clarification around the user "
|
|
"request and you want to present the user with options to choose from. "
|
|
"Use 'approval' when you are ready to start execution, but need "
|
|
"approval to start executing."
|
|
),
|
|
)
|
|
questions: list[PlanningQuestion] = Field(
|
|
description=(
|
|
"For clarifications, this has one or more questions to ask the user "
|
|
"(each with choices). For approvals, this has exactly one item "
|
|
"containing the plan summary for the user to approve."
|
|
),
|
|
)
|