Agents + Chat Client Samples Doctsring Updates (#1028)

* agents + chat client samples doctsring updates

* fixes
This commit is contained in:
Giles Odigwe
2025-10-01 00:18:53 -07:00
committed by GitHub
Unverified
parent 3d04517877
commit b88143b686
68 changed files with 511 additions and 45 deletions
@@ -17,18 +17,8 @@ from agent_framework import (
"""
Custom Agent Implementation Example
This sample demonstrates how to implement a custom agent by extending the BaseAgent class.
Custom agents provide complete control over the agent's behavior and capabilities, allowing
developers to create specialized agents that don't rely on chat clients.
This approach is useful when you need to:
- Implement agents with custom logic that doesn't involve LLM interactions
- Create agents that integrate with specialized APIs or services
- Build agents with deterministic behaviors
- Implement new agent types for the Microsoft Agent Framework
The EchoAgent example shows the minimal requirements for implementing a custom agent,
including both streaming and non-streaming response handling.
This sample demonstrates implementing a custom agent by extending BaseAgent class,
showing the minimal requirements for both streaming and non-streaming responses.
"""
@@ -20,20 +20,8 @@ from agent_framework import (
"""
Custom Chat Client Implementation Example
This sample demonstrates how to implement a custom chat client by extending the BaseChatClient class.
Custom chat clients allow you to integrate any backend service or create new LLM providers
for the Microsoft Agent Framework.
This approach is useful when you need to:
- Integrate with new or proprietary LLM services
- Create mock implementations for testing
- Add custom authentication or routing logic
- Implement specialized preprocessing or postprocessing of requests and responses
- Create new LLM providers that work seamlessly with the framework's ChatAgent
The EchoingChatClient example shows the minimal requirements for implementing a custom chat client,
including both streaming and non-streaming response handling, and demonstrates how to use the
custom client with ChatAgent through the create_agent() method.
This sample demonstrates implementing a custom chat client by extending BaseChatClient class,
showing integration with ChatAgent and both streaming and non-streaming responses.
"""