Providers
Providers are installable plugins that connect Umbraco.AI to AI services.
A provider is a NuGet package that enables Umbraco.AI to communicate with a specific AI service. Providers handle the details of API authentication, request formatting, and response parsing.
How Providers Work
Providers are discovered automatically when you install their NuGet package. They register themselves using the [AIProvider] attribute and implement the IAIProvider interface.
┌─────────────────────────────────────────────────────────────────────────────────┐
│ Umbraco.AI │
│ ┌─────────────────────────────────────────────────────────────────────────┐ │
│ │ Provider Registry │ │
│ │ ┌──────────┐ ┌───────────┐ ┌──────────┐ ┌─────────┐ ┌───────────────┐ │ │
│ │ │ OpenAI │ │ Anthropic │ │ Google │ │ Amazon │ │ MS AI Foundry │ │ │
│ │ │ Provider │ │ Provider │ │ Provider │ │ Bedrock │ │ Provider │ │ │
│ │ └──────────┘ └───────────┘ └──────────┘ └─────────┘ └───────────────┘ │ │
│ └─────────────────────────────────────────────────────────────────────────┘ │
└─────────────────────────────────────────────────────────────────────────────────┘Available Providers
OpenAI
Umbraco.AI.OpenAI
Chat, Embedding, Speech-to-Text
Anthropic
Umbraco.AI.Anthropic
Chat
Google Gemini
Umbraco.AI.Google
Chat
Amazon Bedrock
Umbraco.AI.Amazon
Chat, Embedding
Microsoft AI Foundry
Umbraco.AI.MicrosoftFoundry
Chat, Embedding
Alibaba Cloud Model Studio
Umbraco.AI.Alibaba
Chat, Embedding
Moonshot AI
Umbraco.AI.Moonshot
Chat
OpenRouter
Umbraco.AI.OpenRouter
Chat
Z.AI
Umbraco.AI.ZAI
Chat
Provider Discovery
Providers are discovered at application startup through assembly scanning. Any class with the [AIProvider] attribute that implements IAIProvider is automatically registered.
Provider Settings
Each provider defines its own settings class. Common settings include:
API Key
Authentication credential
Endpoint
API URL (for custom endpoints)
Organization
Organization identifier (if applicable)
Settings are defined using the [AIField] attribute:
Provider Capabilities
A provider can support multiple capabilities:
Chat - Conversational AI and text generation
Embedding - Vector embeddings for semantic search
Speech-to-Text - Audio transcription and voice input
Each capability is implemented as a separate class and registered in the provider constructor.
Accessing Providers in Code
You rarely need to interact with providers directly. The service layer handles provider resolution based on the profile's connection.
If you need to access provider information:
Creating Custom Providers
You can create providers for AI services not yet supported. See:
Related
Connections - Store credentials for a provider
Capabilities - The operations a provider supports
Last updated
Was this helpful?