Skip to content

Conversation

Copilot
Copy link
Contributor

@Copilot Copilot AI commented Aug 19, 2025

This PR adds comprehensive documentation that addresses confusion about which AI client integrations are compatible with which AI hosting integrations in .NET Aspire.

The new article (docs/azureai/ai-integrations-compatibility-matrix.md) provides:

Compatibility Matrix

A comprehensive table showing compatibility between hosting integrations and client integrations:

Hosting Integration Aspire.OpenAI Aspire.Azure.AI.OpenAI Aspire.Azure.AI.Inference
Aspire.Hosting.Azure.AI.Foundry ❌ No ⚠️ Partial ✅ Yes (preferred)
Aspire.Hosting.Azure.CognitiveServices ❌ No ✅ Yes (preferred) ❌ No
Aspire.Hosting.OpenAI ✅ Yes (preferred) ✅ Yes ❌ No
Aspire.Hosting.GitHub.Models ⚠️ Partial ❌ No ✅ Yes (preferred)

Key Features

  • Clear visual indicators using emojis to show Yes/No/Partial compatibility
  • Recommended pairings with practical guidance and code examples for each scenario
  • Clear separation between hosting and client integration code with dedicated sections
  • NuGet package links for all integrations to help developers find the right packages
  • Connection string format documentation explaining how each hosting integration generates connection strings and what each client integration expects
  • General guidance: Use Aspire.Azure.AI.Inference for Azure hosted models, or Aspire.OpenAI for direct OpenAI connections

Structure

Each integration pairing section includes:

  • Hosting integration subsection with NuGet package link and app host code
  • Client integration subsection with NuGet package link and service project code

This clear separation helps developers understand which code belongs in which project and which packages to install where.

Technical Details

The article includes detailed connection string formats for both hosting and client integrations, helping developers understand the underlying mechanics of how these integrations communicate with each other.

This documentation directly addresses the issue where developers were confused about which clients to use when deploying models on the variety of hosting platforms that Aspire supports.

Fixes #4273.


💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.


Internal previews

📄 File 🔗 Preview link
docs/azureai/ai-integrations-compatibility-matrix.md Aspire AI integrations compatibility matrix
docs/toc.yml docs/toc

Co-authored-by: davidfowl <95136+davidfowl@users.noreply.github.com>
@Copilot Copilot AI changed the title [WIP] [New article]: AI hosting/client integrations compatibility Add AI integrations compatibility matrix documentation Aug 19, 2025
@Copilot Copilot AI requested a review from davidfowl August 19, 2025 23:43
Copilot finished work on behalf of davidfowl August 19, 2025 23:43
@IEvangelist IEvangelist marked this pull request as ready for review August 20, 2025 12:26
…links

Co-authored-by: IEvangelist <7679720+IEvangelist@users.noreply.github.com>
Copilot finished work on behalf of IEvangelist August 20, 2025 12:49
@Copilot Copilot AI requested a review from IEvangelist August 20, 2025 12:49
@IEvangelist IEvangelist enabled auto-merge (squash) August 20, 2025 14:58
@IEvangelist IEvangelist merged commit 617d676 into main Aug 20, 2025
9 checks passed
@IEvangelist IEvangelist deleted the copilot/fix-4273 branch August 20, 2025 14:59
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[New article]: AI hosting/client integrations compatibility
3 participants