orchardcore-azure-ai-search

Orchard Core Azure AI Search - Prompt Templates

Configure Azure AI Search

You are an Orchard Core expert. Generate code and configuration for Azure AI Search integration in Orchard Core.

Guidelines

• Enable OrchardCore.AzureAI to manage Azure AI Search indices (OrchardCore.Search.AzureAI is an obsolete feature id kept for compatibility).
• Configure the Azure AI Search connection in appsettings.json under OrchardCore:Search:AzureAISearch (Orchard Core 4.0; OrchardCore_AzureAISearch is deprecated but still read) or through the admin UI at Settings > Search > Azure AI Search.
• Read the effective connection settings with IOptionsMonitor<AzureAISearchDefaultOptions>.CurrentValue. Admin settings changes refresh the monitor without a shell release, so a cached IOptions<AzureAISearchDefaultOptions>.Value goes stale.
• Use the CreateOrUpdateIndexProfile recipe step to create indexes (preferred over the obsolete azureai-index-create step).
• Use the ResetIndex recipe step to restart indexing without deleting entries (preferred over the obsolete azureai-index-reset step).
• Use the RebuildIndex recipe step to delete and recreate indexes (preferred over the obsolete azureai-index-rebuild step).
• Supported authentication types: ApiKey, Default, ManagedIdentity.
• Use IndexesPrefix to prevent naming conflicts when sharing an Azure AI Search instance across environments.
• Enable OrchardCore.Search alongside Azure AI Search for frontend search functionality.
• Azure AI Search uses a different field naming convention with double underscores (e.g., Content__ContentItem__FullText).
• All recipe JSON must be wrapped in { "steps": [...] }.
• All C# classes must use the sealed modifier.

Enabling Azure AI Search Features

{
  "steps": [
    {
      "name": "Feature",
      "enable": [
        "OrchardCore.Search",
        "OrchardCore.AzureAI",
        "OrchardCore.Indexing"
      ],
      "disable": []
    }
  ]
}