orchardcore-ai-response-handlers

Orchard Core Chat Response Handlers

Route a chat prompt to a handler

IChatResponseHandler is a shared CrestApps.Core contract used by Orchard chat sessions and chat interactions. A handler either returns response updates now or defers the assistant response until an external system supplies it.

using CrestApps.Core.AI.ResponseHandling;

namespace MyCompany.OrchardCore.Chat;

public sealed class LiveAgentResponseHandler : IChatResponseHandler
{
    public string Name => "LiveAgent";

    public async Task<ChatResponseHandlerResult> HandleAsync(
        ChatResponseHandlerContext context,
        CancellationToken cancellationToken = default)
    {
        await SendToAgentSystemAsync(context.Prompt, cancellationToken);

        return ChatResponseHandlerResult.Deferred();
    }

    private static Task SendToAgentSystemAsync(
        string prompt,
        CancellationToken cancellationToken)
    {
        return Task.CompletedTask;
    }
}

Register a custom handler as an enumerable scoped service:

using CrestApps.Core.AI.ResponseHandling;
using Microsoft.Extensions.DependencyInjection;

services.TryAddEnumerable(
    ServiceDescriptor.Scoped<IChatResponseHandler, LiveAgentResponseHandler>());

The active handler is selected from AIChatSession.ResponseHandlerName or ChatInteraction.ResponseHandlerName. The built-in AI path handles the normal case. Do not claim a custom handler is selected for a Conversation-mode session without checking the active chat feature's resolver behavior.

Return streaming or deferred output

Use Deferred() only when the handler has handed work to an external process that will deliver the reply later. The hub persists the user prompt and does not wait for an assistant response.

For immediate output, return an async sequence of ChatResponseUpdate values:

using CrestApps.Core.AI.ResponseHandling;
using Microsoft.Extensions.AI;

return ChatResponseHandlerResult.Streaming(StreamUpdatesAsync(cancellationToken));

static async IAsyncEnumerable<ChatResponseUpdate> StreamUpdatesAsync(
    [System.Runtime.CompilerServices.EnumeratorCancellation] CancellationToken cancellationToken)
{
    yield return new ChatResponseUpdate(ChatRole.Assistant, "Connecting you to an agent.");
    await Task.CompletedTask;
}