Skip to content

Commit 2bcb404

Browse files
learn-build-service-prod[bot]moonbox3gewarrensophialagerkranspandeyeavanvalkenburg
authored
Repo sync for protected branch (#217)
* Add python process how-to guides * Improve Python agent learn site samples. * Fix spurious zone-end tag * Ingestion -> injection * Include links to repo code. * Remove fixed locale from link * Fix python sample resource link * Use site relative links for learn site links. They don't need to be absolute. * Fix media link * Scope link per language * More cleanup * Add prompt template config import. Remove view from link in Python code pivot. * Updates to callout reserved param names with Python function calling. * updated filters page * Python: merge Python docs updates from live to main (#464) * Improve Python agent learn site samples. * Include links to repo code. * Remove fixed locale from link * Fix python sample resource link * Use site relative links for learn site links. They don't need to be absolute. * Fix media link * Scope link per language * More cleanup * Add prompt template config import. Remove view from link in Python code pivot. * Updates to callout reserved param names with Python function calling. * Add Python processes sample code. * fixed headings * removed heading * added notes on ordering * try inline zone * fix bullet * single line zone * small text updates * added new sample links * fix indentation * polish * Update semantic-kernel/Frameworks/process/examples/example-cycles.md Co-authored-by: Copilot <[email protected]> * Update semantic-kernel/Frameworks/process/examples/example-cycles.md Co-authored-by: Copilot <[email protected]> * Update semantic-kernel/Frameworks/process/examples/example-first-process.md Co-authored-by: Copilot <[email protected]> * Update semantic-kernel/Frameworks/process/examples/example-cycles.md Co-authored-by: Copilot <[email protected]> * OpenAI not Open AI (#468) * Fix unsupported distance functions in samples * Update Agent Framework related doc and code samples. Add migration code for Python (#469) (#473) * Update OpenAI assistant related code samples. Add migration code for Python * improve migration guide * Update semantic-kernel/support/migration/openai-assistant-agent-migration-guide.md * Update semantic-kernel/support/migration/openai-assistant-agent-migration-guide.md * Replace italics with code format. * update bookmarks * Update Python docs * Add dotnet migration guide. * update formatting in migration guide * fix headers * Fix header again * update guide to include rc * Small update to include new method get_response * Update important tags with some experimental (group chat) and some release candidate --------- Co-authored-by: Copilot <[email protected]> * Merge main to live: updating Migration Guide title (#477) * Update Agent Framework related doc and code samples. Add migration code for Python (#469) * Update OpenAI assistant related code samples. Add migration code for Python * improve migration guide * Update semantic-kernel/support/migration/openai-assistant-agent-migration-guide.md Co-authored-by: Copilot <[email protected]> * Update semantic-kernel/support/migration/openai-assistant-agent-migration-guide.md Co-authored-by: Copilot <[email protected]> * Replace italics with code format. * update bookmarks * Update Python docs * Add dotnet migration guide. * update formatting in migration guide * fix headers * Fix header again * update guide to include rc * Small update to include new method get_response * Update important tags with some experimental (group chat) and some release candidate --------- Co-authored-by: Copilot <[email protected]> * Update title (#474) --------- Co-authored-by: Copilot <[email protected]> --------- Co-authored-by: Evan Mattson <[email protected]> Co-authored-by: Genevieve Warren <[email protected]> Co-authored-by: Sophia Lagerkrans-Pandey <[email protected]> Co-authored-by: eavanvalkenburg <[email protected]> Co-authored-by: Evan Mattson <[email protected]> Co-authored-by: Ben Thomas <[email protected]> Co-authored-by: Copilot <[email protected]> Co-authored-by: Eric Urban <[email protected]> Co-authored-by: westey <[email protected]>
1 parent 7227dae commit 2bcb404

38 files changed

+2209
-636
lines changed

Diff for: README.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
# Microsoft Semantic Kernel Documentation
22

3-
This is the GitHub repository for the technical product documentation for **Semantic Kernel**. This documentation is published at [Microsoft Semantic Kernel documentation](https://learn.microsoft.com/semantic-kernel).
3+
This is the GitHub repository for the technical product documentation for **Semantic Kernel**. This documentation is published at [Microsoft Semantic Kernel documentation](/semantic-kernel).
44

55
## How to contribute
66

7-
Thanks for your interest in [contributing](https://learn.microsoft.com/), home of technical content for Microsoft products and services.
7+
Thanks for your interest in contributing to the home of technical content for Microsoft products and services.
88

9-
To learn how to make contributions to the content in this repository, start with our [Docs contributor guide](https://learn.microsoft.com/contribute).
9+
To learn how to make contributions to the content in this repository, start with our [Docs contributor guide](/contribute).
1010

1111
## Code of conduct
1212

Diff for: semantic-kernel/Frameworks/agent/TOC.yml

+1-1
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
href: agent-architecture.md
55
- name: Chat Completion Agent
66
href: chat-completion-agent.md
7-
- name: Open AI Assistant Agent
7+
- name: OpenAI Assistant Agent
88
href: assistant-agent.md
99
- name: Agent Collaboration
1010
href: agent-chat.md

Diff for: semantic-kernel/Frameworks/agent/agent-architecture.md

+17-17
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
title: Semantic Kernel Agent Architecture (Experimental)
2+
title: Semantic Kernel Agent Architecture
33
description: An overview of the architecture of the Semantic Kernel Agent Framework and how it aligns with core Semantic Kernel features.
44
zone_pivot_groups: programming-languages
55
author: crickman
@@ -10,15 +10,15 @@ ms.service: semantic-kernel
1010
---
1111
# An Overview of the Agent Architecture
1212

13-
> [!WARNING]
14-
> The *Semantic Kernel Agent Framework* is in preview and is subject to change.
13+
> [!IMPORTANT]
14+
> Single-agent features, such as ChatCompletionAgent and OpenAIAssistantAgent, are in the release candidate stage. These features are nearly complete and generally stable, though they may undergo minor refinements or optimizations before reaching full general availability. However, agent chat patterns are still in the experimental stage. These patterns are under active development and may change significantly before advancing to the preview or release candidate stage.
1515
1616
This article covers key concepts in the architecture of the Agent Framework, including foundational principles, design objectives, and strategic goals.
1717

1818

1919
## Goals
2020

21-
The _Agent Framework_ was developed with the following key priorities in mind:
21+
The `Agent Framework` was developed with the following key priorities in mind:
2222

2323
- The _Semantic Kernel_ framework serves as the core foundation for implementing agent functionalities.
2424
- Multiple agents can collaborate within a single conversation, while integrating human input.
@@ -28,7 +28,7 @@ The _Agent Framework_ was developed with the following key priorities in mind:
2828

2929
## Agent
3030

31-
The abstract _Agent_ class serves as the core abstraction for all types of agents, providing a foundational structure that can be extended to create more specialized agents. One key subclass is _Kernel Agent_, which establishes a direct association with a [_Kernel_](../../concepts/kernel.md) object. This relationship forms the basis for more specific agent implementations, such as the [_Chat Completion Agent_](./chat-completion-agent.md) and the [_Open AI Assistant Agent_](./assistant-agent.md), both of which leverage the Kernel's capabilities to execute their respective functions.
31+
The abstract `Agent` class serves as the core abstraction for all types of agents, providing a foundational structure that can be extended to create more specialized agents. One key subclass is _Kernel Agent_, which establishes a direct association with a [`Kernel`](../../concepts/kernel.md) object. This relationship forms the basis for more specific agent implementations, such as the [`ChatCompletionAgent`](./chat-completion-agent.md) and the [`OpenAIAssistantAgent`](./assistant-agent.md), both of which leverage the Kernel's capabilities to execute their respective functions.
3232

3333
::: zone pivot="programming-language-csharp"
3434

@@ -49,7 +49,7 @@ The abstract _Agent_ class serves as the core abstraction for all types of agent
4949
5050
::: zone-end
5151

52-
Agents can either be invoked directly to perform tasks or orchestrated within an [_Agent Chat_](./agent-chat.md), where multiple agents may collaborate or interact dynamically with user inputs. This flexible structure allows agents to adapt to various conversational or task-driven scenarios, providing developers with robust tools for building intelligent, multi-agent systems.
52+
Agents can either be invoked directly to perform tasks or orchestrated within an [`AgentChat`](./agent-chat.md), where multiple agents may collaborate or interact dynamically with user inputs. This flexible structure allows agents to adapt to various conversational or task-driven scenarios, providing developers with robust tools for building intelligent, multi-agent systems.
5353

5454
#### Deep Dive:
5555

@@ -64,7 +64,7 @@ Agents can either be invoked directly to perform tasks or orchestrated within an
6464

6565
## Agent Chat
6666

67-
The [_Agent Chat_](./agent-chat.md) class serves as the foundational component that enables agents of any type to engage in a specific conversation. This class provides the essential capabilities for managing agent interactions within a chat environment. Building on this, the [_Agent Group Chat_](./agent-chat.md#creating-an-agent-group-chat) class extends these capabilities by offering a stategy-based container, which allows multiple agents to collaborate across numerous interactions within the same conversation.
67+
The [`AgentChat`](./agent-chat.md) class serves as the foundational component that enables agents of any type to engage in a specific conversation. This class provides the essential capabilities for managing agent interactions within a chat environment. Building on this, the [`AgentGroupChat`](./agent-chat.md#creating-an-agentgroupchat) class extends these capabilities by offering a stategy-based container, which allows multiple agents to collaborate across numerous interactions within the same conversation.
6868

6969
This structure facilitates more complex, multi-agent scenarios where different agents can work together, share information, and dynamically respond to evolving conversations, making it an ideal solution for advanced use cases such as customer support, multi-faceted task management, or collaborative problem-solving environments.
7070

@@ -74,7 +74,7 @@ This structure facilitates more complex, multi-agent scenarios where different a
7474

7575
## Agent Channel
7676

77-
The _Agent Channel_ class enables agents of various types to participate in an [_Agent Chat_](./agent-chat.md). This functionality is completely hidden from users of the _Agent Framework_ and only needs to be considered by developers creating a custom [_Agent_](#agent).
77+
The _Agent Channel_ class enables agents of various types to participate in an [`AgentChat`](./agent-chat.md). This functionality is completely hidden from users of the `Agent Framework` and only needs to be considered by developers creating a custom [`Agent`](#agent).
7878

7979
::: zone pivot="programming-language-csharp"
8080

@@ -96,14 +96,14 @@ The _Agent Channel_ class enables agents of various types to participate in an [
9696

9797
## Agent Alignment with _Semantic Kernel_ Features
9898

99-
The _Agent Framework_ is built on the foundational concepts and features that many developers have come to know within the _Semantic Kernel_ ecosystem. These core principles serve as the building blocks for the Agent Framework’s design. By leveraging the familiar structure and capabilities of the _Semantic Kernel_, the Agent Framework extends its functionality to enable more advanced, autonomous agent behaviors, while maintaining consistency with the broader _Semantic Kernel_ architecture. This ensures a smooth transition for developers, allowing them to apply their existing knowledge to create intelligent, adaptable agents within the framework.
99+
The `Agent Framework` is built on the foundational concepts and features that many developers have come to know within the _Semantic Kernel_ ecosystem. These core principles serve as the building blocks for the Agent Framework’s design. By leveraging the familiar structure and capabilities of the _Semantic Kernel_, the Agent Framework extends its functionality to enable more advanced, autonomous agent behaviors, while maintaining consistency with the broader _Semantic Kernel_ architecture. This ensures a smooth transition for developers, allowing them to apply their existing knowledge to create intelligent, adaptable agents within the framework.
100100

101101

102-
### The _Kernel_
102+
### The `Kernel`
103103

104-
At the heart of the _Semantic Kernel_ ecosystem is the [_Kernel_](../../concepts/kernel.md), which serves as the core object that drives AI operations and interactions. To create any agent within this framework, a _Kernel instance_ is required as it provides the foundational context and capabilities for the agent’s functionality. The _Kernel_ acts as the engine for processing instructions, managing state, and invoking the necessary AI services that power the agent's behavior.
104+
At the heart of the Semantic Kernel ecosystem is the [`Kernel`](../../concepts/kernel.md), which serves as the core object that drives AI operations and interactions. To create any agent within this framework, a _Kernel instance_ is required as it provides the foundational context and capabilities for the agent’s functionality. The `Kernel` acts as the engine for processing instructions, managing state, and invoking the necessary AI services that power the agent's behavior.
105105

106-
The [_Chat Completion Agent_](./chat-completion-agent.md) and [_Open AI Assistant Agent_](./assistant-agent.md) articles provide specific details on how to create each type of agent.
106+
The [`ChatCompletionAgent`](./chat-completion-agent.md) and [`OpenAIAssistantAgent`](./assistant-agent.md) articles provide specific details on how to create each type of agent.
107107
These resources offer step-by-step instructions and highlight the key configurations needed to tailor the agents to different conversational or task-based applications, demonstrating how the Kernel enables dynamic and intelligent agent behaviors across diverse use cases.
108108

109109
#### Related API's:
@@ -136,7 +136,7 @@ Plugins are a fundamental aspect of the _Semantic Kernel_, enabling developers t
136136

137137
#### Example:
138138

139-
- [How-To: _Chat Completion Agent_](./examples/example-chat-agent.md)
139+
- [How-To: `ChatCompletionAgent`](./examples/example-chat-agent.md)
140140

141141
#### Related API's:
142142

@@ -169,7 +169,7 @@ Plugins are a fundamental aspect of the _Semantic Kernel_, enabling developers t
169169

170170
Agent messaging, including both input and response, is built upon the core content types of the _Semantic Kernel_, providing a unified structure for communication. This design choice simplifies the process of transitioning from traditional chat-completion patterns to more advanced agent-driven patterns in your application development. By leveraging familiar _Semantic Kernel_ content types, developers can seamlessly integrate agent capabilities into their applications without needing to overhaul existing systems. This streamlining ensures that as you evolve from basic conversational AI to more autonomous, task-oriented agents, the underlying framework remains consistent, making development faster and more efficient.
171171

172-
> Note: The [_Open AI Assistant Agent_`_](./assistant-agent.md) introduced content types specific to its usage for _File References_ and _Content Annotation_:
172+
> Note: The [`OpenAIAssistantAgent`](./assistant-agent.md) introduced content types specific to its usage for _File References_ and _Content Annotation_:
173173
174174
#### Related API's:
175175

@@ -205,13 +205,13 @@ Agent messaging, including both input and response, is built upon the core conte
205205

206206
### [Templating](./agent-templates.md)
207207

208-
An agent's role is primarily shaped by the instructions it receives, which dictate its behavior and actions. Similar to invoking a _Kernel_ [prompt](../../concepts/prompts/index.md), an agent's instructions can include templated parameters—both values and functions—that are dynamically substituted during execution. This enables flexible, context-aware responses, allowing the agent to adjust its output based on real-time input.
208+
An agent's role is primarily shaped by the instructions it receives, which dictate its behavior and actions. Similar to invoking a `Kernel` [prompt](../../concepts/prompts/index.md), an agent's instructions can include templated parameters—both values and functions—that are dynamically substituted during execution. This enables flexible, context-aware responses, allowing the agent to adjust its output based on real-time input.
209209

210210
Additionally, an agent can be configured directly using a _Prompt Template Configuration_, providing developers with a structured and reusable way to define its behavior. This approach offers a powerful tool for standardizing and customizing agent instructions, ensuring consistency across various use cases while still maintaining dynamic adaptability.
211211

212212
#### Example:
213213

214-
- [How-To: _Chat Completion Agent_](./examples/example-chat-agent.md)
214+
- [How-To: `ChatCompletionAgent`](./examples/example-chat-agent.md)
215215

216216
#### Related API's:
217217

@@ -245,7 +245,7 @@ Additionally, an agent can be configured directly using a _Prompt Template Confi
245245

246246
### [Chat Completion](./chat-completion-agent.md)
247247

248-
The [_Chat Completion Agent_](./chat-completion-agent.md) is designed around any _Semantic Kernel_ [AI service](../../concepts/ai-services/chat-completion/index.md), offering a flexible and convenient persona encapsulation that can be seamlessly integrated into a wide range of applications. This agent allows developers to easily bring conversational AI capabilities into their systems without having to deal with complex implementation details. It mirrors the features and patterns found in the underlying [AI service](../../concepts/ai-services/chat-completion/index.md), ensuring that all functionalities—such as natural language processing, dialogue management, and contextual understanding—are fully supported within the [_Chat Completion Agent_](./chat-completion-agent.md), making it a powerful tool for building conversational interfaces.
248+
The [`ChatCompletionAgent`](./chat-completion-agent.md) is designed around any _Semantic Kernel_ [AI service](../../concepts/ai-services/chat-completion/index.md), offering a flexible and convenient persona encapsulation that can be seamlessly integrated into a wide range of applications. This agent allows developers to easily bring conversational AI capabilities into their systems without having to deal with complex implementation details. It mirrors the features and patterns found in the underlying [AI service](../../concepts/ai-services/chat-completion/index.md), ensuring that all functionalities—such as natural language processing, dialogue management, and contextual understanding—are fully supported within the [`ChatCompletionAgent`](./chat-completion-agent.md), making it a powerful tool for building conversational interfaces.
249249

250250
#### Related API's:
251251

0 commit comments

Comments
 (0)