Class ConsoleChatModule

Namespace

Prefrontal.Modules.Chat.Text

Assembly

Prefrontal.Modules.dll

public class ConsoleChatModule : Module

Inheritance

object

Module

ConsoleChatModule

Inherited Members

Module.Agent

Module.IsPartOfAgent

Module.Debug

Module.GetModuleOrDefault<T>()

Module.SendSignal<TSignal, TResponse>(TSignal, bool)

Module.SendSignalAsync<TSignal, TResponse>(TSignal)

Module.SendSignal<TSignal>(TSignal)

Module.SendSignalAsync<TSignal>(TSignal)

Module.ReceiveSignals<TSignal, TResponse>(Func<TSignal, TResponse>)

Module.ReceiveSignalsAsync<TSignal, TResponse>(Func<TSignal, Task<TResponse>>)

Module.ReceiveSignals<TSignal>(Action<TSignal>)

Module.ReceiveSignalsAsync<TSignal>(Func<TSignal, Task>)

Module.InterceptSignalsAsync<TSignal, TResponse>(Func<SignalContext<TSignal, TResponse>, IAsyncEnumerable<TResponse>>)

Module.InterceptSignalsAsync<TSignal>(Func<SignalContext<TSignal, object>, IAsyncEnumerable<object>>)

Module.ToString()

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

Extension Methods

ModuleExtensions.RequestLLM(Module)

ModuleExtensions.RequestLLM<TMessage>(Module)

ModuleExtensions.RequestAsync<T>(Module)

ModuleExtensions.RequestAsync<TRequest, T>(Module, TRequest)

ModuleExtensions.Request<T>(Module)

ModuleExtensions.Request<TRequest, T>(Module, TRequest)

XEnumerable.Tap<TEnumerable, T>(TEnumerable, Func<TEnumerable, T>, out T)

Constructors

ConsoleChatModule(ChatModule)

public ConsoleChatModule(ChatModule _)

Parameters

_ ChatModule

Methods

RunAsync(CancellationToken)

Override this method in a derived class to run the module's main logic.

• Do not call this method directly.
• Call Agent.RunAsync() to run all the modules in parallel.
• Returning from this method means the module has completed its primary task and won't be called again during the same Agent.RunAsync() call.
• The RunningModuleExceptionPolicy passed to Agent.RunAsync() controls what happens when this method throws an exception.
• The CancellationToken passed to this method signals that the method should stop running and return. This can happen when module is removed, the Stop() method is called or the agent is disposed of.
• To keep the module's logic running indefinitely, you can override this method and run a loop like so:

  protected override async Task RunAsync(CancellationToken cancellationToken)
  {
  	while(!cancellationToken.IsCancellationRequested)
  	{
  		// Your module's logic here
  	}
  }

protected override Task RunAsync(CancellationToken cancellationToken)

Parameters

cancellationToken CancellationToken

A CancellationToken whose cancellation signals that the module should stop running.

Returns

Task