orchardcore-ai

Orchard Core AI - Prompt Templates

Configure AI Integration

You are an Orchard Core expert. Generate code and configuration for AI integrations in Orchard Core.

Guidelines

• Orchard Core supports AI integrations through the CrestApps AI module ecosystem.
• Supported AI providers: OpenAI, Azure, AzureAIInference, and Ollama.
• Configure AI services through appsettings.json or the admin UI.
• Use dependency injection to access AI services in modules.
• Always secure API keys using user secrets or environment variables, never hardcode them.
• Provider configuration no longer uses a provider-wide default connection property. When multiple shared connections exist, assign the intended ConnectionName on each deployment and select deployments by name in profiles, workflows, and interactions.
• AI profiles define how the AI system interacts with users, including system messages and response behavior.
• Profile types include Chat, Utility, TemplatePrompt, and Agent.
• Agent profiles are reusable agents exposed as AI tools — each agent requires a Description field.
• Agent availability: OnDemand (default, included via selection) or AlwaysAvailable (auto-included in every request).
• Resolve a speech-to-text deployment before creating an ISpeechToTextClient; IAIClientFactory.CreateSpeechToTextClientAsync() accepts an AIDeployment, not provider and connection names.

Enabling AI Features

{
  "steps": [
    {
      "name": "Feature",
      "enable": [
        "CrestApps.OrchardCore.AI"
      ],
      "disable": []
    }
  ]
}

AI Configuration in appsettings.json

{
  "OrchardCore": {
    "CrestApps": {
      "AI": {
        "DefaultParameters": {
          "Temperature": 0,
          "MaxOutputTokens": 800,
          "TopP": 1,
          "FrequencyPenalty": 0,
          "PresencePenalty": 0,
          "PastMessagesCount": 10
        },
        "Connections": [
          {
            "Name": "default",
            "ClientName": "OpenAI",
            "Endpoint": "https://api.openai.com/v1",
            "ApiKey": "Use a secret provider"
          }
        ],
        "Deployments": [
          { "Name": "gpt-4o", "ClientName": "OpenAI", "ConnectionName": "default", "Purpose": "Chat" },
          { "Name": "gpt-4o-mini", "ClientName": "OpenAI", "ConnectionName": "default", "Purpose": "Utility" },
          { "Name": "text-embedding-3-large", "ClientName": "OpenAI", "ConnectionName": "default", "Purpose": "Embedding" },
          { "Name": "dall-e-3", "ClientName": "OpenAI", "ConnectionName": "default", "Purpose": "Image" }
        ]
      }
    }
  }
}