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

Files

T

Eduard van Valkenburg 838a7fd61d Python: [BREAKING] Types API Review improvements (#3647 )

* Replace Role and FinishReason classes with NewType + Literal

- Remove EnumLike metaclass from _types.py
- Replace Role class with NewType('Role', str) + RoleLiteral
- Replace FinishReason class with NewType('FinishReason', str) + FinishReasonLiteral
- Update all usages across codebase to use string literals
- Remove .value access patterns (direct string comparison now works)
- Add backward compatibility for legacy dict serialization format
- Update tests to reflect new string-based types

Addresses #3591, #3615

* Simplify ChatResponse and AgentResponse type hints (#3592)

- Remove overloads from ChatResponse.__init__
- Remove text parameter from ChatResponse.__init__
- Remove | dict[str, Any] from finish_reason and usage_details params
- Remove **kwargs from AgentResponse.__init__
- Both now accept ChatMessage | Sequence[ChatMessage] | None for messages
- Update docstrings and examples to reflect changes
- Fix tests that were using removed kwargs
- Fix Role type hint usage in ag-ui utils

* Remove text parameter from ChatResponseUpdate and AgentResponseUpdate (#3597)

- Remove text parameter from ChatResponseUpdate.__init__
- Remove text parameter from AgentResponseUpdate.__init__
- Remove **kwargs from both update classes
- Simplify contents parameter type to Sequence[Content] | None
- Update all usages to use contents=[Content.from_text(...)] pattern
- Fix imports in test files
- Update docstrings and examples

* Rename from_chat_response_updates to from_updates (#3593)

- ChatResponse.from_chat_response_updates → ChatResponse.from_updates
- ChatResponse.from_chat_response_generator → ChatResponse.from_update_generator
- AgentResponse.from_agent_run_response_updates → AgentResponse.from_updates

* Remove try_parse_value method from ChatResponse and AgentResponse (#3595)

- Remove try_parse_value method from ChatResponse
- Remove try_parse_value method from AgentResponse
- Remove try_parse_value calls from from_updates and from_update_generator methods
- Update samples to use try/except with response.value instead
- Update tests to use response.value pattern
- Users should now use response.value with try/except for safe parsing

* Add agent_id to AgentResponse and clarify author_name documentation (#3596)

- Add agent_id parameter to AgentResponse class
- Document that author_name is on ChatMessage objects, not responses
- Update ChatResponse docstring with author_name note
- Update AgentResponse docstring with author_name note

* Simplify ChatMessage.__init__ signature (#3618)

- Make contents a positional argument accepting Sequence[Content | str]
- Auto-convert strings in contents to TextContent
- Remove overloads, keep text kwarg for backward compatibility with serialization
- Update _parse_content_list to handle string items
- Update all usages across codebase to use new format: ChatMessage("role", ["text"])

* Allow Content as input on run and get_response

- Update prepare_messages and normalize_messages to accept Content
- Update type signatures in _agents.py and _clients.py
- Add tests for Content input handling

* Fix ChatMessage usage across packages and samples

Update all remaining ChatMessage(role=..., text=...) to use new
ChatMessage('role', ['text']) signature.

* Fix Role string usage and response format parsing

- Fix redis provider: remove .value access on string literals
- Fix durabletask ensure_response_format: set _response_format before accessing .value

* Fix ollama .value and ai_model_id issues, handle None in content list

- Fix ollama _chat_client: remove .value on string literals
- Fix ollama _chat_client: rename ai_model_id to model_id
- Fix _parse_content_list: skip None values gracefully

* Fix A2AAgent type signature to include Content

* Fix Role/FinishReason NewType dict annotations and improve test coverage to 95%

* Fix mypy errors for Role/FinishReason NewType usage

* Fix Role.TOOL and Role.ASSISTANT usage in _orchestrator_helpers.py

* Fix Role NewType usage in durabletask _models.py

838a7fd61d · 2026-02-04 10:13:23 +00:00

History

azure_ai_chat_client.py

Python: [BREAKING] Types API Review improvements (#3647 )

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

azure_assistants_client.py

Python: [BREAKING] Types API Review improvements (#3647 )

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

azure_chat_client.py

Python: [BREAKING] Types API Review improvements (#3647 )

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

azure_responses_client.py

Python: [BREAKING] Types API Review improvements (#3647 )

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

chat_response_cancellation.py

Agents + Chat Client Samples Doctsring Updates (#1028 )

2025-10-01 07:18:53 +00:00

openai_assistants_client.py

Python: [BREAKING] Types API Review improvements (#3647 )

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

openai_chat_client.py

Python: [BREAKING] Types API Review improvements (#3647 )

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

openai_responses_client.py

Python: [BREAKING] Types API Review improvements (#3647 )

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

README.md

Fix Ollama model env var in documentation (#3156 )

2026-01-12 14:15:49 +00:00

typed_options.py

Python: [BREAKING]: Introducing Options as TypedDict and Generic (#3140 )

2026-01-13 16:41:05 +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.

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.