Skip to main content

AI Chat

Feature NameAI Chat
Feature IDCrestApps.OrchardCore.AI.Chat

Provides UI to interact with AI models using the profiles.

AI Chat Feature​

The AI Chat feature builds upon the AI Services feature by adding AI chat capabilities. Once enabled, any chat-type AI profile with the "Show On Admin Menu" option will appear under the Artificial Intelligence section in the admin menu, allowing you to interact with your chat profiles.

Note: This feature does not provide completion client implementations (e.g., OpenAI, Azure OpenAI, etc.). To enable chat capabilities, you must enable at least one feature that implements an AI completion client, such as:

  • OpenAI AI Chat (CrestApps.OrchardCore.OpenAI): AI-powered chat using OpenAI service.
  • Azure OpenAI Chat (CrestApps.OrchardCore.OpenAI.Azure): AI services using Azure OpenAI models.
  • Azure AI Inference Chat (CrestApps.OrchardCore.AzureAIInference): AI services using Azure AI Inference (GitHub models) models.
  • Ollama AI Chat (CrestApps.OrchardCore.Ollama): AI-powered chat using Ollama service.

Welcome Message Behavior​

When an AI profile has a Welcome Message configured, it is displayed as placeholder text for new sessions. It is not automatically added to the model conversation history.

If Add initial prompt is enabled on the profile, the welcome message is ignored for new sessions. Instead, the session is created immediately with an assistant message from the configured Initial prompt, and that message appears in chat history when the page loads or when a new session is started.

Admin Chat User Interface​

Screen cast of the admin chat

Admin Chat Widget​

Feature NameAI Chat Admin Widget
Feature IDCrestApps.OrchardCore.AI.Chat.AdminWidget

Provides a floating AI chat widget on every admin page, allowing users to interact with a predefined AI profile.

The AI Chat Admin Widget adds a floating chat widget to the Orchard Core admin dashboard. This allows administrators to interact with AI directly from any admin page without navigating away.

Enabling the Admin Widget​

  1. Go to Tools > Features in the admin menu.
  2. Search for AI Chat Admin Widget and enable it.
  3. The floating chat widget will appear in the bottom-right corner of the admin dashboard.

Configuring the Admin Widget​

Navigate to Settings → Artificial Intelligence → Admin Widget to configure:

  • Profile: Select the AI chat profile to use for the admin widget.

  • Max Sessions: Set the maximum number of previous chat sessions displayed in the history panel (1–50).

  • Primary Color: Customize the widget's primary color (header, toggle button). Defaults to #41b670 (Orchard Core green).

  • :::tip Pro Tip It's best to enable Orchard Core AI Agent (i.e., CrestApps.OrchardCore.AI.Agent). Then when creating a profile, select all available capabilities to allow the profile to perform tasks on your website. :::

Frontend Chat Widget​

A frontend chat widget is available to add to your site's public-facing pages using the Orchard Core Widgets system. This allows site visitors to interact with AI chat directly on the frontend.

Adding the Frontend Widget​

  1. Ensure the Widgets feature (OrchardCore.Widgets) is enabled.
  2. Go to Design > Widgets in the admin menu.
  3. Add a new AI Chat Widget to the desired zone (e.g., Footer, Content).
  4. Configure the widget by selecting the AI chat profile and optionally choosing a prompt template.

Frontend Widget Screen Cast​

Screen cast of the frontend widget

Chat Analytics​

Feature NameAI Chat Analytics
Feature IDCrestApps.OrchardCore.AI.Chat.Analytics

Provides comprehensive analytics and reporting for AI chat sessions, including conversation metrics, performance tracking, user segmentation, and feedback analysis.

For complete documentation, see the AI Chat Analytics guide.