AgentGroupChat Class

Definition

Namespace:: Microsoft.SemanticKernel.Agents

Assembly:: Microsoft.SemanticKernel.Agents.Core.dll

Package:: Microsoft.SemanticKernel.Agents.Core v1.45.0

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Represents an AgentChat that supports multi-turn interactions.

public sealed class AgentGroupChat : Microsoft.SemanticKernel.Agents.AgentChat

type AgentGroupChat = class
    inherit AgentChat

Public NotInheritable Class AgentGroupChat
Inherits AgentChat

Inheritance: Object

AgentChat
AgentGroupChat

Constructors

AgentGroupChat(Agent[])

Initializes a new instance of the AgentGroupChat class.

Properties

Agents	Gets the agents participating in the chat.
ExecutionSettings	Gets or sets the settings for defining chat behavior.
History	Gets the internal history to expose it to subclasses. (Inherited from AgentChat)
IsActive	Gets a value that indicates whether a chat operation is active. Activity is defined as any execution of a public method. (Inherited from AgentChat)
IsComplete	Gets or sets a value that indicates if the completion criteria have been met.
Logger	Gets the ILogger associated with this chat. (Inherited from AgentChat)
LoggerFactory	Gets the ILoggerFactory associated with the AgentChat. (Inherited from AgentChat)

Methods

AddAgent(Agent)	Add an Agent to the chat.
AddChatMessage(ChatMessageContent)	Appends a message to the conversation. Adding a message while an agent is active is not allowed. (Inherited from AgentChat)
AddChatMessages(IReadOnlyList<ChatMessageContent>)	Appends messages to the conversation. Adding messages while an agent is active is not allowed. (Inherited from AgentChat)
CreatePromptFunctionForStrategy(String, IPromptTemplateFactory, String[])	Creates a KernelFunction for a given strategy without HTML-encoding the specified parameters.
GetChatMessagesAsync(Agent, CancellationToken)	Retrieves the message history, either the primary history or an agent-specific version. (Inherited from AgentChat)
GetChatMessagesAsync(CancellationToken)	Retrieves the chat history. (Inherited from AgentChat)
InvokeAgentAsync(Agent, CancellationToken)	Processes a discrete incremental interaction between a single Agent and a AgentChat. (Inherited from AgentChat)
InvokeAsync(Agent, CancellationToken)	Processes a single interaction between a given Agent and an AgentGroupChat.
InvokeAsync(CancellationToken)	Processes a series of interactions between the Agents that have joined this AgentGroupChat.
InvokeStreamingAgentAsync(Agent, CancellationToken)	Processes a discrete incremental interaction between a single Agent and a AgentChat. (Inherited from AgentChat)
InvokeStreamingAsync(Agent, CancellationToken)	Processes a single interaction between a given Agent and an AgentGroupChat.
InvokeStreamingAsync(CancellationToken)	Processes a series of interactions between the Agents that have joined this AgentGroupChat.
ResetAsync(CancellationToken)	Resets the chat, clearing all history and persisted state. All agents will remain present. (Inherited from AgentChat)
SetActivityOrThrow()	Checks to ensure the chat is not concurrently active and throws an exception if it is. If not, activity is signaled. (Inherited from AgentChat)

Applies to