Files
Eduard van Valkenburg 0521f5bed8 Python: [BREAKING] Simplify API: ChatAgent -> Agent, ChatMessage -> Message (#3747)
* [BREAKING] Rename ChatAgent -> Agent, ChatMessage -> Message, ChatClientProtocol -> SupportsChatGetResponse

Simplify the public API by removing redundant 'Chat' prefix from core types:
- ChatAgent -> Agent
- RawChatAgent -> RawAgent
- ChatMessage -> Message
- ChatClientProtocol -> SupportsChatGetResponse

Also renamed internal WorkflowMessage (was Message in _runner_context) to avoid collision.

No backward compatibility aliases - this is a clean breaking change.

* [BREAKING] Rename Agent chat_client parameter to client

* Fix rebase issues: WorkflowMessage references and broken markdown links

* Fix formatting and lint issues from code quality checks

* Fix import ordering in workflow sample files

* fixed rebase

* Fix test failures: use WorkflowMessage and A2AMessage after ChatMessage→Message rename

- Replace Message(data=..., source_id=...) with WorkflowMessage(...) in workflow tests
- Fix isinstance check in A2A agent to use A2AMessage instead of Message
- Fix import in test_workflow_observability.py (Message→WorkflowMessage)

* Fix lint, fmt, and sample errors after ChatMessage→Message rename

- Auto-fix 70+ ruff lint issues across samples (ChatMessage→Message refs)
- Fix HostedVectorStoreContent→Content.from_hosted_vector_store in file search sample
- Fix _normalize_messages→normalize_messages in custom agent sample
- Fix context.terminate→raise MiddlewareTermination in middleware samples
- Fix with_update_hook→with_transform_hook in override middleware sample
- Add TOptions_co import back to custom_chat_client sample
- Add noqa for FastAPI File() default in chatkit sample
- Fix B023 loop variable capture in weather agent sample

* fix: update Agent constructor calls from chat_client to client in declaration-only tool tests

* fix: add register_cleanup to devui lazy-loading proxy and type stub

* fixed tests and updated new pieces

* fix agui typevar

* fix merge errors

* fix merge conflicts

* fiux merge

* Remove unused links

---------

Co-authored-by: Evan Mattson <evan.mattson@microsoft.com>
0521f5bed8 · 2026-02-10 23:04:32 +00:00
History
..

Microsoft Agent Framework Python Weather Agent sample (M365 Agents SDK)

This sample demonstrates a simple Weather Forecast Agent built with the Python Microsoft Agent Framework, exposed through the Microsoft 365 Agents SDK compatible endpoints. The agent accepts natural language requests for a weather forecast and responds with a textual answer. It supports multi-turn conversations to gather required information.

Prerequisites

Configuration

Set the following environment variables:

# Common
export PORT=3978
export USE_ANONYMOUS_MODE=True # set to false if using auth

# OpenAI
export OPENAI_API_KEY="..."
export OPENAI_CHAT_MODEL_ID="..."

Installing Dependencies

From the repository root or the sample folder:

uv sync

Running the Agent Locally

# Activate environment first if not already
source .venv/bin/activate   # (Windows PowerShell: .venv\Scripts\Activate.ps1)

# Run the weather agent demo
python m365_agent_demo/app.py

The agent starts on http://localhost:3978. Health check: GET /api/health.

QuickStart using Agents Playground

  1. Install (if not already):

    winget install agentsplayground
    
  2. Start the Python agent locally: python m365_agent_demo/app.py

  3. Start the playground: agentsplayground

  4. Chat with the Weather Agent.

QuickStart using WebChat (Azure Bot)

To test via WebChat you can provision an Azure Bot and point its messaging endpoint to your agent.

  1. Create an Azure Bot (choose Client Secret auth for local tunneling).

  2. Create a .env file in this sample folder with the following (replace placeholders):

    # Authentication / Agentic configuration
    USE_ANONYMOUS_MODE=False
    CONNECTIONS__SERVICE_CONNECTION__SETTINGS__CLIENTID="<client-id>"
    CONNECTIONS__SERVICE_CONNECTION__SETTINGS__CLIENTSECRET="<client-secret>"
    CONNECTIONS__SERVICE_CONNECTION__SETTINGS__TENANTID="<tenant-id>"
    CONNECTIONS__SERVICE_CONNECTION__SETTINGS__SCOPES=https://graph.microsoft.com/.default
    
    AGENTAPPLICATION__USERAUTHORIZATION__HANDLERS__AGENTIC__SETTINGS__TYPE=AgenticUserAuthorization
    AGENTAPPLICATION__USERAUTHORIZATION__HANDLERS__AGENTIC__SETTINGS__SCOPES=https://graph.microsoft.com/.default
    AGENTAPPLICATION__USERAUTHORIZATION__HANDLERS__AGENTIC__SETTINGS__ALTERNATEBLUEPRINTCONNECTIONNAME=https://graph.microsoft.com/.default
    
  3. Host dev tunnel:

    devtunnel host -p 3978 --allow-anonymous
    
  4. Set the bot Messaging endpoint to: https://<tunnel-host>/api/messages

  5. Run your local agent: python m365_agent_demo/app.py

  6. Use "Test in WebChat" in Azure Portal.

Federated Credentials or Managed Identity auth types typically require deployment to Azure App Service instead of tunneling.

Troubleshooting

  • 404 on /api/messages: Ensure you are POSTing and using the correct tunnel URL.
  • Empty responses: Check model key / quota and ensure environment variables are set.
  • Auth errors when anonymous disabled: Validate MSAL config matches your Azure Bot registration.

Further Reading