Skip to main content
net10.0

Umbraco AI

Published
Aug 20, 2026
1mo ago
Total Downloads
48.3K
48,288

Install

dotnet add package Umbraco.AI --version 17.4.0-rc.1
ProductVersions
.NET
net10.0

README

Umbraco.AI

Umbraco.AI is an AI integration package for Umbraco CMS that provides a unified way to connect and interact with AI providers. Built on top of Microsoft.Extensions.AI, it offers a provider-agnostic abstraction layer with Umbraco-specific features like connections, profiles, and configurable middleware.

Features

  • Provider-agnostic architecture - Support for multiple AI providers (OpenAI, Azure, and more) through a common interface
  • Connection management - Configure and manage multiple AI provider connections with different credentials and settings
  • Profiles - Create reusable AI profiles with predefined settings (temperature, max tokens, model selection)
  • Contexts - Define reusable AI contexts containing brand voice, guidelines, and reference materials that enrich AI operations
  • Tools - Register custom AI tools that can be invoked by AI models for function calling scenarios
  • Middleware pipeline - Extensible middleware system for logging, caching, rate limiting, and custom processing
  • Chat completions - Full support for chat-based AI interactions with streaming capabilities
  • Embeddings - Generate text embeddings for semantic search and similarity matching
  • Backoffice integration - Management UI integrated into the Umbraco backoffice

Project Structure

  • Umbraco.AI.Core - Core abstractions, providers, services, and models
  • Umbraco.AI.Persistence - EF Core DbContext, entities, and repository implementations
  • Umbraco.AI.Persistence.SqlServer - SQL Server migrations for persistence layer
  • Umbraco.AI.Persistence.Sqlite - SQLite migrations for persistence layer
  • Umbraco.AI.Web - Management API and backoffice endpoints
  • Umbraco.AI.Web.StaticAssets - Frontend assets for backoffice UI
  • Umbraco.AI.Startup - Composition and startup configuration
  • Umbraco.AI - Meta-package that references all components

Monorepo Context

This package is part of the Umbraco.AI monorepo. Provider packages are also included in the monorepo:

  • Umbraco.AI.OpenAI - Located in ../Umbraco.AI.OpenAI/
  • Umbraco.AI.Anthropic - Located in ../Umbraco.AI.Anthropic/
  • Umbraco.AI.Amazon - Located in ../Umbraco.AI.Amazon/
  • Umbraco.AI.Google - Located in ../Umbraco.AI.Google/
  • Umbraco.AI.MicrosoftFoundry - Located in ../Umbraco.AI.MicrosoftFoundry/

Getting Started

Installation

dotnet add package Umbraco.AI

Local Development

For local development and testing, use the monorepo setup script from the repository root:

# From repository root
.\scripts\install-demo-site.ps1  # Windows
./scripts/install-demo-site.sh   # Linux/Mac

This creates a unified solution (Umbraco.AI.local.slnx) with all packages and a demo site. See the root README for details.

Documentation

License

This project is licensed under the MIT License. See LICENSE.md for details.

Changes from Previous Version

No structural changes between v17.3.5 and v17.4.0-rc.1.

Adoption Assessment

A verified publisher signal is available. Assess fit from the package's supported frameworks, license and dependency graph rather than popularity alone.

This version is marked prerelease. Validate its API and upgrade path before production use.No SPDX license expression is published. Review the license text and your organisation's policy before redistribution.Compatibility metadata lists 1 target framework; confirm the exact target used by your application.

Related Guides & Workflows

Learn how to evaluate, integrate, or audit this package in your .NET project.