ChatHistoryKernelAgent Class

Definition

Namespace:

Microsoft.SemanticKernel.Agents

Assembly:

Microsoft.SemanticKernel.Agents.Core.dll

Package:

Microsoft.SemanticKernel.Agents.Core v1.20.0-alpha

A KernelAgent specialization bound to a ChatHistoryChannel.

public abstract class ChatHistoryKernelAgent : Microsoft.SemanticKernel.Agents.KernelAgent

type ChatHistoryKernelAgent = class
    inherit KernelAgent

Public MustInherit Class ChatHistoryKernelAgent
Inherits KernelAgent

Inheritance

Object

Agent

KernelAgent

ChatHistoryKernelAgent

Derived

Microsoft.SemanticKernel.Agents.ChatCompletionAgent

Remarks

NOTE: Enable OpenAIPromptExecutionSettings.FunctionChoiceBehavior for agent plugins. (Arguments)

Constructors

ChatHistoryKernelAgent()

Properties

Arguments	Optional arguments for the agent.
Description	The description of the agent (optional) (Inherited from Agent)
HistoryReducer	System.Object.HistoryReducer
Id	The identifier of the agent (optional). (Inherited from Agent)
Instructions	The instructions of the agent (optional) (Inherited from KernelAgent)
Kernel	The Kernel containing services, plugins, and filters for use throughout the agent lifetime. (Inherited from KernelAgent)
Logger	The ILogger associated with this Agent. (Inherited from Agent)
LoggerFactory	A ILoggerFactory for this Agent. (Inherited from Agent)
Name	The name of the agent (optional) (Inherited from Agent)

Methods

CreateChannelAsync(CancellationToken)	Produce the an AgentChannel appropriate for the agent type.
GetChannelKeys()	Set of keys to establish channel affinity. Minimum expected key-set: yield return typeof(YourAgentChannel).FullName;
InvokeAsync(ChatHistory, KernelArguments, Kernel, CancellationToken)	System.Object.InvokeAsync(Microsoft.SemanticKernel.ChatCompletion.ChatHistory,Microsoft.SemanticKernel.KernelArguments,Microsoft.SemanticKernel.Kernel,System.Threading.CancellationToken)
InvokeStreamingAsync(ChatHistory, KernelArguments, Kernel, CancellationToken)	System.Object.InvokeStreamingAsync(Microsoft.SemanticKernel.ChatCompletion.ChatHistory,Microsoft.SemanticKernel.KernelArguments,Microsoft.SemanticKernel.Kernel,System.Threading.CancellationToken)
ReduceAsync(ChatHistory, CancellationToken)	Reduce the provided history