Azure OpenAI Integration

Feature Name	Azure OpenAI Chat
Feature ID	CrestApps.OrchardCore.OpenAI.Azure

Provides AI services using Azure OpenAI models.

Overview

The Azure OpenAI Chat feature integrates seamlessly with Azure OpenAI. Enable this feature to use Azure OpenAI models for AI chat profiles, deployments, and connections.

Configuration

Add the following section to your appsettings.json to configure Azure OpenAI:

{
  "OrchardCore": {
    "CrestApps_AI": {
      "Providers": {
        "Azure": {
          "DefaultConnectionName": "<!-- Default connection name -->",
          "Connections": {
            "<!-- Unique connection name, ideally your Azure AccountName -->": {
              "Endpoint": "https://<!-- Your Azure Resource Name -->.openai.azure.com/",
              "AuthenticationType": "ApiKey",
              "ApiKey": "<!-- API Key for your Azure AI instance -->",
              "Deployments": [
                { "Name": "<!-- chat model deployment -->", "Type": "Chat", "IsDefault": true },
                { "Name": "<!-- utility model deployment -->", "Type": "Utility", "IsDefault": true },
                { "Name": "<!-- embedding model deployment -->", "Type": "Embedding", "IsDefault": true },
                { "Name": "<!-- image model deployment -->", "Type": "Image", "IsDefault": true }
              ]
            }
          }
        }
      }
    }
  }
}

Legacy Format (Deprecated)

The following format using ChatDeploymentName, UtilityDeploymentName, EmbeddingDeploymentName, and ImagesDeploymentName at both provider and connection levels is still supported but deprecated. Existing configurations will be auto-migrated at runtime.

{
  "Connections": {
    "my-azure-account": {
      "Endpoint": "https://my-account.openai.azure.com/",
      "AuthenticationType": "ApiKey",
      "ApiKey": "...",
      "ChatDeploymentName": "gpt-4o",
      "UtilityDeploymentName": "gpt-4o-mini",
      "EmbeddingDeploymentName": "text-embedding-ada-002",
      "ImagesDeploymentName": "dall-e-3"
    }
  }
}

Valid values for AuthenticationType are: Default, ManagedIdentity, or ApiKey. If using ApiKey, the ApiKey field is required.

When using ManagedIdentity, you can optionally provide an IdentityId to use a user-assigned managed identity. If IdentityId is omitted or empty, the system-assigned managed identity is used.

{
  "Connections": {
    "my-azure-account": {
      "Endpoint": "https://my-account.openai.azure.com/",
      "AuthenticationType": "ManagedIdentity",
      "IdentityId": "<!-- Optional: client ID of a user-assigned managed identity -->"
    }
  }
}

How to Retrieve Azure OpenAI Credentials

Get the API Key and Endpoint

1. Open the Azure Portal and navigate to your Azure OpenAI instance.
2. Go to Resource Management > Keys and Endpoint.
3. Copy the Endpoint.
4. Copy one of the two available API keys.

Azure OpenAI Chat Feature

This feature allows the creation of AI profiles using Azure OpenAI chat capabilities.

Recipe Configuration

Define an AI profile with the following step in your recipe:

{
  "steps": [
    {
      "name": "AIProfile",
      "profiles": [
        {
          "Source": "Azure",
          "Name": "ExampleProfile",
          "DisplayText": "Example Profile",
          "WelcomeMessage": "What do you want to know?",
          "FunctionNames": [],
          "Type": "Chat",
          "TitleType": "InitialPrompt",
          "PromptTemplate": null,
          "ConnectionName": "<!-- Connection name (optional) -->",
          "ChatDeploymentId": "<!-- Chat Deployment ID (optional) -->",
          "UtilityDeploymentId": "<!-- Utility Deployment ID (optional) -->",
          "Properties": {
            "AIProfileMetadata": {
              "SystemMessage": "You are an AI assistant that helps people find information.",
              "Temperature": null,
              "TopP": null,
              "FrequencyPenalty": null,
              "PresencePenalty": null,
              "MaxTokens": null,
              "PastMessagesCount": null
            }
          }
        }
      ]
    }
  ]
}

tip

AI Profiles now use ChatDeploymentId and UtilityDeploymentId instead of the previous single DeploymentId field. This allows profiles to specify separate deployments for chat completions and auxiliary utility tasks.

RAG / Data Sources

Data sources and RAG are now implemented in the provider-agnostic CrestApps.OrchardCore.AI.DataSources module.

See: AI Data Sources