Add a script to produce docs by language, and add multi-turn-conversation docs (#510)

* Add a script to produce docs by language, and add multi-turn-conversation docs.

* Fix typo.

* Remove java pivots, move source templates and update comments.

* Add links to docs from root readme
This commit is contained in:
westey
2025-08-28 11:19:24 +01:00
committed by GitHub
Unverified
parent 529341f58b
commit 802c8e6238
20 changed files with 524 additions and 59 deletions
+15
View File
@@ -0,0 +1,15 @@
# Microsoft Agent Framework
## Overview
The Microsoft Agent Framework provides a set of tools and libraries to help developers create intelligent agents that can interact with users in natural language as well as orchestrate those agents together to perform complex tasks.
The framework is the successor of the Semantic Kernel and AutoGen agent frameworks.
## See also
- [Getting Started](./getting-started/)
- [Migration Guide](./migration-guide/)
- [User Guide](./user-guide/)
- [Samples](../../dotnet/samples)
@@ -0,0 +1,7 @@
# Microsoft Agent Framework Getting Started
This guide will help you get up and running quickly with a basic agent using the Agent Framework and Azure OpenAI.
## Coming Soon
@@ -0,0 +1,5 @@
# Microsoft Agent Framework for .NET Concepts
- [Agent Types](./agent-types.md)
- [Multi-turn conversations and Threading](./multi-turn-conversations.md)
@@ -0,0 +1,37 @@
# Microsoft Agent Framework Agent Types
The Microsoft Agent Framework provides support for several types of agents to accommodate different use cases and requirements.
All agents are derived from a common base class, `AIAgent`, which provides a consistent interface for all agent types. This allows for building common, agent agnostic, higher level functionality such as multi-agent orchestrations.
Let's dive into each agent type in more detail.
## Simple agents based on inference services
The agent framework makes it easy to create simple agents based on many different inference services.
Any inference service that provides a ChatClient implementation can be used to build these agents.
These agents support a wide range of functionality out of the box:
1. Function calling
1. Multi-turn conversations with local chat history management or service provided chat history management
1. Custom service provided tools (e.g. MCP, Code Execution)
1. Structured output
To create one of these agents, simply construct a `ChatClientAgent` using the ChatClient implementation of your choice.
## Complex custom agents
It is also possible to create fully custom agents, that are not just wrappers around a ChatClient.
The agent framework provides the `AIAgent` base type, which when subclassed allows for complete control over the agent's behavior and capabilities.
## Remote agents
The agent framework provides out of the box `AIAgent` subclasses for common service hosted agent protocols,
such as A2A.
## Pre-built agents
To be added.
@@ -0,0 +1,50 @@
# Microsoft Agent Framework Multi-Turn Conversations and Threading
The Microsoft Agent Framework provides built-in support for managing multi-turn conversations with AI agents. This includes maintaining context across multiple interactions. Different agent types and underlying services that are used to build agents may support different threading types, and the agent framework abstracts these differences away, providing a consistent interface for developers.
For example, when using a ChatClientAgent based on a foundry agent, the conversation history is persisted in the service. While, when using a ChatClientAgent based on chat completion with gpt-4.1 the conversation history is in-memory and managed by the agent.
The differences between the underlying threading models are abstracted away via the `AgentThread` type.
## AgentThread lifecycle
### AgentThread Creation
`AgentThread` instances can be created in two ways:
1. By calling `GetNewThread` on the agent.
1. By running the agent and not providing an `AgentThread`. In this case the agent will create a throwaway `AgentThread` with an underlying thread which will only be used for the duration of the run.
Some underlying threads may be persistently created in an underlying service, where the service requires this, e.g. Foundry Agents or OpenAI Responses. Any cleanup or deletion of these threads is the responsibility of the user.
### AgentThread Storage
`AgentThread` instances can be serialized and stored for later use. This allows for the preservation of conversation context across different sessions or service calls.
For cases where the conversation history is stored in a service, the serialized `AgentThread` will contain an
id of the thread in the service.
For cases where the conversation history is managed in-memory, the serialized `AgentThread` will contain the messages
themselves.
## Agent/AgentThread relationship
`AIAgent` instances are stateless and the same agent instance can be used with multiple `AgentThread` instances.
Not all agents support all thread types though. For example if you are using a `ChatClientAgent` with the responses service, `AgentThread` instances created by this agent, will not work with a `ChatClientAgent` using the Foundry Agent service.
This is because these services both support saving the conversation history in the service, and the `AgentThread`
only has a reference to this service managed thread.
It is therefore considered unsafe to use an `AgentThread` instance that was created by one agent with a different agent instance, unless you are aware of the underlying threading model and its implications.
## Threading support by service / protocol
| Service | Threading Support |
|---------|--------------------|
| Foundry Agents | Service managed persistent threads |
| OpenAI Responses | Service managed persistent threads OR in-memory threads |
| OpenAI ChatCompletion | In-memory threads |
| OpenAI Assistants | Service managed threads |
| A2A | Service managed threads |