From 170c2c715ab4e071754615cd72f888f55ec16bce Mon Sep 17 00:00:00 2001 From: Copilot <198982749+Copilot@users.noreply.github.com> Date: Mon, 29 Sep 2025 23:59:50 +0000 Subject: [PATCH] Python: Update README files: Fill empty documentation and expand minimal content (#980) * Initial plan * Fill empty python/samples README and expand dotnet custom implementation README Co-authored-by: dmytrostruk <13853051+dmytrostruk@users.noreply.github.com> * Fix broken documentation links in main README Co-authored-by: dmytrostruk <13853051+dmytrostruk@users.noreply.github.com> * Fix installation instructions in Python main package README Co-authored-by: dmytrostruk <13853051+dmytrostruk@users.noreply.github.com> * Address PR feedback: revert main README and Python package README, remove empty prerequisites section and repository link Co-authored-by: dmytrostruk <13853051+dmytrostruk@users.noreply.github.com> --------- Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com> Co-authored-by: dmytrostruk <13853051+dmytrostruk@users.noreply.github.com> --- .../Agent_With_CustomImplementation/README.md | 17 +++++++++++-- python/samples/README.md | 25 +++++++++++++++++++ 2 files changed, 40 insertions(+), 2 deletions(-) diff --git a/dotnet/samples/GettingStarted/AgentProviders/Agent_With_CustomImplementation/README.md b/dotnet/samples/GettingStarted/AgentProviders/Agent_With_CustomImplementation/README.md index 97eb3e87d3..b0b69dc9f5 100644 --- a/dotnet/samples/GettingStarted/AgentProviders/Agent_With_CustomImplementation/README.md +++ b/dotnet/samples/GettingStarted/AgentProviders/Agent_With_CustomImplementation/README.md @@ -1,3 +1,16 @@ -# Prerequisites +# Agent with Custom Implementation + +This sample demonstrates how to create a fully custom agent implementation without relying on external AI services. + +## Overview + +The sample creates a simple "parrot" agent that: +- Converts user input to uppercase +- Supports both synchronous and streaming invocation modes +- Demonstrates the complete implementation requirements for a custom agent + +This pattern is useful when you need to: +- Integrate with custom AI models or services +- Create rule-based agents without AI +- Build agents with specific custom logic -This sample has no prerequisites. \ No newline at end of file diff --git a/python/samples/README.md b/python/samples/README.md index e69de29bb2..887fadd5a8 100644 --- a/python/samples/README.md +++ b/python/samples/README.md @@ -0,0 +1,25 @@ +# Python Samples + +This directory contains samples demonstrating the capabilities of Microsoft Agent Framework for Python. + +## Getting Started + +For step-by-step tutorials and examples, see the [getting_started](./getting_started/) directory: + +- **[Agents](./getting_started/agents/)** - Learn how to create and use agents with various providers (Azure OpenAI, OpenAI, Azure AI, etc.) +- **[Workflow](./getting_started/workflow/)** - Explore workflow patterns for orchestrating multiple agents +- **[Chat Client](./getting_started/chat_client/)** - Examples of using chat clients directly +- **[Threads](./getting_started/threads/)** - Manage conversation threads and chat message stores +- **[Context Providers](./getting_started/context_providers/)** - Integrate with context providers like Mem0 and Redis +- **[Middleware](./getting_started/middleware/)** - Add middleware for logging, telemetry, and custom processing +- **[Multimodal Input](./getting_started/multimodal_input/)** - Handle images and other multimodal inputs +- **[Observability](./getting_started/observability/)** - Add tracing and monitoring to your agents + +## Sample Guidelines + +For information on creating new samples, see [SAMPLE_GUIDELINES.md](./SAMPLE_GUIDELINES.md). + +## More Information + +- [Python Package Documentation](../README.md) +