Add Aspire support to chat template #6102

MackinnonBuck · 2025-03-13T19:39:04Z

Adds an Aspire option to the AI Chat Web template.

All the existing AI service providers and vector databases are supported, and a new Qdrant option is now enabled when using Aspire.

Fixes #6052

Microsoft Reviewers: Open in CodeFlow

eng/Versions.props

…spire

MackinnonBuck · 2025-03-18T04:56:27Z

...ates/Microsoft.Extensions.AI.Templates/src/ChatWithCustomData/.template.config/template.json

+    },
+    "IsAspire": {
+      "type": "computed",
+      "value": "(UseAspire || VectorStore == \"qdrant\")"


(UseAspire || VectorStore == "qdrant")

This is because Qdrant is only supported in the Aspire variation of the template. If there's a way for the template engine to disallow certain combinations of options (I couldn't seem to find one), then that's an alternative to consider.

....Extensions.AI.Templates/src/ChatWithCustomData/ChatWithCustomData-CSharp.AppHost/Program.cs

...AI.Templates/src/ChatWithCustomData/ChatWithCustomData-CSharp.Web/Directory.Build.targets.in

...rc/ChatWithCustomData/ChatWithCustomData-CSharp.Web/Services/Ingestion/PDFDirectorySource.cs

MackinnonBuck · 2025-03-18T05:02:33Z

...I.Templates/src/ChatWithCustomData/ChatWithCustomData-CSharp.Web/Services/JsonVectorStore.cs

-            foreach (var clause in options?.Filter?.FilterClauses ?? [])
+            if (options?.Filter is { } filter)
            {
-                if (clause is EqualToFilterClause equalClause)
-                {
-                    var propertyInfo = typeof(TRecord).GetProperty(equalClause.FieldName);
-                    filteredRecords = filteredRecords.Where(record => propertyInfo!.GetValue(record)!.Equals(equalClause.Value));
-                }
-                else
-                {
-                    throw new NotSupportedException($"The provided filter clause type {clause.GetType().FullName} is not supported.");
-                }
+                filteredRecords = filteredRecords.AsQueryable().Where(filter);
            }

-            var ranked = (from record in filteredRecords
-                          let candidateVector = _getVector(record)
-                          let similarity = TensorPrimitives.CosineSimilarity(candidateVector.Span, floatVector.Span)
-                          orderby similarity descending
-                          select (Record: record, Similarity: similarity));
+            var ranked = from record in filteredRecords
+                         let candidateVector = _getVector(record)
+                         let similarity = TensorPrimitives.CosineSimilarity(candidateVector.Span, floatVector.Span)
+                         orderby similarity descending
+                         select (Record: record, Similarity: similarity);


These changes are all reacting to updating the Microsoft.SemanticKernel version.

...lates/Microsoft.Extensions.AI.Templates/src/ChatWithCustomData/ChatWithCustomData-CSharp.sln

MackinnonBuck · 2025-03-18T05:06:50Z

I'm going to undraft this PR so it can get some eyes. Note that there are some known issues I still need to address:

~~When the Aspire option is not used, the generated project still has a .Web suffix. That should probably not be the case.~~
Update: Done.
~~New tests need to be added for Aspire variation(s) of the template.~~
Update: Done.
~~AI service provider configuration should be moved to the AppHost project.~~
Update: Done.
The README needs to be updated
Update: Waiting until feedback on code changes is complete.

No longer relevant

...ates/Microsoft.Extensions.AI.Templates/src/ChatWithCustomData/.template.config/template.json

…tWithCustomData/.template.config/template.json Co-authored-by: Steve Sanderson <[email protected]>

…spire

....Extensions.AI.Templates/src/ChatWithCustomData/ChatWithCustomData-CSharp.AppHost/Program.cs

jeffhandley · 2025-03-20T16:46:50Z

...ates/Microsoft.Extensions.AI.Templates/src/ChatWithCustomData/.template.config/template.json

+    "UseAspire": {
+      "type": "parameter",
+      "displayName": "Use Aspire orchestration",
+      "datatype": "bool",
+      "defaultValue": "false",
+      "description": "Create the project as a distributed application using .NET Aspire."
+    },


This is resulting in -Us as the short switch, but single-character switches are more standard, and it highlights that --UseManagedIdentity managed to squat on -U. I don't see a way to prevent a short name version of the option name from being recognized, so our possible approaches are limited.

@jmatthiesen @MackinnonBuck What would you think about having -U, --Use where multiple values can be specified with allowMultipleValues? Such as --Use Aspire --Use ManagedIdentity (which would then also respect -U aspire,managedidentity.

I agree we should find an alternative here.

The UseManagedIdentity option is currently disabled when the Aspire option is specified, so specifying both options isn't currently a scenario.

I wonder if we should do an audit of all the short/long names in general. For example, the Blazor Web App template has names like -au for authentication, -uld for "Use LocalDB", etc.

Maybe we have something like:

-p, --provider AI service provider -v, --vector-store Vector store -mi, --managed-identity Use managed identity -a, --aspire Use Aspire ...

Updated to use the option names listed directly above.

davidfowl · 2025-03-21T07:02:28Z

...tensions.AI.Templates/src/ChatWithCustomData/ChatWithCustomData-CSharp.Web/Program.Aspire.cs

+var credential = new ApiKeyCredential(builder.Configuration["GITHUB_MODELS_TOKEN"] ?? throw new InvalidOperationException("Missing configuration: GITHUB_MODELS_TOKEN. See the README for details."));
+var openAIOptions = new OpenAIClientOptions()
+{
+    Endpoint = new Uri("https://models.inference.ai.azure.com")
+};
+
+var ghModelsClient = new OpenAIClient(credential, openAIOptions);
+var chatClient = ghModelsClient.AsChatClient("gpt-4o-mini");
+var embeddingGenerator = ghModelsClient.AsEmbeddingGenerator("text-embedding-3-small");


Why not use the OpenAI Aspire package for this?

cc @eerhardt @sebastienros

Thanks - updated to use the Aspire package for GitHub models.

jeffhandley · 2025-03-21T08:56:17Z

...nTests/Snapshots/aichatweb.BasicAspire--UseAspire.verified/aichatweb/aichatweb.Web/README.md

I looked for this README at the root of the solution rather than in the Web project. I'm not sure if others will have that same expectation though.

Yeah, I'm preparing an Aspire variation of the README. Will push soon 🙂

jeffhandley · 2025-03-21T08:57:55Z

...nTests/Snapshots/aichatweb.BasicAspire--UseAspire.verified/aichatweb/aichatweb.Web/README.md

+
+```sh
+cd <<your-project-directory>>
+dotnet user-secrets set GitHubModels:Token YOUR-TOKEN


I wasn't sure which project folder to run this from. I either chose poorly, or this didn't flow through as expected because the dashboard told me the value was missing.

The new README will explain how to configure things.

...ates/Microsoft.Extensions.AI.Templates/src/ChatWithCustomData/.template.config/template.json

jeffhandley · 2025-03-21T09:09:11Z

eng/Versions.props

+    <MicrosoftExtensionsServiceDiscoveryVersion>9.1.0</MicrosoftExtensionsServiceDiscoveryVersion>
+    <MicrosoftSemanticKernelConnectorsAzureAISearchVersion>1.41.0-preview</MicrosoftSemanticKernelConnectorsAzureAISearchVersion>
+    <MicrosoftSemanticKernelConnectorsQdrantVersion>1.41.0-preview</MicrosoftSemanticKernelConnectorsQdrantVersion>
+    <MicrosoftSemanticKernelCoreVersion>1.41.0</MicrosoftSemanticKernelCoreVersion>
    <OllamaSharpVersion>5.1.5</OllamaSharpVersion>
    <OpenAIVersion>2.2.0-beta.1</OpenAIVersion>


I ended up with both 2.2.0-beta.3 and 2.2.0-beta.1 in my solution, which gave me an error that it was being downgraded from .3 to .1, and I had to force bump it to .3.

I presume when building with reference to the publicly available MEAI.OpenAI version, it would be OK because both would reference beta.1, but when using the just-built packages, it fails.

…tWithCustomData/.template.config/template.json Co-authored-by: Jeff Handley <[email protected]>

....Extensions.AI.Templates/src/ChatWithCustomData/ChatWithCustomData-CSharp.AppHost/Program.cs

....AI.Templates/src/ChatWithCustomData/ChatWithCustomData-CSharp.ServiceDefaults/Extensions.cs

...tensions.AI.Templates/src/ChatWithCustomData/ChatWithCustomData-CSharp.Web/Program.Aspire.cs

MackinnonBuck added 4 commits March 11, 2025 10:09

Use GUID keys for vector store records

512b95a

Aspire template starting point

92564ae

Unify Aspire and single-project templates

72974a2

Started on AzureOpenAI Aspire support

59dad4a

github-actions bot added the area-ai-templates Microsoft.Extensions.AI.Templates label Mar 13, 2025

dotnet-policy-service bot assigned MackinnonBuck Mar 13, 2025

MackinnonBuck added 2 commits March 13, 2025 15:11

Copy existing non-aspire functionality into Program.Aspire.cs

513480f

Use version properties

58f6e54

RussKie previously requested changes Mar 14, 2025

View reviewed changes

eng/Versions.props Outdated Show resolved Hide resolved

eng/Versions.props Outdated Show resolved Hide resolved

dotnet-policy-service bot added the waiting-author-feedback 📭 The author of this issue needs to respond in order for us to continue investigating this issue. label Mar 14, 2025

Merge remote-tracking branch 'origin/main' into mbuck/chat-template-a…

5b40a68

…spire

dotnet-policy-service bot removed the waiting-author-feedback 📭 The author of this issue needs to respond in order for us to continue investigating this issue. label Mar 17, 2025

MackinnonBuck added 5 commits March 17, 2025 16:45

Fix merge problems + remove use of obsolete APIs

2b9c10d

Update Versions.props

20a6571

Fix Microsoft.Extensions.Http.Resilience reference

2754615

Fix in-repo build

d6fb86d

Ollama fixes

c6b706d

MackinnonBuck commented Mar 18, 2025

View reviewed changes

MackinnonBuck marked this pull request as ready for review March 18, 2025 05:06

MackinnonBuck requested review from a team as code owners March 18, 2025 05:06

Revert snapshot changes until tests are fixed

7e94d85

SteveSandersonMS reviewed Mar 18, 2025

View reviewed changes

...ates/Microsoft.Extensions.AI.Templates/src/ChatWithCustomData/.template.config/template.json Outdated Show resolved Hide resolved

MackinnonBuck and others added 5 commits March 18, 2025 09:02

Update src/ProjectTemplates/Microsoft.Extensions.AI.Templates/src/Cha…

3984dfc

…tWithCustomData/.template.config/template.json Co-authored-by: Steve Sanderson <[email protected]>

Merge branch 'main' into mbuck/chat-template-aspire

f55cbec

Remove .Web suffix in non-Aspire variant

8fd88ad

Move Azure OpenAI + Sqlite to AppHost

87364b5

Merge remote-tracking branch 'origin/main' into mbuck/chat-template-a…

6081418

…spire

Update template tests

87e0d22

MackinnonBuck commented Mar 19, 2025

View reviewed changes

....Extensions.AI.Templates/src/ChatWithCustomData/ChatWithCustomData-CSharp.AppHost/Program.cs Outdated Show resolved Hide resolved

MackinnonBuck added 13 commits March 18, 2025 17:17

Fix build by using generated .sln

f97ec71

Merge branch 'main' into mbuck/chat-template-aspire

c514446

Remove .sln file from snapshot

4fefb2b

Only use GUID keys when UseQdrant

63549b0

If duplicate .sln files, output full paths of each

0006710

Limit .sln file search depth on Linux

40dcd79

Add back .sln to snapshot to see if it will work

2fb83f5

Enable Aspire option in VS

9a7c53a

Improve Azure+Aspire integration

500d36a

Update test snapshots

adcf32c

Improved Aspire+OpenAI integration

b8165b1

Merge branch 'main' into mbuck/chat-template-aspire

371a348

Fix accidental .gitignore change

6b4f144

jeffhandley reviewed Mar 20, 2025

View reviewed changes

davidfowl reviewed Mar 21, 2025

View reviewed changes

jeffhandley reviewed Mar 21, 2025

View reviewed changes

MackinnonBuck and others added 2 commits March 21, 2025 09:11

Update src/ProjectTemplates/Microsoft.Extensions.AI.Templates/src/Cha…

e2b0741

…tWithCustomData/.template.config/template.json Co-authored-by: Jeff Handley <[email protected]>

Merge branch 'main' into mbuck/chat-template-aspire

c4d9b63