mirror of https://github.com/microsoft/agent-framework.git synced 2026-06-16 21:04:09 +08:00

Files

T

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

azure_ai_chat_client.py

Python: [BREAKING] Moved to a single get_response and run API (#3379 )

2026-02-05 20:09:58 +00:00

azure_assistants_client.py

Python: [BREAKING] Moved to a single get_response and run API (#3379 )

2026-02-05 20:09:58 +00:00

azure_chat_client.py

Python: [BREAKING] Moved to a single get_response and run API (#3379 )

2026-02-05 20:09:58 +00:00

azure_responses_client.py

Python: Add samples syntax checking with pyright (#3710 )

2026-02-07 07:10:47 +00:00

chat_response_cancellation.py

Python: [BREAKING] Simplify API: ChatAgent -> Agent, ChatMessage -> Message (#3747 )

2026-02-10 23:04:32 +00:00

custom_chat_client.py

Python: [BREAKING] Simplify API: ChatAgent -> Agent, ChatMessage -> Message (#3747 )

2026-02-10 23:04:32 +00:00

openai_assistants_client.py

Python: [BREAKING] Moved to a single get_response and run API (#3379 )

2026-02-05 20:09:58 +00:00

openai_chat_client.py

Python: [BREAKING] Moved to a single get_response and run API (#3379 )

2026-02-05 20:09:58 +00:00

openai_responses_client.py

Python: Add samples syntax checking with pyright (#3710 )

2026-02-07 07:10:47 +00:00

README.md

Python: [BREAKING] Simplify API: ChatAgent -> Agent, ChatMessage -> Message (#3747 )

2026-02-10 23:04:32 +00:00

README.md

Chat Client Examples

This folder contains simple examples demonstrating direct usage of various chat clients.

Examples

File	Description
`azure_assistants_client.py`	Direct usage of Azure Assistants Client for basic chat interactions with Azure OpenAI assistants.
`azure_chat_client.py`	Direct usage of Azure Chat Client for chat interactions with Azure OpenAI models.
`azure_responses_client.py`	Direct usage of Azure Responses Client for structured response generation with Azure OpenAI models.
`chat_response_cancellation.py`	Demonstrates how to cancel chat responses during streaming, showing proper cancellation handling and cleanup.
`azure_ai_chat_client.py`	Direct usage of Azure AI Chat Client for chat interactions with Azure AI models.
`openai_assistants_client.py`	Direct usage of OpenAI Assistants Client for basic chat interactions with OpenAI assistants.
`openai_chat_client.py`	Direct usage of OpenAI Chat Client for chat interactions with OpenAI models.
`openai_responses_client.py`	Direct usage of OpenAI Responses Client for structured response generation with OpenAI models.
`custom_chat_client.py`	Demonstrates how to create custom chat clients by extending the `BaseChatClient` class. Shows a `EchoingChatClient` implementation and how to integrate it with `Agent` using the `as_agent()` method.

Environment Variables

Depending on which client you're using, set the appropriate environment variables:

For Azure clients:

AZURE_OPENAI_ENDPOINT: Your Azure OpenAI endpoint
AZURE_OPENAI_CHAT_DEPLOYMENT_NAME: The name of your Azure OpenAI chat deployment
AZURE_OPENAI_RESPONSES_DEPLOYMENT_NAME: The name of your Azure OpenAI responses deployment

For Azure AI client:

AZURE_AI_PROJECT_ENDPOINT: Your Azure AI project endpoint
AZURE_AI_MODEL_DEPLOYMENT_NAME: The name of your model deployment

For OpenAI clients:

OPENAI_API_KEY: Your OpenAI API key
OPENAI_CHAT_MODEL_ID: The OpenAI model to use for chat clients (e.g., gpt-4o, gpt-4o-mini, gpt-3.5-turbo)
OPENAI_RESPONSES_MODEL_ID: The OpenAI model to use for responses clients (e.g., gpt-4o, gpt-4o-mini, gpt-3.5-turbo)

For Ollama client:

OLLAMA_HOST: Your Ollama server URL (defaults to http://localhost:11434 if not set)
OLLAMA_MODEL_ID: The Ollama model to use for chat (e.g., llama3.2, llama2, codellama)

Note

: For Ollama, ensure you have Ollama installed and running locally with at least one model downloaded. Visit https://ollama.com/ for installation instructions.