diff --git a/eng/build.proj b/eng/build.proj index 202437c6e9b..9626d7f0694 100644 --- a/eng/build.proj +++ b/eng/build.proj @@ -1,7 +1,7 @@ <_SnapshotsToExclude Include="$(MSBuildThisFileDirectory)..\test\**\Snapshots\**\*.*proj" /> - <_GeneratedContentToExclude Include="$(MSBuildThisFileDirectory)..\test\**\ExecutionTemplateSandbox\**\*.*proj" /> + <_GeneratedContentToExclude Include="$(MSBuildThisFileDirectory)..\test\**\ExecutionTestSandbox\**\*.*proj" /> <_ProjectsToBuild Include="$(MSBuildThisFileDirectory)..\src\**\*.csproj" /> diff --git a/src/ProjectTemplates/GeneratedContent.targets b/src/ProjectTemplates/GeneratedContent.targets index 72f571684ef..a9c3d4ea760 100644 --- a/src/ProjectTemplates/GeneratedContent.targets +++ b/src/ProjectTemplates/GeneratedContent.targets @@ -26,6 +26,9 @@ + + + @@ -44,8 +47,9 @@ 9.8.1-beta.413 10.0.0-rc.2.25502.107 9.5.1 - 1.66.0 - 1.66.0-preview + 2.0.0-preview.25503.2 + 1.67.1 + 1.67.1-preview 0.4.0-preview.1 5.4.8 1.13.0 @@ -72,6 +76,7 @@ TemplatePackageVersion_CommunityToolkitAspire=$(TemplatePackageVersion_CommunityToolkitAspire); TemplatePackageVersion_MicrosoftExtensionsHosting=$(TemplatePackageVersion_MicrosoftExtensionsHosting); TemplatePackageVersion_MicrosoftExtensionsServiceDiscovery=$(TemplatePackageVersion_MicrosoftExtensionsServiceDiscovery); + TemplatePackageVersion_MicrosoftMLTokenizers=$(TemplatePackageVersion_MicrosoftMLTokenizers); TemplatePackageVersion_MicrosoftSemanticKernel=$(TemplatePackageVersion_MicrosoftSemanticKernel); TemplatePackageVersion_MicrosoftSemanticKernel_Preview=$(TemplatePackageVersion_MicrosoftSemanticKernel_Preview); TemplatePackageVersion_ModelContextProtocol=$(TemplatePackageVersion_ModelContextProtocol); diff --git a/src/ProjectTemplates/Microsoft.Extensions.AI.Templates/THIRD-PARTY-NOTICES.TXT b/src/ProjectTemplates/Microsoft.Extensions.AI.Templates/THIRD-PARTY-NOTICES.TXT index 232d8d463eb..0fb44e61538 100644 --- a/src/ProjectTemplates/Microsoft.Extensions.AI.Templates/THIRD-PARTY-NOTICES.TXT +++ b/src/ProjectTemplates/Microsoft.Extensions.AI.Templates/THIRD-PARTY-NOTICES.TXT @@ -817,267 +817,6 @@ https://github.com/mozilla/pdf.js END OF TERMS AND CONDITIONS -License notice for PdfPig -------------------------- - -https://github.com/UglyToad/PdfPig - - Apache License - Version 2.0, January 2004 - http://www.apache.org/licenses/ - - TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION - - 1. Definitions. - - "License" shall mean the terms and conditions for use, reproduction, - and distribution as defined by Sections 1 through 9 of this document. - - "Licensor" shall mean the copyright owner or entity authorized by - the copyright owner that is granting the License. - - "Legal Entity" shall mean the union of the acting entity and all - other entities that control, are controlled by, or are under common - control with that entity. For the purposes of this definition, - "control" means (i) the power, direct or indirect, to cause the - direction or management of such entity, whether by contract or - otherwise, or (ii) ownership of fifty percent (50%) or more of the - outstanding shares, or (iii) beneficial ownership of such entity. - - "You" (or "Your") shall mean an individual or Legal Entity - exercising permissions granted by this License. - - "Source" form shall mean the preferred form for making modifications, - including but not limited to software source code, documentation - source, and configuration files. - - "Object" form shall mean any form resulting from mechanical - transformation or translation of a Source form, including but - not limited to compiled object code, generated documentation, - and conversions to other media types. - - "Work" shall mean the work of authorship, whether in Source or - Object form, made available under the License, as indicated by a - copyright notice that is included in or attached to the work - (an example is provided in the Appendix below). - - "Derivative Works" shall mean any work, whether in Source or Object - form, that is based on (or derived from) the Work and for which the - editorial revisions, annotations, elaborations, or other modifications - represent, as a whole, an original work of authorship. For the purposes - of this License, Derivative Works shall not include works that remain - separable from, or merely link (or bind by name) to the interfaces of, - the Work and Derivative Works thereof. - - "Contribution" shall mean any work of authorship, including - the original version of the Work and any modifications or additions - to that Work or Derivative Works thereof, that is intentionally - submitted to Licensor for inclusion in the Work by the copyright owner - or by an individual or Legal Entity authorized to submit on behalf of - the copyright owner. For the purposes of this definition, "submitted" - means any form of electronic, verbal, or written communication sent - to the Licensor or its representatives, including but not limited to - communication on electronic mailing lists, source code control systems, - and issue tracking systems that are managed by, or on behalf of, the - Licensor for the purpose of discussing and improving the Work, but - excluding communication that is conspicuously marked or otherwise - designated in writing by the copyright owner as "Not a Contribution." - - "Contributor" shall mean Licensor and any individual or Legal Entity - on behalf of whom a Contribution has been received by Licensor and - subsequently incorporated within the Work. - - 2. Grant of Copyright License. Subject to the terms and conditions of - this License, each Contributor hereby grants to You a perpetual, - worldwide, non-exclusive, no-charge, royalty-free, irrevocable - copyright license to reproduce, prepare Derivative Works of, - publicly display, publicly perform, sublicense, and distribute the - Work and such Derivative Works in Source or Object form. - - 3. Grant of Patent License. Subject to the terms and conditions of - this License, each Contributor hereby grants to You a perpetual, - worldwide, non-exclusive, no-charge, royalty-free, irrevocable - (except as stated in this section) patent license to make, have made, - use, offer to sell, sell, import, and otherwise transfer the Work, - where such license applies only to those patent claims licensable - by such Contributor that are necessarily infringed by their - Contribution(s) alone or by combination of their Contribution(s) - with the Work to which such Contribution(s) was submitted. If You - institute patent litigation against any entity (including a - cross-claim or counterclaim in a lawsuit) alleging that the Work - or a Contribution incorporated within the Work constitutes direct - or contributory patent infringement, then any patent licenses - granted to You under this License for that Work shall terminate - as of the date such litigation is filed. - - 4. Redistribution. You may reproduce and distribute copies of the - Work or Derivative Works thereof in any medium, with or without - modifications, and in Source or Object form, provided that You - meet the following conditions: - - (a) You must give any other recipients of the Work or - Derivative Works a copy of this License; and - - (b) You must cause any modified files to carry prominent notices - stating that You changed the files; and - - (c) You must retain, in the Source form of any Derivative Works - that You distribute, all copyright, patent, trademark, and - attribution notices from the Source form of the Work, - excluding those notices that do not pertain to any part of - the Derivative Works; and - - (d) If the Work includes a "NOTICE" text file as part of its - distribution, then any Derivative Works that You distribute must - include a readable copy of the attribution notices contained - within such NOTICE file, excluding those notices that do not - pertain to any part of the Derivative Works, in at least one - of the following places: within a NOTICE text file distributed - as part of the Derivative Works; within the Source form or - documentation, if provided along with the Derivative Works; or, - within a display generated by the Derivative Works, if and - wherever such third-party notices normally appear. The contents - of the NOTICE file are for informational purposes only and - do not modify the License. You may add Your own attribution - notices within Derivative Works that You distribute, alongside - or as an addendum to the NOTICE text from the Work, provided - that such additional attribution notices cannot be construed - as modifying the License. - - You may add Your own copyright statement to Your modifications and - may provide additional or different license terms and conditions - for use, reproduction, or distribution of Your modifications, or - for any such Derivative Works as a whole, provided Your use, - reproduction, and distribution of the Work otherwise complies with - the conditions stated in this License. - - 5. Submission of Contributions. Unless You explicitly state otherwise, - any Contribution intentionally submitted for inclusion in the Work - by You to the Licensor shall be under the terms and conditions of - this License, without any additional terms or conditions. - Notwithstanding the above, nothing herein shall supersede or modify - the terms of any separate license agreement you may have executed - with Licensor regarding such Contributions. - - 6. Trademarks. This License does not grant permission to use the trade - names, trademarks, service marks, or product names of the Licensor, - except as required for reasonable and customary use in describing the - origin of the Work and reproducing the content of the NOTICE file. - - 7. Disclaimer of Warranty. Unless required by applicable law or - agreed to in writing, Licensor provides the Work (and each - Contributor provides its Contributions) on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or - implied, including, without limitation, any warranties or conditions - of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A - PARTICULAR PURPOSE. You are solely responsible for determining the - appropriateness of using or redistributing the Work and assume any - risks associated with Your exercise of permissions under this License. - - 8. Limitation of Liability. In no event and under no legal theory, - whether in tort (including negligence), contract, or otherwise, - unless required by applicable law (such as deliberate and grossly - negligent acts) or agreed to in writing, shall any Contributor be - liable to You for damages, including any direct, indirect, special, - incidental, or consequential damages of any character arising as a - result of this License or out of the use or inability to use the - Work (including but not limited to damages for loss of goodwill, - work stoppage, computer failure or malfunction, or any and all - other commercial damages or losses), even if such Contributor - has been advised of the possibility of such damages. - - 9. Accepting Warranty or Additional Liability. While redistributing - the Work or Derivative Works thereof, You may choose to offer, - and charge a fee for, acceptance of support, warranty, indemnity, - or other liability obligations and/or rights consistent with this - License. However, in accepting such obligations, You may act only - on Your own behalf and on Your sole responsibility, not on behalf - of any other Contributor, and only if You agree to indemnify, - defend, and hold each Contributor harmless for any liability - incurred by, or claims asserted against, such Contributor by reason - of your accepting any such warranty or additional liability. - - END OF TERMS AND CONDITIONS - -EXTERNAL COMPONENTS - -PdfPig includes a number of components with separate copyright notices -and license terms. Your use of these components is subject to the terms and -conditions of the following licenses. - -Contributions made to the original PDFBox and FontBox projects: - - Copyright (c) 2002-2007, www.pdfbox.org - All rights reserved. - - Redistribution and use in source and binary forms, with or without - modification, are permitted provided that the following conditions are met: - - 1. Redistributions of source code must retain the above copyright notice, - this list of conditions and the following disclaimer. - - 2. Redistributions in binary form must reproduce the above copyright - notice, this list of conditions and the following disclaimer in the - documentation and/or other materials provided with the distribution. - - 3. Neither the name of pdfbox; nor the names of its contributors may be - used to endorse or promote products derived from this software without - specific prior written permission. - - THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" - AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE - IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE - ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE - FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL - DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR - SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER - CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT - LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY - OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF - SUCH DAMAGE. - -Adobe Font Metrics (AFM) for PDF Core 14 Fonts - - This file and the 14 PostScript(R) AFM files it accompanies may be used, - copied, and distributed for any purpose and without charge, with or without - modification, provided that all copyright notices are retained; that the - AFM files are not distributed without this file; that all modifications - to this file or any of the AFM files are prominently noted in the modified - file(s); and that this paragraph is not modified. Adobe Systems has no - responsibility or obligation to support the use of the AFM files. - -CMaps for PDF Fonts (http://opensource.adobe.com/wiki/display/cmap/Downloads) - - Copyright 1990-2009 Adobe Systems Incorporated. - All rights reserved. - - Redistribution and use in source and binary forms, with or without - modification, are permitted provided that the following conditions - are met: - - Redistributions of source code must retain the above copyright notice, - this list of conditions and the following disclaimer. - - Redistributions in binary form must reproduce the above copyright notice, - this list of conditions and the following disclaimer in the documentation - and/or other materials provided with the distribution. - - Neither the name of Adobe Systems Incorporated nor the names of its - contributors may be used to endorse or promote products derived from this - software without specific prior written permission. - - THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" - AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE - IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE - ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE - LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR - CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF - SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS - INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN - CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) - ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF - THE POSSIBILITY OF SUCH DAMAGE. - License notice for OllamaSharp ------------------------------ diff --git a/src/ProjectTemplates/Microsoft.Extensions.AI.Templates/src/ChatWithCustomData/.template.config/template.json b/src/ProjectTemplates/Microsoft.Extensions.AI.Templates/src/ChatWithCustomData/.template.config/template.json index 603ed1a2735..54b38545be5 100644 --- a/src/ProjectTemplates/Microsoft.Extensions.AI.Templates/src/ChatWithCustomData/.template.config/template.json +++ b/src/ProjectTemplates/Microsoft.Extensions.AI.Templates/src/ChatWithCustomData/.template.config/template.json @@ -70,6 +70,12 @@ "ChatWithCustomData-CSharp.Web/OllamaResilienceHandlerExtensions.cs" ] }, + { + "condition": "(IsAspire)", + "exclude": [ + "ChatWithCustomData-CSharp.Web/Services/Ingestion/PdfPigReader.cs" + ] + }, { "condition": "(IsAspire)", "exclude": [ @@ -101,13 +107,17 @@ "description": "The target framework for the project.", "datatype": "choice", "choices": [ + { + "choice": "net10.0", + "description": ".NET 10" + }, { "choice": "net9.0", - "description": "Target net9.0" + "description": ".NET 9" } ], - "replaces": "net9.0", - "defaultValue": "net9.0", + "replaces": "net10.0", + "defaultValue": "net10.0", "displayName": "Framework" }, "hostIdentifier": { @@ -185,6 +195,10 @@ "defaultValue": "false", "description": "Create the project as a distributed application using Aspire." }, + "IsNET9": { + "type": "computed", + "value": "(Framework == \"net9.0\")" + }, "IsManagedIdentity": { "type": "computed", "value": "(UseManagedIdentity)" diff --git a/src/ProjectTemplates/Microsoft.Extensions.AI.Templates/src/ChatWithCustomData/ChatWithCustomData-CSharp.AppHost/AppHost.cs b/src/ProjectTemplates/Microsoft.Extensions.AI.Templates/src/ChatWithCustomData/ChatWithCustomData-CSharp.AppHost/AppHost.cs index a859ce397a1..c1ca040558b 100644 --- a/src/ProjectTemplates/Microsoft.Extensions.AI.Templates/src/ChatWithCustomData/ChatWithCustomData-CSharp.AppHost/AppHost.cs +++ b/src/ProjectTemplates/Microsoft.Extensions.AI.Templates/src/ChatWithCustomData/ChatWithCustomData-CSharp.AppHost/AppHost.cs @@ -51,6 +51,10 @@ #else // IsLocalVectorStore #endif +var markitdown = builder.AddContainer("markitdown", "mcp/markitdown") + .WithArgs("--http", "--host", "0.0.0.0", "--port", "3001") + .WithHttpEndpoint(targetPort: 3001, name: "http"); + var webApp = builder.AddProject("aichatweb-app"); #if (IsOllama) // AI SERVICE PROVIDER REFERENCES webApp @@ -75,5 +79,7 @@ .WaitFor(vectorDB); #else // IsLocalVectorStore #endif +webApp + .WithEnvironment("MARKITDOWN_MCP_URL", markitdown.GetEndpoint("http")); builder.Build().Run(); diff --git a/src/ProjectTemplates/Microsoft.Extensions.AI.Templates/src/ChatWithCustomData/ChatWithCustomData-CSharp.AppHost/ChatWithCustomData-CSharp.AppHost.csproj.in b/src/ProjectTemplates/Microsoft.Extensions.AI.Templates/src/ChatWithCustomData/ChatWithCustomData-CSharp.AppHost/ChatWithCustomData-CSharp.AppHost.csproj.in index b7d8f13bdfa..8d0e2a3a011 100644 --- a/src/ProjectTemplates/Microsoft.Extensions.AI.Templates/src/ChatWithCustomData/ChatWithCustomData-CSharp.AppHost/ChatWithCustomData-CSharp.AppHost.csproj.in +++ b/src/ProjectTemplates/Microsoft.Extensions.AI.Templates/src/ChatWithCustomData/ChatWithCustomData-CSharp.AppHost/ChatWithCustomData-CSharp.AppHost.csproj.in @@ -4,7 +4,7 @@ Exe - net9.0 + net10.0 enable enable b2f4f5e9-1083-472c-8c3b-f055ac67ba54 diff --git a/src/ProjectTemplates/Microsoft.Extensions.AI.Templates/src/ChatWithCustomData/ChatWithCustomData-CSharp.ServiceDefaults/ChatWithCustomData-CSharp.ServiceDefaults.csproj.in b/src/ProjectTemplates/Microsoft.Extensions.AI.Templates/src/ChatWithCustomData/ChatWithCustomData-CSharp.ServiceDefaults/ChatWithCustomData-CSharp.ServiceDefaults.csproj.in index 3b67ba158cd..814c86384e7 100644 --- a/src/ProjectTemplates/Microsoft.Extensions.AI.Templates/src/ChatWithCustomData/ChatWithCustomData-CSharp.ServiceDefaults/ChatWithCustomData-CSharp.ServiceDefaults.csproj.in +++ b/src/ProjectTemplates/Microsoft.Extensions.AI.Templates/src/ChatWithCustomData/ChatWithCustomData-CSharp.ServiceDefaults/ChatWithCustomData-CSharp.ServiceDefaults.csproj.in @@ -1,7 +1,7 @@ - net9.0 + net10.0 enable enable true diff --git a/src/ProjectTemplates/Microsoft.Extensions.AI.Templates/src/ChatWithCustomData/ChatWithCustomData-CSharp.ServiceDefaults/Extensions.cs b/src/ProjectTemplates/Microsoft.Extensions.AI.Templates/src/ChatWithCustomData/ChatWithCustomData-CSharp.ServiceDefaults/Extensions.cs index 204f7a64164..a32bbd5bcca 100644 --- a/src/ProjectTemplates/Microsoft.Extensions.AI.Templates/src/ChatWithCustomData/ChatWithCustomData-CSharp.ServiceDefaults/Extensions.cs +++ b/src/ProjectTemplates/Microsoft.Extensions.AI.Templates/src/ChatWithCustomData/ChatWithCustomData-CSharp.ServiceDefaults/Extensions.cs @@ -76,7 +76,8 @@ public static TBuilder ConfigureOpenTelemetry(this TBuilder builder) w // Uncomment the following line to enable gRPC instrumentation (requires the OpenTelemetry.Instrumentation.GrpcNetClient package) //.AddGrpcClientInstrumentation() .AddHttpClientInstrumentation() - .AddSource("Experimental.Microsoft.Extensions.AI"); + .AddSource("Experimental.Microsoft.Extensions.AI") + .AddSource("Experimental.Microsoft.Extensions.DataIngestion"); }); builder.AddOpenTelemetryExporters(); diff --git a/src/ProjectTemplates/Microsoft.Extensions.AI.Templates/src/ChatWithCustomData/ChatWithCustomData-CSharp.Web/ChatWithCustomData-CSharp.Web.csproj.in b/src/ProjectTemplates/Microsoft.Extensions.AI.Templates/src/ChatWithCustomData/ChatWithCustomData-CSharp.Web/ChatWithCustomData-CSharp.Web.csproj.in index 05e9a9726de..9368b96356f 100644 --- a/src/ProjectTemplates/Microsoft.Extensions.AI.Templates/src/ChatWithCustomData/ChatWithCustomData-CSharp.Web/ChatWithCustomData-CSharp.Web.csproj.in +++ b/src/ProjectTemplates/Microsoft.Extensions.AI.Templates/src/ChatWithCustomData/ChatWithCustomData-CSharp.Web/ChatWithCustomData-CSharp.Web.csproj.in @@ -1,7 +1,7 @@  - net9.0 + net10.0 enable enable d5681fae-b21b-4114-b781-48180f08c0c4 @@ -30,9 +30,18 @@ - + + + + + + + + + + win-x64;win-arm64;osx-arm64;linux-x64;linux-arm64;linux-musl-x64 diff --git a/test/ProjectTemplates/Infrastructure/TemplateExecutionTestClassFixtureBase.cs b/test/ProjectTemplates/Infrastructure/TemplateExecutionTestClassFixtureBase.cs index 0b978655c35..9144593db73 100644 --- a/test/ProjectTemplates/Infrastructure/TemplateExecutionTestClassFixtureBase.cs +++ b/test/ProjectTemplates/Infrastructure/TemplateExecutionTestClassFixtureBase.cs @@ -61,7 +61,8 @@ async Task InstallTemplatesAsync() .WithEnvironmentVariable("NUGET_PACKAGES", WellKnownPaths.NuGetPackagesPath) .WithCustomHive(_customHivePath) .ExecuteAsync(OutputHelper); - installResult.AssertSucceeded(); + + installResult.AssertSucceeded($"dotnet new install {_configuration.TemplatePackageName}"); } } @@ -78,11 +79,14 @@ public async Task CreateProjectAsync(string templateName, string projec .. args ]; + var testDescription = string.Join(' ', dotNetNewCommandArgs); + var newProjectResult = await new DotNetNewCommand(dotNetNewCommandArgs) .WithWorkingDirectory(_templateTestOutputPath) .WithCustomHive(_customHivePath) .ExecuteAsync(OutputHelper); - newProjectResult.AssertSucceeded(); + + newProjectResult.AssertSucceeded(testDescription); var templateNuGetConfigPath = Path.Combine(outputFolderPath, "nuget.config"); File.Copy(WellKnownPaths.TemplateTestNuGetConfigPath, templateNuGetConfigPath); @@ -97,7 +101,14 @@ public async Task RestoreProjectAsync(Project project) .WithEnvironmentVariable("LOCAL_SHIPPING_PATH", WellKnownPaths.LocalShippingPackagesPath) .WithEnvironmentVariable("NUGET_PACKAGES", WellKnownPaths.NuGetPackagesPath) .ExecuteAsync(OutputHelper); - restoreResult.AssertSucceeded(); + + restoreResult.AssertSucceeded($""" + dotnet restore + + Working Directory: {project.StartupProjectFullPath} + Local Shipping Path: {WellKnownPaths.LocalShippingPackagesPath} + NuGet Packages Path: {WellKnownPaths.NuGetPackagesPath} + """); } public async Task BuildProjectAsync(Project project) @@ -105,7 +116,12 @@ public async Task BuildProjectAsync(Project project) var buildResult = await new DotNetCommand("build", "--no-restore") .WithWorkingDirectory(project.StartupProjectFullPath) .ExecuteAsync(OutputHelper); - buildResult.AssertSucceeded(); + + buildResult.AssertSucceeded($""" + dotnet build --no-restore + + Working Directory: {project.StartupProjectFullPath} + """); } public void SetCurrentTestOutputHelper(ITestOutputHelper? outputHelper) diff --git a/test/ProjectTemplates/Infrastructure/TestCommandResult.cs b/test/ProjectTemplates/Infrastructure/TestCommandResult.cs index 21b4b7f7592..fd4c5a0b547 100644 --- a/test/ProjectTemplates/Infrastructure/TestCommandResult.cs +++ b/test/ProjectTemplates/Infrastructure/TestCommandResult.cs @@ -2,6 +2,7 @@ // The .NET Foundation licenses this file to you under the MIT license. using System.Text; +using Xunit; namespace Microsoft.Shared.ProjectTemplates.Tests; @@ -12,4 +13,30 @@ public sealed class TestCommandResult(StringBuilder standardOutputBuilder, Strin public string StandardError => field ??= standardErrorBuilder.ToString(); public int ExitCode => exitCode; + + public void AssertSucceeded(string testDescription) + { + var output = $""" + {testDescription} + + {(ExitCode != 0 ? $""" + Command failed with non-zero exit code: {ExitCode} + + """ : string.Empty)} + {(!string.IsNullOrWhiteSpace(StandardOutput) ? + $""" + >> Standard Output: + {StandardOutput} + + """ : string.Empty)} + {(!string.IsNullOrWhiteSpace(StandardError) ? + $""" + >>> Standard Error: + {StandardError} + + """ : string.Empty)} + """; + + Assert.True(ExitCode == 0 && string.IsNullOrWhiteSpace(StandardError), output); + } } diff --git a/test/ProjectTemplates/Infrastructure/TestCommandResultExtensions.cs b/test/ProjectTemplates/Infrastructure/TestCommandResultExtensions.cs deleted file mode 100644 index d623c3643b8..00000000000 --- a/test/ProjectTemplates/Infrastructure/TestCommandResultExtensions.cs +++ /dev/null @@ -1,27 +0,0 @@ -// Licensed to the .NET Foundation under one or more agreements. -// The .NET Foundation licenses this file to you under the MIT license. - -using Xunit; - -namespace Microsoft.Shared.ProjectTemplates.Tests; - -public static class TestCommandResultExtensions -{ - public static TestCommandResult AssertZeroExitCode(this TestCommandResult result) - { - Assert.True(result.ExitCode == 0, $"Expected an exit code of zero, got {result.ExitCode}"); - return result; - } - - public static TestCommandResult AssertEmptyStandardError(this TestCommandResult result) - { - var standardError = result.StandardError; - Assert.True(string.IsNullOrWhiteSpace(standardError), $"Standard error output was unexpectedly non-empty:\n{standardError}"); - return result; - } - - public static TestCommandResult AssertSucceeded(this TestCommandResult result) - => result - .AssertZeroExitCode() - .AssertEmptyStandardError(); -} diff --git a/test/ProjectTemplates/Microsoft.Agents.AI.Templates.IntegrationTests/Microsoft.Agents.AI.Templates.Tests.csproj b/test/ProjectTemplates/Microsoft.Agents.AI.Templates.IntegrationTests/Microsoft.Agents.AI.Templates.Tests.csproj index 521086abc6e..732ecb74f15 100644 --- a/test/ProjectTemplates/Microsoft.Agents.AI.Templates.IntegrationTests/Microsoft.Agents.AI.Templates.Tests.csproj +++ b/test/ProjectTemplates/Microsoft.Agents.AI.Templates.IntegrationTests/Microsoft.Agents.AI.Templates.Tests.csproj @@ -21,8 +21,8 @@ - - + + diff --git a/test/ProjectTemplates/Microsoft.Extensions.AI.Templates.IntegrationTests/AIChatWebExecutionTests.cs b/test/ProjectTemplates/Microsoft.Extensions.AI.Templates.IntegrationTests/AIChatWebExecutionTests.cs index 6926bff2333..1f82e25f135 100644 --- a/test/ProjectTemplates/Microsoft.Extensions.AI.Templates.IntegrationTests/AIChatWebExecutionTests.cs +++ b/test/ProjectTemplates/Microsoft.Extensions.AI.Templates.IntegrationTests/AIChatWebExecutionTests.cs @@ -116,6 +116,7 @@ private static readonly (string name, string[] values)[] _templateOptions = [ ("--vector-store", ["azureaisearch", "local", "qdrant"]), ("--managed-identity", ["true", "false"]), ("--aspire", ["true", "false"]), + ("--Framework", ["net9.0", "net10.0"]) ]; private static IEnumerable GetFilteredTemplateOptions(params string[] filter) diff --git a/test/ProjectTemplates/Microsoft.Extensions.AI.Templates.IntegrationTests/Microsoft.Extensions.AI.Templates.Tests.csproj b/test/ProjectTemplates/Microsoft.Extensions.AI.Templates.IntegrationTests/Microsoft.Extensions.AI.Templates.Tests.csproj index 05b28ca3546..bd83d4fa93e 100644 --- a/test/ProjectTemplates/Microsoft.Extensions.AI.Templates.IntegrationTests/Microsoft.Extensions.AI.Templates.Tests.csproj +++ b/test/ProjectTemplates/Microsoft.Extensions.AI.Templates.IntegrationTests/Microsoft.Extensions.AI.Templates.Tests.csproj @@ -25,8 +25,8 @@ - - + + diff --git a/test/ProjectTemplates/Microsoft.Extensions.AI.Templates.IntegrationTests/Snapshots/aichatweb.AzureOpenAI_Qdrant_Aspire.verified/aichatweb/aichatweb.AppHost/AppHost.cs b/test/ProjectTemplates/Microsoft.Extensions.AI.Templates.IntegrationTests/Snapshots/aichatweb.AzureOpenAI_Qdrant_Aspire.verified/aichatweb/aichatweb.AppHost/AppHost.cs index da0220a0b1c..c8d2d1a8228 100644 --- a/test/ProjectTemplates/Microsoft.Extensions.AI.Templates.IntegrationTests/Snapshots/aichatweb.AzureOpenAI_Qdrant_Aspire.verified/aichatweb/aichatweb.AppHost/AppHost.cs +++ b/test/ProjectTemplates/Microsoft.Extensions.AI.Templates.IntegrationTests/Snapshots/aichatweb.AzureOpenAI_Qdrant_Aspire.verified/aichatweb/aichatweb.AppHost/AppHost.cs @@ -18,6 +18,10 @@ // for instructions providing configuration values var search = builder.AddAzureSearch("search"); +var markitdown = builder.AddContainer("markitdown", "mcp/markitdown") + .WithArgs("--http", "--host", "0.0.0.0", "--port", "3001") + .WithHttpEndpoint(targetPort: 3001, name: "http"); + var webApp = builder.AddProject("aichatweb-app"); webApp .WithReference(openai) @@ -25,5 +29,7 @@ webApp .WithReference(search) .WaitFor(search); +webApp + .WithEnvironment("MARKITDOWN_MCP_URL", markitdown.GetEndpoint("http")); builder.Build().Run(); diff --git a/test/ProjectTemplates/Microsoft.Extensions.AI.Templates.IntegrationTests/Snapshots/aichatweb.AzureOpenAI_Qdrant_Aspire.verified/aichatweb/aichatweb.AppHost/aichatweb.AppHost.csproj b/test/ProjectTemplates/Microsoft.Extensions.AI.Templates.IntegrationTests/Snapshots/aichatweb.AzureOpenAI_Qdrant_Aspire.verified/aichatweb/aichatweb.AppHost/aichatweb.AppHost.csproj index d2d0f2890a6..4c958e078a0 100644 --- a/test/ProjectTemplates/Microsoft.Extensions.AI.Templates.IntegrationTests/Snapshots/aichatweb.AzureOpenAI_Qdrant_Aspire.verified/aichatweb/aichatweb.AppHost/aichatweb.AppHost.csproj +++ b/test/ProjectTemplates/Microsoft.Extensions.AI.Templates.IntegrationTests/Snapshots/aichatweb.AzureOpenAI_Qdrant_Aspire.verified/aichatweb/aichatweb.AppHost/aichatweb.AppHost.csproj @@ -4,7 +4,7 @@ Exe - net9.0 + net10.0 enable enable secret diff --git a/test/ProjectTemplates/Microsoft.Extensions.AI.Templates.IntegrationTests/Snapshots/aichatweb.AzureOpenAI_Qdrant_Aspire.verified/aichatweb/aichatweb.ServiceDefaults/Extensions.cs b/test/ProjectTemplates/Microsoft.Extensions.AI.Templates.IntegrationTests/Snapshots/aichatweb.AzureOpenAI_Qdrant_Aspire.verified/aichatweb/aichatweb.ServiceDefaults/Extensions.cs index b44d60b604b..8d0b0cd5d67 100644 --- a/test/ProjectTemplates/Microsoft.Extensions.AI.Templates.IntegrationTests/Snapshots/aichatweb.AzureOpenAI_Qdrant_Aspire.verified/aichatweb/aichatweb.ServiceDefaults/Extensions.cs +++ b/test/ProjectTemplates/Microsoft.Extensions.AI.Templates.IntegrationTests/Snapshots/aichatweb.AzureOpenAI_Qdrant_Aspire.verified/aichatweb/aichatweb.ServiceDefaults/Extensions.cs @@ -76,7 +76,8 @@ public static TBuilder ConfigureOpenTelemetry(this TBuilder builder) w // Uncomment the following line to enable gRPC instrumentation (requires the OpenTelemetry.Instrumentation.GrpcNetClient package) //.AddGrpcClientInstrumentation() .AddHttpClientInstrumentation() - .AddSource("Experimental.Microsoft.Extensions.AI"); + .AddSource("Experimental.Microsoft.Extensions.AI") + .AddSource("Experimental.Microsoft.Extensions.DataIngestion"); }); builder.AddOpenTelemetryExporters(); diff --git a/test/ProjectTemplates/Microsoft.Extensions.AI.Templates.IntegrationTests/Snapshots/aichatweb.AzureOpenAI_Qdrant_Aspire.verified/aichatweb/aichatweb.ServiceDefaults/aichatweb.ServiceDefaults.csproj b/test/ProjectTemplates/Microsoft.Extensions.AI.Templates.IntegrationTests/Snapshots/aichatweb.AzureOpenAI_Qdrant_Aspire.verified/aichatweb/aichatweb.ServiceDefaults/aichatweb.ServiceDefaults.csproj index 474dd445fae..a70a3ca8cd4 100644 --- a/test/ProjectTemplates/Microsoft.Extensions.AI.Templates.IntegrationTests/Snapshots/aichatweb.AzureOpenAI_Qdrant_Aspire.verified/aichatweb/aichatweb.ServiceDefaults/aichatweb.ServiceDefaults.csproj +++ b/test/ProjectTemplates/Microsoft.Extensions.AI.Templates.IntegrationTests/Snapshots/aichatweb.AzureOpenAI_Qdrant_Aspire.verified/aichatweb/aichatweb.ServiceDefaults/aichatweb.ServiceDefaults.csproj @@ -1,7 +1,7 @@  - net9.0 + net10.0 enable enable true diff --git a/test/ProjectTemplates/Microsoft.Extensions.AI.Templates.IntegrationTests/Snapshots/aichatweb.AzureOpenAI_Qdrant_Aspire.verified/aichatweb/aichatweb.Web/Components/Pages/Chat/Chat.razor b/test/ProjectTemplates/Microsoft.Extensions.AI.Templates.IntegrationTests/Snapshots/aichatweb.AzureOpenAI_Qdrant_Aspire.verified/aichatweb/aichatweb.Web/Components/Pages/Chat/Chat.razor index 8aa0ec9fd28..6fc5881c18f 100644 --- a/test/ProjectTemplates/Microsoft.Extensions.AI.Templates.IntegrationTests/Snapshots/aichatweb.AzureOpenAI_Qdrant_Aspire.verified/aichatweb/aichatweb.Web/Components/Pages/Chat/Chat.razor +++ b/test/ProjectTemplates/Microsoft.Extensions.AI.Templates.IntegrationTests/Snapshots/aichatweb.AzureOpenAI_Qdrant_Aspire.verified/aichatweb/aichatweb.Web/Components/Pages/Chat/Chat.razor @@ -13,7 +13,7 @@
To get started, try asking about these example documents. You can replace these with your own data and replace this message.
- + @@ -29,10 +29,12 @@ Do not answer questions about anything else. Use only simple markdown to format your responses. - Use the search tool to find relevant information. When you do this, end your + Use the LoadDocuments tool to prepare for searches before answering any questions. + + Use the Search tool to find relevant information. When you do this, end your reply with citations in the special XML format: - exact quote here + exact quote here Always include the citation in your response if there are results. @@ -52,7 +54,10 @@ { statefulMessageCount = 0; messages.Add(new(ChatRole.System, SystemPrompt)); - chatOptions.Tools = [AIFunctionFactory.Create(SearchAsync)]; + chatOptions.Tools = [ + AIFunctionFactory.Create(LoadDocumentsAsync), + AIFunctionFactory.Create(SearchAsync) + ]; } private async Task AddUserMessageAsync(ChatMessage userMessage) @@ -106,7 +111,14 @@ await chatInput!.FocusAsync(); } - [Description("Searches for information using a phrase or keyword")] + [Description("Loads the documents needed for performing searches. Must be completed before a search can be executed, but only needs to be completed once.")] + private async Task LoadDocumentsAsync() + { + await InvokeAsync(StateHasChanged); + await Search.LoadDocumentsAsync(); + } + + [Description("Searches for information using a phrase or keyword. Relies on documents already being loaded.")] private async Task> SearchAsync( [Description("The phrase to search for.")] string searchPhrase, [Description("If possible, specify the filename to search that file only. If not provided or empty, the search includes all files.")] string? filenameFilter = null) @@ -114,7 +126,7 @@ await InvokeAsync(StateHasChanged); var results = await Search.SearchAsync(searchPhrase, filenameFilter, maxResults: 5); return results.Select(result => - $"{result.Text}"); + $"{result.Text}"); } public void Dispose() diff --git a/test/ProjectTemplates/Microsoft.Extensions.AI.Templates.IntegrationTests/Snapshots/aichatweb.AzureOpenAI_Qdrant_Aspire.verified/aichatweb/aichatweb.Web/Components/Pages/Chat/ChatCitation.razor b/test/ProjectTemplates/Microsoft.Extensions.AI.Templates.IntegrationTests/Snapshots/aichatweb.AzureOpenAI_Qdrant_Aspire.verified/aichatweb/aichatweb.Web/Components/Pages/Chat/ChatCitation.razor index ccb5853cec4..667189beabd 100644 --- a/test/ProjectTemplates/Microsoft.Extensions.AI.Templates.IntegrationTests/Snapshots/aichatweb.AzureOpenAI_Qdrant_Aspire.verified/aichatweb/aichatweb.Web/Components/Pages/Chat/ChatCitation.razor +++ b/test/ProjectTemplates/Microsoft.Extensions.AI.Templates.IntegrationTests/Snapshots/aichatweb.AzureOpenAI_Qdrant_Aspire.verified/aichatweb/aichatweb.Web/Components/Pages/Chat/ChatCitation.razor @@ -17,10 +17,7 @@ public required string File { get; set; } [Parameter] - public int? PageNumber { get; set; } - - [Parameter] - public required string Quote { get; set; } + public string? Quote { get; set; } private string? viewerUrl; @@ -28,11 +25,15 @@ { viewerUrl = null; - // If you ingest other types of content besides PDF files, construct a URL to an appropriate viewer here - if (File.EndsWith(".pdf")) + // If you ingest other types of content besides Markdown or PDF files, construct a URL to an appropriate viewer here + if (File.EndsWith(".md")) + { + viewerUrl = $"lib/markdown_viewer/viewer.html?file=/Data/{HttpUtility.UrlEncode(File)}#:~:text={Uri.EscapeDataString(Quote ?? "")}"; + } + else if (File.EndsWith(".pdf")) { var search = Quote?.Trim('.', ',', ' ', '\n', '\r', '\t', '"', '\''); - viewerUrl = $"lib/pdf_viewer/viewer.html?file=/Data/{HttpUtility.UrlEncode(File)}#page={PageNumber}&search={HttpUtility.UrlEncode(search)}&phrase=true"; + viewerUrl = $"lib/pdf_viewer/viewer.html?file=/Data/{HttpUtility.UrlEncode(File)}#search={HttpUtility.UrlEncode(search)}&phrase=true"; } } } diff --git a/test/ProjectTemplates/Microsoft.Extensions.AI.Templates.IntegrationTests/Snapshots/aichatweb.AzureOpenAI_Qdrant_Aspire.verified/aichatweb/aichatweb.Web/Components/Pages/Chat/ChatMessageItem.razor b/test/ProjectTemplates/Microsoft.Extensions.AI.Templates.IntegrationTests/Snapshots/aichatweb.AzureOpenAI_Qdrant_Aspire.verified/aichatweb/aichatweb.Web/Components/Pages/Chat/ChatMessageItem.razor index 92c20c70667..e45d92ab5f9 100644 --- a/test/ProjectTemplates/Microsoft.Extensions.AI.Templates.IntegrationTests/Snapshots/aichatweb.AzureOpenAI_Qdrant_Aspire.verified/aichatweb/aichatweb.Web/Components/Pages/Chat/ChatMessageItem.razor +++ b/test/ProjectTemplates/Microsoft.Extensions.AI.Templates.IntegrationTests/Snapshots/aichatweb.AzureOpenAI_Qdrant_Aspire.verified/aichatweb/aichatweb.Web/Components/Pages/Chat/ChatMessageItem.razor @@ -28,11 +28,24 @@ else if (Message.Role == ChatRole.Assistant) @foreach (var citation in citations ?? []) { - + } } + else if (content is FunctionCallContent { Name: "LoadDocuments" }) + { +
+
+ + + +
+
+ Loading relevant documents (this will take a minute)... +
+
+ } else if (content is FunctionCallContent { Name: "Search" } fcc && fcc.Arguments?.TryGetValue("searchPhrase", out var searchPhrase) is true) {
@@ -56,9 +69,9 @@ else if (Message.Role == ChatRole.Assistant) @code { private static readonly ConditionalWeakTable SubscribersLookup = new(); - private static readonly Regex CitationRegex = new(@"(?.*?)", RegexOptions.NonBacktracking); + private static readonly Regex CitationRegex = new(@"(?.*?)", RegexOptions.NonBacktracking); - private List<(string File, int? Page, string Quote)>? citations; + private List<(string File, string Quote)>? citations; [Parameter, EditorRequired] public required ChatMessage Message { get; set; } @@ -88,7 +101,7 @@ else if (Message.Role == ChatRole.Assistant) { var matches = CitationRegex.Matches(text); citations = matches.Any() - ? matches.Select(m => (m.Groups["file"].Value, int.TryParse(m.Groups["page"].Value, out var page) ? page : (int?)null, m.Groups["quote"].Value)).ToList() + ? matches.Select(m => (m.Groups["file"].Value, m.Groups["quote"].Value)).ToList() : null; } } diff --git a/test/ProjectTemplates/Microsoft.Extensions.AI.Templates.IntegrationTests/Snapshots/aichatweb.AzureOpenAI_Qdrant_Aspire.verified/aichatweb/aichatweb.Web/Program.cs b/test/ProjectTemplates/Microsoft.Extensions.AI.Templates.IntegrationTests/Snapshots/aichatweb.AzureOpenAI_Qdrant_Aspire.verified/aichatweb/aichatweb.Web/Program.cs index 450914c4461..76ac926bbd1 100644 --- a/test/ProjectTemplates/Microsoft.Extensions.AI.Templates.IntegrationTests/Snapshots/aichatweb.AzureOpenAI_Qdrant_Aspire.verified/aichatweb/aichatweb.Web/Program.cs +++ b/test/ProjectTemplates/Microsoft.Extensions.AI.Templates.IntegrationTests/Snapshots/aichatweb.AzureOpenAI_Qdrant_Aspire.verified/aichatweb/aichatweb.Web/Program.cs @@ -15,10 +15,11 @@ openai.AddEmbeddingGenerator("text-embedding-3-small"); builder.AddAzureSearchClient("search"); -builder.Services.AddAzureAISearchCollection("data-aichatweb-chunks"); -builder.Services.AddAzureAISearchCollection("data-aichatweb-documents"); -builder.Services.AddScoped(); +builder.Services.AddAzureAISearchVectorStore(); +builder.Services.AddAzureAISearchCollection(IngestedChunk.CollectionName); +builder.Services.AddSingleton(); builder.Services.AddSingleton(); +builder.Services.AddKeyedSingleton("ingestion_directory", new DirectoryInfo(Path.Combine(builder.Environment.WebRootPath, "Data"))); var app = builder.Build(); @@ -39,12 +40,4 @@ app.MapRazorComponents() .AddInteractiveServerRenderMode(); -// By default, we ingest PDF files from the /wwwroot/Data directory. You can ingest from -// other sources by implementing IIngestionSource. -// Important: ensure that any content you ingest is trusted, as it may be reflected back -// to users or could be a source of prompt injection risk. -await DataIngestor.IngestDataAsync( - app.Services, - new PDFDirectorySource(Path.Combine(builder.Environment.WebRootPath, "Data"))); - app.Run(); diff --git a/test/ProjectTemplates/Microsoft.Extensions.AI.Templates.IntegrationTests/Snapshots/aichatweb.AzureOpenAI_Qdrant_Aspire.verified/aichatweb/aichatweb.Web/Services/IngestedChunk.cs b/test/ProjectTemplates/Microsoft.Extensions.AI.Templates.IntegrationTests/Snapshots/aichatweb.AzureOpenAI_Qdrant_Aspire.verified/aichatweb/aichatweb.Web/Services/IngestedChunk.cs index 0fd76874dfd..2d93db8fd94 100644 --- a/test/ProjectTemplates/Microsoft.Extensions.AI.Templates.IntegrationTests/Snapshots/aichatweb.AzureOpenAI_Qdrant_Aspire.verified/aichatweb/aichatweb.Web/Services/IngestedChunk.cs +++ b/test/ProjectTemplates/Microsoft.Extensions.AI.Templates.IntegrationTests/Snapshots/aichatweb.AzureOpenAI_Qdrant_Aspire.verified/aichatweb/aichatweb.Web/Services/IngestedChunk.cs @@ -1,24 +1,31 @@ -using Microsoft.Extensions.VectorData; +using System.Text.Json.Serialization; +using Microsoft.Extensions.VectorData; namespace aichatweb.Web.Services; public class IngestedChunk { - private const int VectorDimensions = 1536; // 1536 is the default vector size for the OpenAI text-embedding-3-small model - private const string VectorDistanceFunction = DistanceFunction.CosineSimilarity; + public const int VectorDimensions = 1536; // 1536 is the default vector size for the OpenAI text-embedding-3-small model + public const string VectorDistanceFunction = DistanceFunction.CosineSimilarity; + public const string CollectionName = "data-aichatweb-chunks"; - [VectorStoreKey] - public required string Key { get; set; } + [VectorStoreKey(StorageName = "key")] + [JsonPropertyName("key")] + public required Guid Key { get; set; } - [VectorStoreData(IsIndexed = true)] + [VectorStoreData(StorageName = "documentid")] + [JsonPropertyName("documentid")] public required string DocumentId { get; set; } - [VectorStoreData] - public int PageNumber { get; set; } - - [VectorStoreData] + [VectorStoreData(StorageName = "content")] + [JsonPropertyName("content")] public required string Text { get; set; } - [VectorStoreVector(VectorDimensions, DistanceFunction = VectorDistanceFunction)] + [VectorStoreData(StorageName = "context")] + [JsonPropertyName("context")] + public string? Context { get; set; } + + [VectorStoreVector(VectorDimensions, DistanceFunction = VectorDistanceFunction, StorageName = "embedding")] + [JsonPropertyName("embedding")] public string? Vector => Text; } diff --git a/test/ProjectTemplates/Microsoft.Extensions.AI.Templates.IntegrationTests/Snapshots/aichatweb.AzureOpenAI_Qdrant_Aspire.verified/aichatweb/aichatweb.Web/Services/IngestedDocument.cs b/test/ProjectTemplates/Microsoft.Extensions.AI.Templates.IntegrationTests/Snapshots/aichatweb.AzureOpenAI_Qdrant_Aspire.verified/aichatweb/aichatweb.Web/Services/IngestedDocument.cs deleted file mode 100644 index 370aef16fd9..00000000000 --- a/test/ProjectTemplates/Microsoft.Extensions.AI.Templates.IntegrationTests/Snapshots/aichatweb.AzureOpenAI_Qdrant_Aspire.verified/aichatweb/aichatweb.Web/Services/IngestedDocument.cs +++ /dev/null @@ -1,25 +0,0 @@ -using Microsoft.Extensions.VectorData; - -namespace aichatweb.Web.Services; - -public class IngestedDocument -{ - private const int VectorDimensions = 2; - private const string VectorDistanceFunction = DistanceFunction.CosineSimilarity; - - [VectorStoreKey] - public required string Key { get; set; } - - [VectorStoreData(IsIndexed = true)] - public required string SourceId { get; set; } - - [VectorStoreData] - public required string DocumentId { get; set; } - - [VectorStoreData] - public required string DocumentVersion { get; set; } - - // The vector is not used but required for some vector databases - [VectorStoreVector(VectorDimensions, DistanceFunction = VectorDistanceFunction)] - public ReadOnlyMemory Vector { get; set; } = new ReadOnlyMemory([0, 0]); -} diff --git a/test/ProjectTemplates/Microsoft.Extensions.AI.Templates.IntegrationTests/Snapshots/aichatweb.AzureOpenAI_Qdrant_Aspire.verified/aichatweb/aichatweb.Web/Services/Ingestion/DataIngestor.cs b/test/ProjectTemplates/Microsoft.Extensions.AI.Templates.IntegrationTests/Snapshots/aichatweb.AzureOpenAI_Qdrant_Aspire.verified/aichatweb/aichatweb.Web/Services/Ingestion/DataIngestor.cs index 2fe43370071..9dd366a03a5 100644 --- a/test/ProjectTemplates/Microsoft.Extensions.AI.Templates.IntegrationTests/Snapshots/aichatweb.AzureOpenAI_Qdrant_Aspire.verified/aichatweb/aichatweb.Web/Services/Ingestion/DataIngestor.cs +++ b/test/ProjectTemplates/Microsoft.Extensions.AI.Templates.IntegrationTests/Snapshots/aichatweb.AzureOpenAI_Qdrant_Aspire.verified/aichatweb/aichatweb.Web/Services/Ingestion/DataIngestor.cs @@ -1,58 +1,35 @@ using Microsoft.Extensions.AI; +using Microsoft.Extensions.DataIngestion; +using Microsoft.Extensions.DataIngestion.Chunkers; using Microsoft.Extensions.VectorData; +using Microsoft.ML.Tokenizers; namespace aichatweb.Web.Services.Ingestion; public class DataIngestor( ILogger logger, - VectorStoreCollection chunksCollection, - VectorStoreCollection documentsCollection) + ILoggerFactory loggerFactory, + VectorStore vectorStore, + IEmbeddingGenerator> embeddingGenerator) { - public static async Task IngestDataAsync(IServiceProvider services, IIngestionSource source) + public async Task IngestDataAsync(DirectoryInfo directory, string searchPattern) { - using var scope = services.CreateScope(); - var ingestor = scope.ServiceProvider.GetRequiredService(); - await ingestor.IngestDataAsync(source); - } - - public async Task IngestDataAsync(IIngestionSource source) - { - await chunksCollection.EnsureCollectionExistsAsync(); - await documentsCollection.EnsureCollectionExistsAsync(); - - var sourceId = source.SourceId; - var documentsForSource = await documentsCollection.GetAsync(doc => doc.SourceId == sourceId, top: int.MaxValue).ToListAsync(); - - var deletedDocuments = await source.GetDeletedDocumentsAsync(documentsForSource); - foreach (var deletedDocument in deletedDocuments) + using var writer = new VectorStoreWriter(vectorStore, dimensionCount: IngestedChunk.VectorDimensions, new() { - logger.LogInformation("Removing ingested data for {DocumentId}", deletedDocument.DocumentId); - await DeleteChunksForDocumentAsync(deletedDocument); - await documentsCollection.DeleteAsync(deletedDocument.Key); - } - - var modifiedDocuments = await source.GetNewOrModifiedDocumentsAsync(documentsForSource); - foreach (var modifiedDocument in modifiedDocuments) - { - logger.LogInformation("Processing {DocumentId}", modifiedDocument.DocumentId); - await DeleteChunksForDocumentAsync(modifiedDocument); - - await documentsCollection.UpsertAsync(modifiedDocument); - - var newRecords = await source.CreateChunksForDocumentAsync(modifiedDocument); - await chunksCollection.UpsertAsync(newRecords); - } - - logger.LogInformation("Ingestion is up-to-date"); - - async Task DeleteChunksForDocumentAsync(IngestedDocument document) + CollectionName = IngestedChunk.CollectionName, + DistanceFunction = IngestedChunk.VectorDistanceFunction, + IncrementalIngestion = false, + }); + + using var pipeline = new IngestionPipeline( + reader: new DocumentReader(directory), + chunker: new SemanticSimilarityChunker(embeddingGenerator, new(TiktokenTokenizer.CreateForModel("gpt-4o"))), + writer: writer, + loggerFactory: loggerFactory); + + await foreach (var result in pipeline.ProcessAsync(directory, searchPattern)) { - var documentId = document.DocumentId; - var chunksToDelete = await chunksCollection.GetAsync(record => record.DocumentId == documentId, int.MaxValue).ToListAsync(); - if (chunksToDelete.Count != 0) - { - await chunksCollection.DeleteAsync(chunksToDelete.Select(r => r.Key)); - } + logger.LogInformation("Completed processing '{id}'. Succeeded: '{succeeded}'.", result.DocumentId, result.Succeeded); } } } diff --git a/test/ProjectTemplates/Microsoft.Extensions.AI.Templates.IntegrationTests/Snapshots/aichatweb.AzureOpenAI_Qdrant_Aspire.verified/aichatweb/aichatweb.Web/Services/Ingestion/DocumentReader.cs b/test/ProjectTemplates/Microsoft.Extensions.AI.Templates.IntegrationTests/Snapshots/aichatweb.AzureOpenAI_Qdrant_Aspire.verified/aichatweb/aichatweb.Web/Services/Ingestion/DocumentReader.cs new file mode 100644 index 00000000000..60fcdbdc128 --- /dev/null +++ b/test/ProjectTemplates/Microsoft.Extensions.AI.Templates.IntegrationTests/Snapshots/aichatweb.AzureOpenAI_Qdrant_Aspire.verified/aichatweb/aichatweb.Web/Services/Ingestion/DocumentReader.cs @@ -0,0 +1,42 @@ +using Microsoft.Extensions.DataIngestion; + +namespace aichatweb.Web.Services.Ingestion; + +internal sealed class DocumentReader(DirectoryInfo rootDirectory) : IngestionDocumentReader +{ + private readonly MarkdownReader _markdownReader = new(); + private readonly MarkItDownMcpReader _pdfReader = new(mcpServerUri: GetMarkItDownMcpServerUrl()); + + public override Task ReadAsync(FileInfo source, string identifier, string? mediaType = null, CancellationToken cancellationToken = default) + { + if (Path.IsPathFullyQualified(identifier)) + { + // Normalize the identifier to its relative path + identifier = Path.GetRelativePath(rootDirectory.FullName, identifier); + } + + mediaType = GetCustomMediaType(source) ?? mediaType; + return base.ReadAsync(source, identifier, mediaType, cancellationToken); + } + + public override Task ReadAsync(Stream source, string identifier, string mediaType, CancellationToken cancellationToken = default) + => mediaType switch + { + "application/pdf" => _pdfReader.ReadAsync(source, identifier, mediaType, cancellationToken), + "text/markdown" => _markdownReader.ReadAsync(source, identifier, mediaType, cancellationToken), + _ => throw new InvalidOperationException($"Unsupported media type '{mediaType}'"), + }; + + private static string? GetCustomMediaType(FileInfo source) + => source.Extension switch + { + ".md" => "text/markdown", + _ => null + }; + + private static Uri GetMarkItDownMcpServerUrl() + { + var markItDownMcpUrl = $"{Environment.GetEnvironmentVariable("MARKITDOWN_MCP_URL")}/mcp"; + return new Uri(markItDownMcpUrl); + } +} diff --git a/test/ProjectTemplates/Microsoft.Extensions.AI.Templates.IntegrationTests/Snapshots/aichatweb.AzureOpenAI_Qdrant_Aspire.verified/aichatweb/aichatweb.Web/Services/Ingestion/IIngestionSource.cs b/test/ProjectTemplates/Microsoft.Extensions.AI.Templates.IntegrationTests/Snapshots/aichatweb.AzureOpenAI_Qdrant_Aspire.verified/aichatweb/aichatweb.Web/Services/Ingestion/IIngestionSource.cs deleted file mode 100644 index a1c6b2191d1..00000000000 --- a/test/ProjectTemplates/Microsoft.Extensions.AI.Templates.IntegrationTests/Snapshots/aichatweb.AzureOpenAI_Qdrant_Aspire.verified/aichatweb/aichatweb.Web/Services/Ingestion/IIngestionSource.cs +++ /dev/null @@ -1,12 +0,0 @@ -namespace aichatweb.Web.Services.Ingestion; - -public interface IIngestionSource -{ - string SourceId { get; } - - Task> GetNewOrModifiedDocumentsAsync(IReadOnlyList existingDocuments); - - Task> GetDeletedDocumentsAsync(IReadOnlyList existingDocuments); - - Task> CreateChunksForDocumentAsync(IngestedDocument document); -} diff --git a/test/ProjectTemplates/Microsoft.Extensions.AI.Templates.IntegrationTests/Snapshots/aichatweb.AzureOpenAI_Qdrant_Aspire.verified/aichatweb/aichatweb.Web/Services/Ingestion/PDFDirectorySource.cs b/test/ProjectTemplates/Microsoft.Extensions.AI.Templates.IntegrationTests/Snapshots/aichatweb.AzureOpenAI_Qdrant_Aspire.verified/aichatweb/aichatweb.Web/Services/Ingestion/PDFDirectorySource.cs deleted file mode 100644 index 32e9f225c08..00000000000 --- a/test/ProjectTemplates/Microsoft.Extensions.AI.Templates.IntegrationTests/Snapshots/aichatweb.AzureOpenAI_Qdrant_Aspire.verified/aichatweb/aichatweb.Web/Services/Ingestion/PDFDirectorySource.cs +++ /dev/null @@ -1,71 +0,0 @@ -using Microsoft.SemanticKernel.Text; -using UglyToad.PdfPig; -using UglyToad.PdfPig.Content; -using UglyToad.PdfPig.DocumentLayoutAnalysis.PageSegmenter; -using UglyToad.PdfPig.DocumentLayoutAnalysis.WordExtractor; - -namespace aichatweb.Web.Services.Ingestion; - -public class PDFDirectorySource(string sourceDirectory) : IIngestionSource -{ - public static string SourceFileId(string path) => Path.GetFileName(path); - public static string SourceFileVersion(string path) => File.GetLastWriteTimeUtc(path).ToString("o"); - - public string SourceId => $"{nameof(PDFDirectorySource)}:{sourceDirectory}"; - - public Task> GetNewOrModifiedDocumentsAsync(IReadOnlyList existingDocuments) - { - var results = new List(); - var sourceFiles = Directory.GetFiles(sourceDirectory, "*.pdf"); - var existingDocumentsById = existingDocuments.ToDictionary(d => d.DocumentId); - - foreach (var sourceFile in sourceFiles) - { - var sourceFileId = SourceFileId(sourceFile); - var sourceFileVersion = SourceFileVersion(sourceFile); - var existingDocumentVersion = existingDocumentsById.TryGetValue(sourceFileId, out var existingDocument) ? existingDocument.DocumentVersion : null; - if (existingDocumentVersion != sourceFileVersion) - { - results.Add(new() { Key = Guid.CreateVersion7().ToString(), SourceId = SourceId, DocumentId = sourceFileId, DocumentVersion = sourceFileVersion }); - } - } - - return Task.FromResult((IEnumerable)results); - } - - public Task> GetDeletedDocumentsAsync(IReadOnlyList existingDocuments) - { - var currentFiles = Directory.GetFiles(sourceDirectory, "*.pdf"); - var currentFileIds = currentFiles.ToLookup(SourceFileId); - var deletedDocuments = existingDocuments.Where(d => !currentFileIds.Contains(d.DocumentId)); - return Task.FromResult(deletedDocuments); - } - - public Task> CreateChunksForDocumentAsync(IngestedDocument document) - { - using var pdf = PdfDocument.Open(Path.Combine(sourceDirectory, document.DocumentId)); - var paragraphs = pdf.GetPages().SelectMany(GetPageParagraphs).ToList(); - - return Task.FromResult(paragraphs.Select(p => new IngestedChunk - { - Key = Guid.CreateVersion7().ToString(), - DocumentId = document.DocumentId, - PageNumber = p.PageNumber, - Text = p.Text, - })); - } - - private static IEnumerable<(int PageNumber, int IndexOnPage, string Text)> GetPageParagraphs(Page pdfPage) - { - var letters = pdfPage.Letters; - var words = NearestNeighbourWordExtractor.Instance.GetWords(letters); - var textBlocks = DocstrumBoundingBoxes.Instance.GetBlocks(words); - var pageText = string.Join(Environment.NewLine + Environment.NewLine, - textBlocks.Select(t => t.Text.ReplaceLineEndings(" "))); - -#pragma warning disable SKEXP0050 // Type is for evaluation purposes only - return TextChunker.SplitPlainTextParagraphs([pageText], 200) - .Select((text, index) => (pdfPage.Number, index, text)); -#pragma warning restore SKEXP0050 // Type is for evaluation purposes only - } -} diff --git a/test/ProjectTemplates/Microsoft.Extensions.AI.Templates.IntegrationTests/Snapshots/aichatweb.AzureOpenAI_Qdrant_Aspire.verified/aichatweb/aichatweb.Web/Services/SemanticSearch.cs b/test/ProjectTemplates/Microsoft.Extensions.AI.Templates.IntegrationTests/Snapshots/aichatweb.AzureOpenAI_Qdrant_Aspire.verified/aichatweb/aichatweb.Web/Services/SemanticSearch.cs index 84fb719f6ae..d043c8efb84 100644 --- a/test/ProjectTemplates/Microsoft.Extensions.AI.Templates.IntegrationTests/Snapshots/aichatweb.AzureOpenAI_Qdrant_Aspire.verified/aichatweb/aichatweb.Web/Services/SemanticSearch.cs +++ b/test/ProjectTemplates/Microsoft.Extensions.AI.Templates.IntegrationTests/Snapshots/aichatweb.AzureOpenAI_Qdrant_Aspire.verified/aichatweb/aichatweb.Web/Services/SemanticSearch.cs @@ -1,12 +1,22 @@ -using Microsoft.Extensions.VectorData; +using aichatweb.Web.Services.Ingestion; +using Microsoft.Extensions.VectorData; namespace aichatweb.Web.Services; public class SemanticSearch( - VectorStoreCollection vectorCollection) + VectorStoreCollection vectorCollection, + [FromKeyedServices("ingestion_directory")] DirectoryInfo ingestionDirectory, + DataIngestor dataIngestor) { + private Task? _ingestionTask; + + public async Task LoadDocumentsAsync() => await ( _ingestionTask ??= dataIngestor.IngestDataAsync(ingestionDirectory, searchPattern: "*.*")); + public async Task> SearchAsync(string text, string? documentIdFilter, int maxResults) { + // Ensure documents have been loaded before searching + await LoadDocumentsAsync(); + var nearest = vectorCollection.SearchAsync(text, maxResults, new VectorSearchOptions { Filter = documentIdFilter is { Length: > 0 } ? record => record.DocumentId == documentIdFilter : null, diff --git a/test/ProjectTemplates/Microsoft.Extensions.AI.Templates.IntegrationTests/Snapshots/aichatweb.AzureOpenAI_Qdrant_Aspire.verified/aichatweb/aichatweb.Web/aichatweb.Web.csproj b/test/ProjectTemplates/Microsoft.Extensions.AI.Templates.IntegrationTests/Snapshots/aichatweb.AzureOpenAI_Qdrant_Aspire.verified/aichatweb/aichatweb.Web/aichatweb.Web.csproj index 861a3a974c6..f97d0b28a77 100644 --- a/test/ProjectTemplates/Microsoft.Extensions.AI.Templates.IntegrationTests/Snapshots/aichatweb.AzureOpenAI_Qdrant_Aspire.verified/aichatweb/aichatweb.Web/aichatweb.Web.csproj +++ b/test/ProjectTemplates/Microsoft.Extensions.AI.Templates.IntegrationTests/Snapshots/aichatweb.AzureOpenAI_Qdrant_Aspire.verified/aichatweb/aichatweb.Web/aichatweb.Web.csproj @@ -1,7 +1,7 @@  - net9.0 + net10.0 enable enable secret @@ -11,11 +11,13 @@ - - - + + + + + - + diff --git a/test/ProjectTemplates/Microsoft.Extensions.AI.Templates.IntegrationTests/Snapshots/aichatweb.AzureOpenAI_Qdrant_Aspire.verified/aichatweb/aichatweb.Web/wwwroot/Data/Example_GPS_Watch.md b/test/ProjectTemplates/Microsoft.Extensions.AI.Templates.IntegrationTests/Snapshots/aichatweb.AzureOpenAI_Qdrant_Aspire.verified/aichatweb/aichatweb.Web/wwwroot/Data/Example_GPS_Watch.md new file mode 100644 index 00000000000..f7d042edf83 --- /dev/null +++ b/test/ProjectTemplates/Microsoft.Extensions.AI.Templates.IntegrationTests/Snapshots/aichatweb.AzureOpenAI_Qdrant_Aspire.verified/aichatweb/aichatweb.Web/wwwroot/Data/Example_GPS_Watch.md @@ -0,0 +1,193 @@ +# TrailMaster GPS Watch + +## 1. Introduction + +ExpeditionTech is proud to introduce the TrailMaster GPS Watch, a state-of-the-art outdoor electronics device designed for the most demanding outdoor adventurers. This watch is meticulously engineered to provide accurate location information, real-time sharing, and reliable mapping capabilities. The TrailMaster GPS Watch is built to withstand the harshest environmental conditions while providing users with the critical data they need to navigate through challenging terrain and optimize their outdoor experiences. + +### 1.1 Product Overview + +The TrailMaster GPS Watch is a high-performance outdoor electronics device that combines advanced GPS technology with rugged design. It features a durable, shock-resistant casing, a high-contrast display for optimal visibility in bright sunlight, and a built-in rechargeable battery for extended use in remote areas. The TrailMaster GPS Watch is equipped with a comprehensive suite of navigation tools, including topographic maps, trail tracking, and waypoint management. Additionally, it offers real-time location sharing for enhanced safety and group coordination during outdoor activities. + +### 1.2 Intended Use + +The TrailMaster GPS Watch is intended for use by experienced outdoor enthusiasts, including hikers, backpackers, trail runners, and mountaineers. This device is designed to provide essential navigation information and location tracking in remote, off-grid environments. Users can rely on the TrailMaster GPS Watch to plan and execute their outdoor adventures with confidence, knowing they have access to accurate maps, location data, and real-time sharing capabilities. Although the TrailMaster GPS Watch is engineered for extreme durability, users should always exercise caution and take appropriate safety measures when engaging in outdoor activities. + +#### 1.2.1 Safety Precautions + +Before using the TrailMaster GPS Watch, users must ensure that the device is fully charged and properly calibrated according to the manufacturer's specifications. It is essential to familiarize oneself with the watch's features, controls, and navigation functions before venturing into remote outdoor areas. Users should also be aware of potential environmental hazards, such as extreme weather conditions, rugged terrain, and limited access to emergency services. Proper planning, preparation, and adherence to best practices for outdoor safety are critical when using the TrailMaster GPS Watch. + +## 2. Technical Specifications + +### 2.1 Hardware + +#### 2.1.1 Processor and Memory + +The TrailMaster GPS Watch is equipped with a high-performance ARM Cortex processor, ensuring fast and efficient operation for all your outdoor activities. The device also comes with 4GB of internal memory, providing ample storage for maps, routes, and waypoints. The processor operates at 1.2GHz, allowing for quick map rendering and location updates. + +#### 2.1.2 GPS Module + +The GPS module in the TrailMaster GPS Watch utilizes a state-of-the-art multi-constellation receiver, supporting GPS, GLONASS, and Galileo satellite systems. This enables precise location tracking and navigation, even in challenging outdoor environments. The module also features advanced signal processing algorithms, ensuring reliable performance in remote areas with limited satellite visibility. + +#### 2.1.3 Sensors + +Equipped with a comprehensive set of sensors, the TrailMaster GPS Watch offers an array of valuable data for outdoor enthusiasts. The built-in altimeter provides accurate altitude readings, while the barometer monitors changes in air pressure to forecast weather conditions. Additionally, the watch includes a digital compass for reliable orientation, ensuring a seamless navigation experience in the great outdoors. + +### 2.2 Software + +#### 2.2.1 Operating System + +The TrailMaster GPS Watch runs on a proprietary operating system optimized for outdoor navigation and tracking. This custom OS combines robustness and efficiency, allowing for seamless integration with the device's hardware and sensors. The interface is designed for intuitive interaction, enabling users to access maps, location sharing, and other features with ease, even in challenging outdoor conditions. + +#### 2.2.2 Map Data + +The TrailMaster GPS Watch comes preloaded with detailed topographic maps, providing comprehensive coverage of trails, terrain, and points of interest. These maps are stored locally on the device, ensuring rapid access and smooth navigation without relying on cellular or data network connectivity. Users can also import additional map data via the dedicated USB port, expanding the watch's mapping capabilities for customized adventures. + +## 3. Setup and Installation + +### 3.1 Charging + +Before using your TrailMaster GPS Watch for the first time, it is essential to ensure that the device is fully charged. To charge your GPS watch, follow these steps: + +1. Locate the charging port cover on the back of the watch. +2. Gently lift the cover to expose the charging port. +3. Connect the provided USB charging cable to the port, ensuring a secure connection. +4. Plug the other end of the cable into a power source, such as a computer or USB wall adapter. +5. Allow the watch to charge for at least 2 hours, or until the battery indicator on the display shows it is fully charged. + +For optimal performance, it is recommended to fully charge the device before each use and to avoid overcharging. Please refer to the TrailMaster GPS Watch technical specifications for detailed battery charging information. + +### 3.2 Initial Configuration + +Once your TrailMaster GPS Watch is fully charged, you can proceed with the initial configuration by following these steps: + +1. Press and hold the power button located on the side of the watch to turn it on. +2. Follow the on-screen instructions to select your language, set the date and time, and calibrate the GPS. +3. Connect the watch to your smartphone using the TrailMaster companion app to enable real-time location sharing and receive notifications. +4. Customize the watch settings, such as display preferences and map views, to suit your outdoor activities. + +Before using the GPS functionality, it is crucial to ensure that the watch has a clear view of the sky to acquire GPS signals. Please refer to the TrailMaster GPS Watch user guide for detailed instructions on GPS calibration and satellite acquisition. + +## 4. Operation + +### 4.1 Basic Functions + +The TrailMaster GPS Watch is designed for outdoor use and offers a variety of basic functions to assist users in navigating and staying connected during their adventures. + +#### 4.1.1 Powering On and Off + +To power on the TrailMaster GPS Watch, press and hold the power button (located on the right side of the watch) for 3 seconds. The watch will display the ExpeditionTech logo and then proceed to the main navigation screen. To power off the watch, press and hold the power button and select "Power Off" from the menu. + +#### 4.1.2 Accessing Built-in Maps + +The TrailMaster GPS Watch comes pre-loaded with detailed maps of various outdoor locations. To access the maps, press the map button (located on the left side of the watch) to bring up the map interface. From here, you can view your current location, set waypoints, and plan routes. + +#### 4.1.3 Real-time Location Sharing + +Utilize the real-time location sharing feature to transmit your current location to designated contacts. Press the share button (located on the top of the watch) and select the specific contacts you wish to share your location with. This feature requires a stable GPS signal and a connected smartphone with the TrailMaster app installed. + +### 4.2 Advanced Features + +The TrailMaster GPS Watch offers advanced features to enhance the user experience and provide additional functionality for outdoor enthusiasts. + +#### 4.2.1 Rugged Design + +The TrailMaster GPS Watch is built to withstand rugged outdoor conditions, including extreme temperatures, water exposure, and impact. The durable casing and reinforced strap ensure that the watch remains operational in challenging environments. + +#### 4.2.2 Navigation Tools + +In addition to basic map access, the TrailMaster GPS Watch includes advanced navigation tools such as compass, altimeter, and barometer. These tools provide vital information for navigation and weather monitoring while in the field. + +#### 4.2.3 Customizing Data Screens + +Users can customize the data screens on the TrailMaster GPS Watch to display the specific information they require during their outdoor activities. From the main menu, navigate to the settings and select "Data Screens" to adjust the layout and content of the screens. + +#### 4.2.4 Tracking Performance Metrics + +The TrailMaster GPS Watch is equipped with sensors to track performance metrics such as distance traveled, speed, elevation gain, and heart rate. Use the tracking mode to monitor these metrics in real-time or review them after completing an activity. + +## 5. Troubleshooting + +### 5.1 Diagnostic Tools and Equipment + +When troubleshooting the TrailMaster GPS Watch, it is essential to use specialized industrial diagnostic tools and equipment to perform accurate diagnostic tests. These tools and equipment include: + +- **GPS Signal Analyzer**: Use a GPS signal analyzer to check the strength and quality of the satellite signals received by the watch. +- **RF Spectrum Analyzer**: An RF spectrum analyzer is required to analyze the radio frequency spectrum and identify any interference affecting the GPS reception. +- **Ruggedness Test Equipment**: Perform ruggedness tests using shock and vibration equipment to ensure the watch can withstand outdoor adventures without performance issues. + +It is essential to use these specialized tools and equipment to accurately diagnose any issues with the TrailMaster GPS Watch and ensure optimal performance. + +### 5.2 Common Issues + +#### 5.2.1 GPS Signal Loss + +**Symptoms:** + +The watch displays "No GPS Signal" or intermittently loses GPS signal during use. + +**Potential Causes:** + +- Obstruction of satellite signals due to dense foliage, tall buildings, or natural terrain features. +- Radio frequency interference affecting GPS reception. +- Wear and tear on the GPS antenna or receiver. + +**Troubleshooting Steps:** + +1. Check the surroundings for any obstructions blocking satellite signals. +2. Use an RF spectrum analyzer to identify any potential sources of interference. +3. Perform a diagnostics test using a GPS signal analyzer to assess the strength and quality of the GPS signal received by the watch. +4. If the issue persists, contact ExpeditionTech customer support for further assistance. + +#### 5.2.2 Connectivity Issues + +**Symptoms:** + +- Inability to share real-time location or connect to other devices. +- Unreliable Bluetooth connectivity. + +**Potential Causes:** + +- Bluetooth interference from other electronic devices. +- Signal obstruction due to environmental factors. +- Software or firmware issues. + +**Troubleshooting Steps:** + +1. Ensure the watch is within the recommended Bluetooth range of the connected device. +2. Identify and eliminate potential sources of Bluetooth interference in the vicinity. +3. Update the watch's firmware to the latest version to address any software-related connectivity issues. +4. If connectivity problems persist, perform a comprehensive diagnostics test using a specialized Bluetooth signal analyzer. + +By following these troubleshooting steps and using specialized diagnostic tools and equipment, users can effectively identify and address common issues with the TrailMaster GPS Watch. + +## 6. Maintenance and Care + +### 6.1 Cleaning + +It is important to regularly clean your TrailMaster GPS Watch to ensure optimal performance. Use a soft, damp cloth to gently wipe the watch face and straps. Do not use harsh chemicals or solvents, as these may damage the watch's rugged design and built-in maps. + +### 6.2 Battery Maintenance + +The TrailMaster GPS Watch is equipped with a rechargeable lithium-ion battery. To optimize battery life, it is recommended to fully charge the watch before each outdoor adventure. Additionally, it is important to avoid exposing the watch to extreme temperatures, as this may affect battery performance. + +### 6.3 Storage + +When not in use, store your TrailMaster GPS Watch in a cool, dry place. Avoid prolonged exposure to direct sunlight or extreme temperatures, as this may cause damage to the device. + +### 6.4 Software Updates + +To ensure that your TrailMaster GPS Watch operates efficiently, it is important to regularly check for and install software updates. These updates may include improvements to the built-in maps, real-time location sharing, and overall performance of the watch. + +### 6.5 Technical Diagnostics + +For advanced maintenance and care, it is recommended to perform technical diagnostics using specialized industrial and scientific equipment. Refer to formal industry specification codes and standards bodies for detailed instructions on performing these diagnostics. + +## 7. Regulatory Compliance + +### 7.1 FCC Compliance + +The ExpeditionTech TrailMaster GPS Watch complies with Part 15 of the FCC rules. Operation is subject to the following two conditions: (1) this device may not cause harmful interference, and (2) this device must accept any interference received, including interference that may cause undesired operation. Any changes or modifications not expressly approved by the party responsible for compliance could void the user's authority to operate the equipment. The user is cautioned that any changes or modifications made to this device that are not expressly approved by the manufacturer could void the user's authority to operate the equipment. + +### 7.2 CE Marking + +The CE marking on the ExpeditionTech TrailMaster GPS Watch indicates that it complies with the essential requirements of the relevant European health, safety, and environmental protection legislation. The device is in conformity with the essential requirements and other relevant provisions of Directive 1999/5/EC. The CE marking is affixed to the device to demonstrate that it meets the essential requirements for safety, health, and environmental protection. The user should only use the device in accordance with the instructions provided in the user manual. diff --git a/test/ProjectTemplates/Microsoft.Extensions.AI.Templates.IntegrationTests/Snapshots/aichatweb.AzureOpenAI_Qdrant_Aspire.verified/aichatweb/aichatweb.Web/wwwroot/Data/Example_GPS_Watch.pdf b/test/ProjectTemplates/Microsoft.Extensions.AI.Templates.IntegrationTests/Snapshots/aichatweb.AzureOpenAI_Qdrant_Aspire.verified/aichatweb/aichatweb.Web/wwwroot/Data/Example_GPS_Watch.pdf deleted file mode 100644 index c87df644c58..00000000000 Binary files a/test/ProjectTemplates/Microsoft.Extensions.AI.Templates.IntegrationTests/Snapshots/aichatweb.AzureOpenAI_Qdrant_Aspire.verified/aichatweb/aichatweb.Web/wwwroot/Data/Example_GPS_Watch.pdf and /dev/null differ diff --git a/test/ProjectTemplates/Microsoft.Extensions.AI.Templates.IntegrationTests/Snapshots/aichatweb.AzureOpenAI_Qdrant_Aspire.verified/aichatweb/aichatweb.Web/wwwroot/lib/markdown_viewer/viewer.html b/test/ProjectTemplates/Microsoft.Extensions.AI.Templates.IntegrationTests/Snapshots/aichatweb.AzureOpenAI_Qdrant_Aspire.verified/aichatweb/aichatweb.Web/wwwroot/lib/markdown_viewer/viewer.html new file mode 100644 index 00000000000..94447ffc47e --- /dev/null +++ b/test/ProjectTemplates/Microsoft.Extensions.AI.Templates.IntegrationTests/Snapshots/aichatweb.AzureOpenAI_Qdrant_Aspire.verified/aichatweb/aichatweb.Web/wwwroot/lib/markdown_viewer/viewer.html @@ -0,0 +1,32 @@ + + + + + Markdown viewer + + + + +
+ + + diff --git a/test/ProjectTemplates/Microsoft.Extensions.AI.Templates.IntegrationTests/Snapshots/aichatweb.AzureOpenAI_Qdrant_Aspire.verified/aichatweb/aichatweb.Web/wwwroot/lib/markdown_viewer/viewer.mjs b/test/ProjectTemplates/Microsoft.Extensions.AI.Templates.IntegrationTests/Snapshots/aichatweb.AzureOpenAI_Qdrant_Aspire.verified/aichatweb/aichatweb.Web/wwwroot/lib/markdown_viewer/viewer.mjs new file mode 100644 index 00000000000..78eb819c9a8 --- /dev/null +++ b/test/ProjectTemplates/Microsoft.Extensions.AI.Templates.IntegrationTests/Snapshots/aichatweb.AzureOpenAI_Qdrant_Aspire.verified/aichatweb/aichatweb.Web/wwwroot/lib/markdown_viewer/viewer.mjs @@ -0,0 +1,13 @@ +import { parse } from '../marked/dist/marked.esm.js'; +import purify from '../dompurify/dist/purify.es.mjs'; + +const url = new URL(window.location); +const fileUrl = url.searchParams.get('file'); +if (!fileUrl) { + throw new Error('File not specified in the URL query string'); +} + +var response = await fetch(fileUrl); +var text = await response.text(); + +document.getElementById('content').innerHTML = purify.sanitize(parse(text)); diff --git a/test/ProjectTemplates/Microsoft.Extensions.AI.Templates.IntegrationTests/Snapshots/aichatweb.Basic.verified/aichatweb/Components/Pages/Chat/Chat.razor b/test/ProjectTemplates/Microsoft.Extensions.AI.Templates.IntegrationTests/Snapshots/aichatweb.Basic.verified/aichatweb/Components/Pages/Chat/Chat.razor index 8aa0ec9fd28..6fc5881c18f 100644 --- a/test/ProjectTemplates/Microsoft.Extensions.AI.Templates.IntegrationTests/Snapshots/aichatweb.Basic.verified/aichatweb/Components/Pages/Chat/Chat.razor +++ b/test/ProjectTemplates/Microsoft.Extensions.AI.Templates.IntegrationTests/Snapshots/aichatweb.Basic.verified/aichatweb/Components/Pages/Chat/Chat.razor @@ -13,7 +13,7 @@
To get started, try asking about these example documents. You can replace these with your own data and replace this message.
- + @@ -29,10 +29,12 @@ Do not answer questions about anything else. Use only simple markdown to format your responses. - Use the search tool to find relevant information. When you do this, end your + Use the LoadDocuments tool to prepare for searches before answering any questions. + + Use the Search tool to find relevant information. When you do this, end your reply with citations in the special XML format: - exact quote here + exact quote here Always include the citation in your response if there are results. @@ -52,7 +54,10 @@ { statefulMessageCount = 0; messages.Add(new(ChatRole.System, SystemPrompt)); - chatOptions.Tools = [AIFunctionFactory.Create(SearchAsync)]; + chatOptions.Tools = [ + AIFunctionFactory.Create(LoadDocumentsAsync), + AIFunctionFactory.Create(SearchAsync) + ]; } private async Task AddUserMessageAsync(ChatMessage userMessage) @@ -106,7 +111,14 @@ await chatInput!.FocusAsync(); } - [Description("Searches for information using a phrase or keyword")] + [Description("Loads the documents needed for performing searches. Must be completed before a search can be executed, but only needs to be completed once.")] + private async Task LoadDocumentsAsync() + { + await InvokeAsync(StateHasChanged); + await Search.LoadDocumentsAsync(); + } + + [Description("Searches for information using a phrase or keyword. Relies on documents already being loaded.")] private async Task> SearchAsync( [Description("The phrase to search for.")] string searchPhrase, [Description("If possible, specify the filename to search that file only. If not provided or empty, the search includes all files.")] string? filenameFilter = null) @@ -114,7 +126,7 @@ await InvokeAsync(StateHasChanged); var results = await Search.SearchAsync(searchPhrase, filenameFilter, maxResults: 5); return results.Select(result => - $"{result.Text}"); + $"{result.Text}"); } public void Dispose() diff --git a/test/ProjectTemplates/Microsoft.Extensions.AI.Templates.IntegrationTests/Snapshots/aichatweb.Basic.verified/aichatweb/Components/Pages/Chat/ChatCitation.razor b/test/ProjectTemplates/Microsoft.Extensions.AI.Templates.IntegrationTests/Snapshots/aichatweb.Basic.verified/aichatweb/Components/Pages/Chat/ChatCitation.razor index ccb5853cec4..667189beabd 100644 --- a/test/ProjectTemplates/Microsoft.Extensions.AI.Templates.IntegrationTests/Snapshots/aichatweb.Basic.verified/aichatweb/Components/Pages/Chat/ChatCitation.razor +++ b/test/ProjectTemplates/Microsoft.Extensions.AI.Templates.IntegrationTests/Snapshots/aichatweb.Basic.verified/aichatweb/Components/Pages/Chat/ChatCitation.razor @@ -17,10 +17,7 @@ public required string File { get; set; } [Parameter] - public int? PageNumber { get; set; } - - [Parameter] - public required string Quote { get; set; } + public string? Quote { get; set; } private string? viewerUrl; @@ -28,11 +25,15 @@ { viewerUrl = null; - // If you ingest other types of content besides PDF files, construct a URL to an appropriate viewer here - if (File.EndsWith(".pdf")) + // If you ingest other types of content besides Markdown or PDF files, construct a URL to an appropriate viewer here + if (File.EndsWith(".md")) + { + viewerUrl = $"lib/markdown_viewer/viewer.html?file=/Data/{HttpUtility.UrlEncode(File)}#:~:text={Uri.EscapeDataString(Quote ?? "")}"; + } + else if (File.EndsWith(".pdf")) { var search = Quote?.Trim('.', ',', ' ', '\n', '\r', '\t', '"', '\''); - viewerUrl = $"lib/pdf_viewer/viewer.html?file=/Data/{HttpUtility.UrlEncode(File)}#page={PageNumber}&search={HttpUtility.UrlEncode(search)}&phrase=true"; + viewerUrl = $"lib/pdf_viewer/viewer.html?file=/Data/{HttpUtility.UrlEncode(File)}#search={HttpUtility.UrlEncode(search)}&phrase=true"; } } } diff --git a/test/ProjectTemplates/Microsoft.Extensions.AI.Templates.IntegrationTests/Snapshots/aichatweb.Basic.verified/aichatweb/Components/Pages/Chat/ChatMessageItem.razor b/test/ProjectTemplates/Microsoft.Extensions.AI.Templates.IntegrationTests/Snapshots/aichatweb.Basic.verified/aichatweb/Components/Pages/Chat/ChatMessageItem.razor index 92c20c70667..e45d92ab5f9 100644 --- a/test/ProjectTemplates/Microsoft.Extensions.AI.Templates.IntegrationTests/Snapshots/aichatweb.Basic.verified/aichatweb/Components/Pages/Chat/ChatMessageItem.razor +++ b/test/ProjectTemplates/Microsoft.Extensions.AI.Templates.IntegrationTests/Snapshots/aichatweb.Basic.verified/aichatweb/Components/Pages/Chat/ChatMessageItem.razor @@ -28,11 +28,24 @@ else if (Message.Role == ChatRole.Assistant) @foreach (var citation in citations ?? []) { - + }
} + else if (content is FunctionCallContent { Name: "LoadDocuments" }) + { +
+
+ + + +
+
+ Loading relevant documents (this will take a minute)... +
+
+ } else if (content is FunctionCallContent { Name: "Search" } fcc && fcc.Arguments?.TryGetValue("searchPhrase", out var searchPhrase) is true) {
@@ -56,9 +69,9 @@ else if (Message.Role == ChatRole.Assistant) @code { private static readonly ConditionalWeakTable SubscribersLookup = new(); - private static readonly Regex CitationRegex = new(@"(?.*?)", RegexOptions.NonBacktracking); + private static readonly Regex CitationRegex = new(@"(?.*?)", RegexOptions.NonBacktracking); - private List<(string File, int? Page, string Quote)>? citations; + private List<(string File, string Quote)>? citations; [Parameter, EditorRequired] public required ChatMessage Message { get; set; } @@ -88,7 +101,7 @@ else if (Message.Role == ChatRole.Assistant) { var matches = CitationRegex.Matches(text); citations = matches.Any() - ? matches.Select(m => (m.Groups["file"].Value, int.TryParse(m.Groups["page"].Value, out var page) ? page : (int?)null, m.Groups["quote"].Value)).ToList() + ? matches.Select(m => (m.Groups["file"].Value, m.Groups["quote"].Value)).ToList() : null; } } diff --git a/test/ProjectTemplates/Microsoft.Extensions.AI.Templates.IntegrationTests/Snapshots/aichatweb.Basic.verified/aichatweb/Program.cs b/test/ProjectTemplates/Microsoft.Extensions.AI.Templates.IntegrationTests/Snapshots/aichatweb.Basic.verified/aichatweb/Program.cs index 1ff3845eb08..27e50372647 100644 --- a/test/ProjectTemplates/Microsoft.Extensions.AI.Templates.IntegrationTests/Snapshots/aichatweb.Basic.verified/aichatweb/Program.cs +++ b/test/ProjectTemplates/Microsoft.Extensions.AI.Templates.IntegrationTests/Snapshots/aichatweb.Basic.verified/aichatweb/Program.cs @@ -24,11 +24,12 @@ var vectorStorePath = Path.Combine(AppContext.BaseDirectory, "vector-store.db"); var vectorStoreConnectionString = $"Data Source={vectorStorePath}"; -builder.Services.AddSqliteCollection("data-aichatweb-chunks", vectorStoreConnectionString); -builder.Services.AddSqliteCollection("data-aichatweb-documents", vectorStoreConnectionString); +builder.Services.AddSqliteVectorStore(_ => vectorStoreConnectionString); +builder.Services.AddSqliteCollection(IngestedChunk.CollectionName, vectorStoreConnectionString); -builder.Services.AddScoped(); +builder.Services.AddSingleton(); builder.Services.AddSingleton(); +builder.Services.AddKeyedSingleton("ingestion_directory", new DirectoryInfo(Path.Combine(builder.Environment.WebRootPath, "Data"))); builder.Services.AddChatClient(chatClient).UseFunctionInvocation().UseLogging(); builder.Services.AddEmbeddingGenerator(embeddingGenerator); @@ -49,12 +50,4 @@ app.MapRazorComponents() .AddInteractiveServerRenderMode(); -// By default, we ingest PDF files from the /wwwroot/Data directory. You can ingest from -// other sources by implementing IIngestionSource. -// Important: ensure that any content you ingest is trusted, as it may be reflected back -// to users or could be a source of prompt injection risk. -await DataIngestor.IngestDataAsync( - app.Services, - new PDFDirectorySource(Path.Combine(builder.Environment.WebRootPath, "Data"))); - app.Run(); diff --git a/test/ProjectTemplates/Microsoft.Extensions.AI.Templates.IntegrationTests/Snapshots/aichatweb.Basic.verified/aichatweb/Services/IngestedChunk.cs b/test/ProjectTemplates/Microsoft.Extensions.AI.Templates.IntegrationTests/Snapshots/aichatweb.Basic.verified/aichatweb/Services/IngestedChunk.cs index 2c5a38c7912..68af3ef20fb 100644 --- a/test/ProjectTemplates/Microsoft.Extensions.AI.Templates.IntegrationTests/Snapshots/aichatweb.Basic.verified/aichatweb/Services/IngestedChunk.cs +++ b/test/ProjectTemplates/Microsoft.Extensions.AI.Templates.IntegrationTests/Snapshots/aichatweb.Basic.verified/aichatweb/Services/IngestedChunk.cs @@ -1,24 +1,31 @@ -using Microsoft.Extensions.VectorData; +using System.Text.Json.Serialization; +using Microsoft.Extensions.VectorData; namespace aichatweb.Services; public class IngestedChunk { - private const int VectorDimensions = 1536; // 1536 is the default vector size for the OpenAI text-embedding-3-small model - private const string VectorDistanceFunction = DistanceFunction.CosineDistance; + public const int VectorDimensions = 1536; // 1536 is the default vector size for the OpenAI text-embedding-3-small model + public const string VectorDistanceFunction = DistanceFunction.CosineDistance; + public const string CollectionName = "data-aichatweb-chunks"; - [VectorStoreKey] - public required string Key { get; set; } + [VectorStoreKey(StorageName = "key")] + [JsonPropertyName("key")] + public required Guid Key { get; set; } - [VectorStoreData(IsIndexed = true)] + [VectorStoreData(StorageName = "documentid")] + [JsonPropertyName("documentid")] public required string DocumentId { get; set; } - [VectorStoreData] - public int PageNumber { get; set; } - - [VectorStoreData] + [VectorStoreData(StorageName = "content")] + [JsonPropertyName("content")] public required string Text { get; set; } - [VectorStoreVector(VectorDimensions, DistanceFunction = VectorDistanceFunction)] + [VectorStoreData(StorageName = "context")] + [JsonPropertyName("context")] + public string? Context { get; set; } + + [VectorStoreVector(VectorDimensions, DistanceFunction = VectorDistanceFunction, StorageName = "embedding")] + [JsonPropertyName("embedding")] public string? Vector => Text; } diff --git a/test/ProjectTemplates/Microsoft.Extensions.AI.Templates.IntegrationTests/Snapshots/aichatweb.Basic.verified/aichatweb/Services/IngestedDocument.cs b/test/ProjectTemplates/Microsoft.Extensions.AI.Templates.IntegrationTests/Snapshots/aichatweb.Basic.verified/aichatweb/Services/IngestedDocument.cs deleted file mode 100644 index f101cfdc96a..00000000000 --- a/test/ProjectTemplates/Microsoft.Extensions.AI.Templates.IntegrationTests/Snapshots/aichatweb.Basic.verified/aichatweb/Services/IngestedDocument.cs +++ /dev/null @@ -1,25 +0,0 @@ -using Microsoft.Extensions.VectorData; - -namespace aichatweb.Services; - -public class IngestedDocument -{ - private const int VectorDimensions = 2; - private const string VectorDistanceFunction = DistanceFunction.CosineDistance; - - [VectorStoreKey] - public required string Key { get; set; } - - [VectorStoreData(IsIndexed = true)] - public required string SourceId { get; set; } - - [VectorStoreData] - public required string DocumentId { get; set; } - - [VectorStoreData] - public required string DocumentVersion { get; set; } - - // The vector is not used but required for some vector databases - [VectorStoreVector(VectorDimensions, DistanceFunction = VectorDistanceFunction)] - public ReadOnlyMemory Vector { get; set; } = new ReadOnlyMemory([0, 0]); -} diff --git a/test/ProjectTemplates/Microsoft.Extensions.AI.Templates.IntegrationTests/Snapshots/aichatweb.Basic.verified/aichatweb/Services/Ingestion/DataIngestor.cs b/test/ProjectTemplates/Microsoft.Extensions.AI.Templates.IntegrationTests/Snapshots/aichatweb.Basic.verified/aichatweb/Services/Ingestion/DataIngestor.cs index 89fe287ebed..d97b986b694 100644 --- a/test/ProjectTemplates/Microsoft.Extensions.AI.Templates.IntegrationTests/Snapshots/aichatweb.Basic.verified/aichatweb/Services/Ingestion/DataIngestor.cs +++ b/test/ProjectTemplates/Microsoft.Extensions.AI.Templates.IntegrationTests/Snapshots/aichatweb.Basic.verified/aichatweb/Services/Ingestion/DataIngestor.cs @@ -1,58 +1,35 @@ using Microsoft.Extensions.AI; +using Microsoft.Extensions.DataIngestion; +using Microsoft.Extensions.DataIngestion.Chunkers; using Microsoft.Extensions.VectorData; +using Microsoft.ML.Tokenizers; namespace aichatweb.Services.Ingestion; public class DataIngestor( ILogger logger, - VectorStoreCollection chunksCollection, - VectorStoreCollection documentsCollection) + ILoggerFactory loggerFactory, + VectorStore vectorStore, + IEmbeddingGenerator> embeddingGenerator) { - public static async Task IngestDataAsync(IServiceProvider services, IIngestionSource source) + public async Task IngestDataAsync(DirectoryInfo directory, string searchPattern) { - using var scope = services.CreateScope(); - var ingestor = scope.ServiceProvider.GetRequiredService(); - await ingestor.IngestDataAsync(source); - } - - public async Task IngestDataAsync(IIngestionSource source) - { - await chunksCollection.EnsureCollectionExistsAsync(); - await documentsCollection.EnsureCollectionExistsAsync(); - - var sourceId = source.SourceId; - var documentsForSource = await documentsCollection.GetAsync(doc => doc.SourceId == sourceId, top: int.MaxValue).ToListAsync(); - - var deletedDocuments = await source.GetDeletedDocumentsAsync(documentsForSource); - foreach (var deletedDocument in deletedDocuments) + using var writer = new VectorStoreWriter(vectorStore, dimensionCount: IngestedChunk.VectorDimensions, new() { - logger.LogInformation("Removing ingested data for {DocumentId}", deletedDocument.DocumentId); - await DeleteChunksForDocumentAsync(deletedDocument); - await documentsCollection.DeleteAsync(deletedDocument.Key); - } - - var modifiedDocuments = await source.GetNewOrModifiedDocumentsAsync(documentsForSource); - foreach (var modifiedDocument in modifiedDocuments) - { - logger.LogInformation("Processing {DocumentId}", modifiedDocument.DocumentId); - await DeleteChunksForDocumentAsync(modifiedDocument); - - await documentsCollection.UpsertAsync(modifiedDocument); - - var newRecords = await source.CreateChunksForDocumentAsync(modifiedDocument); - await chunksCollection.UpsertAsync(newRecords); - } - - logger.LogInformation("Ingestion is up-to-date"); - - async Task DeleteChunksForDocumentAsync(IngestedDocument document) + CollectionName = IngestedChunk.CollectionName, + DistanceFunction = IngestedChunk.VectorDistanceFunction, + IncrementalIngestion = false, + }); + + using var pipeline = new IngestionPipeline( + reader: new DocumentReader(directory), + chunker: new SemanticSimilarityChunker(embeddingGenerator, new(TiktokenTokenizer.CreateForModel("gpt-4o"))), + writer: writer, + loggerFactory: loggerFactory); + + await foreach (var result in pipeline.ProcessAsync(directory, searchPattern)) { - var documentId = document.DocumentId; - var chunksToDelete = await chunksCollection.GetAsync(record => record.DocumentId == documentId, int.MaxValue).ToListAsync(); - if (chunksToDelete.Count != 0) - { - await chunksCollection.DeleteAsync(chunksToDelete.Select(r => r.Key)); - } + logger.LogInformation("Completed processing '{id}'. Succeeded: '{succeeded}'.", result.DocumentId, result.Succeeded); } } } diff --git a/test/ProjectTemplates/Microsoft.Extensions.AI.Templates.IntegrationTests/Snapshots/aichatweb.Basic.verified/aichatweb/Services/Ingestion/DocumentReader.cs b/test/ProjectTemplates/Microsoft.Extensions.AI.Templates.IntegrationTests/Snapshots/aichatweb.Basic.verified/aichatweb/Services/Ingestion/DocumentReader.cs new file mode 100644 index 00000000000..315a6ad3d53 --- /dev/null +++ b/test/ProjectTemplates/Microsoft.Extensions.AI.Templates.IntegrationTests/Snapshots/aichatweb.Basic.verified/aichatweb/Services/Ingestion/DocumentReader.cs @@ -0,0 +1,36 @@ +using Microsoft.Extensions.DataIngestion; + +namespace aichatweb.Services.Ingestion; + +internal sealed class DocumentReader(DirectoryInfo rootDirectory) : IngestionDocumentReader +{ + private readonly MarkdownReader _markdownReader = new(); + private readonly PdfPigReader _pdfReader = new(); + + public override Task ReadAsync(FileInfo source, string identifier, string? mediaType = null, CancellationToken cancellationToken = default) + { + if (Path.IsPathFullyQualified(identifier)) + { + // Normalize the identifier to its relative path + identifier = Path.GetRelativePath(rootDirectory.FullName, identifier); + } + + mediaType = GetCustomMediaType(source) ?? mediaType; + return base.ReadAsync(source, identifier, mediaType, cancellationToken); + } + + public override Task ReadAsync(Stream source, string identifier, string mediaType, CancellationToken cancellationToken = default) + => mediaType switch + { + "application/pdf" => _pdfReader.ReadAsync(source, identifier, mediaType, cancellationToken), + "text/markdown" => _markdownReader.ReadAsync(source, identifier, mediaType, cancellationToken), + _ => throw new InvalidOperationException($"Unsupported media type '{mediaType}'"), + }; + + private static string? GetCustomMediaType(FileInfo source) + => source.Extension switch + { + ".md" => "text/markdown", + _ => null + }; +} diff --git a/test/ProjectTemplates/Microsoft.Extensions.AI.Templates.IntegrationTests/Snapshots/aichatweb.Basic.verified/aichatweb/Services/Ingestion/IIngestionSource.cs b/test/ProjectTemplates/Microsoft.Extensions.AI.Templates.IntegrationTests/Snapshots/aichatweb.Basic.verified/aichatweb/Services/Ingestion/IIngestionSource.cs deleted file mode 100644 index 540cac117e7..00000000000 --- a/test/ProjectTemplates/Microsoft.Extensions.AI.Templates.IntegrationTests/Snapshots/aichatweb.Basic.verified/aichatweb/Services/Ingestion/IIngestionSource.cs +++ /dev/null @@ -1,12 +0,0 @@ -namespace aichatweb.Services.Ingestion; - -public interface IIngestionSource -{ - string SourceId { get; } - - Task> GetNewOrModifiedDocumentsAsync(IReadOnlyList existingDocuments); - - Task> GetDeletedDocumentsAsync(IReadOnlyList existingDocuments); - - Task> CreateChunksForDocumentAsync(IngestedDocument document); -} diff --git a/test/ProjectTemplates/Microsoft.Extensions.AI.Templates.IntegrationTests/Snapshots/aichatweb.Basic.verified/aichatweb/Services/Ingestion/PDFDirectorySource.cs b/test/ProjectTemplates/Microsoft.Extensions.AI.Templates.IntegrationTests/Snapshots/aichatweb.Basic.verified/aichatweb/Services/Ingestion/PDFDirectorySource.cs deleted file mode 100644 index 0be02a9d008..00000000000 --- a/test/ProjectTemplates/Microsoft.Extensions.AI.Templates.IntegrationTests/Snapshots/aichatweb.Basic.verified/aichatweb/Services/Ingestion/PDFDirectorySource.cs +++ /dev/null @@ -1,71 +0,0 @@ -using Microsoft.SemanticKernel.Text; -using UglyToad.PdfPig; -using UglyToad.PdfPig.Content; -using UglyToad.PdfPig.DocumentLayoutAnalysis.PageSegmenter; -using UglyToad.PdfPig.DocumentLayoutAnalysis.WordExtractor; - -namespace aichatweb.Services.Ingestion; - -public class PDFDirectorySource(string sourceDirectory) : IIngestionSource -{ - public static string SourceFileId(string path) => Path.GetFileName(path); - public static string SourceFileVersion(string path) => File.GetLastWriteTimeUtc(path).ToString("o"); - - public string SourceId => $"{nameof(PDFDirectorySource)}:{sourceDirectory}"; - - public Task> GetNewOrModifiedDocumentsAsync(IReadOnlyList existingDocuments) - { - var results = new List(); - var sourceFiles = Directory.GetFiles(sourceDirectory, "*.pdf"); - var existingDocumentsById = existingDocuments.ToDictionary(d => d.DocumentId); - - foreach (var sourceFile in sourceFiles) - { - var sourceFileId = SourceFileId(sourceFile); - var sourceFileVersion = SourceFileVersion(sourceFile); - var existingDocumentVersion = existingDocumentsById.TryGetValue(sourceFileId, out var existingDocument) ? existingDocument.DocumentVersion : null; - if (existingDocumentVersion != sourceFileVersion) - { - results.Add(new() { Key = Guid.CreateVersion7().ToString(), SourceId = SourceId, DocumentId = sourceFileId, DocumentVersion = sourceFileVersion }); - } - } - - return Task.FromResult((IEnumerable)results); - } - - public Task> GetDeletedDocumentsAsync(IReadOnlyList existingDocuments) - { - var currentFiles = Directory.GetFiles(sourceDirectory, "*.pdf"); - var currentFileIds = currentFiles.ToLookup(SourceFileId); - var deletedDocuments = existingDocuments.Where(d => !currentFileIds.Contains(d.DocumentId)); - return Task.FromResult(deletedDocuments); - } - - public Task> CreateChunksForDocumentAsync(IngestedDocument document) - { - using var pdf = PdfDocument.Open(Path.Combine(sourceDirectory, document.DocumentId)); - var paragraphs = pdf.GetPages().SelectMany(GetPageParagraphs).ToList(); - - return Task.FromResult(paragraphs.Select(p => new IngestedChunk - { - Key = Guid.CreateVersion7().ToString(), - DocumentId = document.DocumentId, - PageNumber = p.PageNumber, - Text = p.Text, - })); - } - - private static IEnumerable<(int PageNumber, int IndexOnPage, string Text)> GetPageParagraphs(Page pdfPage) - { - var letters = pdfPage.Letters; - var words = NearestNeighbourWordExtractor.Instance.GetWords(letters); - var textBlocks = DocstrumBoundingBoxes.Instance.GetBlocks(words); - var pageText = string.Join(Environment.NewLine + Environment.NewLine, - textBlocks.Select(t => t.Text.ReplaceLineEndings(" "))); - -#pragma warning disable SKEXP0050 // Type is for evaluation purposes only - return TextChunker.SplitPlainTextParagraphs([pageText], 200) - .Select((text, index) => (pdfPage.Number, index, text)); -#pragma warning restore SKEXP0050 // Type is for evaluation purposes only - } -} diff --git a/test/ProjectTemplates/Microsoft.Extensions.AI.Templates.IntegrationTests/Snapshots/aichatweb.Basic.verified/aichatweb/Services/Ingestion/PdfPigReader.cs b/test/ProjectTemplates/Microsoft.Extensions.AI.Templates.IntegrationTests/Snapshots/aichatweb.Basic.verified/aichatweb/Services/Ingestion/PdfPigReader.cs new file mode 100644 index 00000000000..f6de539eb22 --- /dev/null +++ b/test/ProjectTemplates/Microsoft.Extensions.AI.Templates.IntegrationTests/Snapshots/aichatweb.Basic.verified/aichatweb/Services/Ingestion/PdfPigReader.cs @@ -0,0 +1,42 @@ +using Microsoft.Extensions.DataIngestion; +using UglyToad.PdfPig; +using UglyToad.PdfPig.Content; +using UglyToad.PdfPig.DocumentLayoutAnalysis.PageSegmenter; +using UglyToad.PdfPig.DocumentLayoutAnalysis.WordExtractor; + +namespace aichatweb.Services.Ingestion; + +internal sealed class PdfPigReader : IngestionDocumentReader +{ + public override Task ReadAsync(Stream source, string identifier, string mediaType, CancellationToken cancellationToken = default) + { + using var pdf = PdfDocument.Open(source); + var document = new IngestionDocument(identifier); + foreach (var page in pdf.GetPages()) + { + document.Sections.Add(GetPageSection(page)); + } + return Task.FromResult(document); + } + + private static IngestionDocumentSection GetPageSection(Page pdfPage) + { + var section = new IngestionDocumentSection + { + PageNumber = pdfPage.Number, + }; + + var letters = pdfPage.Letters; + var words = NearestNeighbourWordExtractor.Instance.GetWords(letters); + + foreach (var textBlock in DocstrumBoundingBoxes.Instance.GetBlocks(words)) + { + section.Elements.Add(new IngestionDocumentParagraph(textBlock.Text) + { + Text = textBlock.Text + }); + } + + return section; + } +} diff --git a/test/ProjectTemplates/Microsoft.Extensions.AI.Templates.IntegrationTests/Snapshots/aichatweb.Basic.verified/aichatweb/Services/SemanticSearch.cs b/test/ProjectTemplates/Microsoft.Extensions.AI.Templates.IntegrationTests/Snapshots/aichatweb.Basic.verified/aichatweb/Services/SemanticSearch.cs index 291c6c4b4a9..8072f8bcddb 100644 --- a/test/ProjectTemplates/Microsoft.Extensions.AI.Templates.IntegrationTests/Snapshots/aichatweb.Basic.verified/aichatweb/Services/SemanticSearch.cs +++ b/test/ProjectTemplates/Microsoft.Extensions.AI.Templates.IntegrationTests/Snapshots/aichatweb.Basic.verified/aichatweb/Services/SemanticSearch.cs @@ -1,12 +1,22 @@ -using Microsoft.Extensions.VectorData; +using aichatweb.Services.Ingestion; +using Microsoft.Extensions.VectorData; namespace aichatweb.Services; public class SemanticSearch( - VectorStoreCollection vectorCollection) + VectorStoreCollection vectorCollection, + [FromKeyedServices("ingestion_directory")] DirectoryInfo ingestionDirectory, + DataIngestor dataIngestor) { + private Task? _ingestionTask; + + public async Task LoadDocumentsAsync() => await ( _ingestionTask ??= dataIngestor.IngestDataAsync(ingestionDirectory, searchPattern: "*.*")); + public async Task> SearchAsync(string text, string? documentIdFilter, int maxResults) { + // Ensure documents have been loaded before searching + await LoadDocumentsAsync(); + var nearest = vectorCollection.SearchAsync(text, maxResults, new VectorSearchOptions { Filter = documentIdFilter is { Length: > 0 } ? record => record.DocumentId == documentIdFilter : null, diff --git a/test/ProjectTemplates/Microsoft.Extensions.AI.Templates.IntegrationTests/Snapshots/aichatweb.Basic.verified/aichatweb/aichatweb.csproj b/test/ProjectTemplates/Microsoft.Extensions.AI.Templates.IntegrationTests/Snapshots/aichatweb.Basic.verified/aichatweb/aichatweb.csproj index 1e694a1d6a6..dad2183dcfd 100644 --- a/test/ProjectTemplates/Microsoft.Extensions.AI.Templates.IntegrationTests/Snapshots/aichatweb.Basic.verified/aichatweb/aichatweb.csproj +++ b/test/ProjectTemplates/Microsoft.Extensions.AI.Templates.IntegrationTests/Snapshots/aichatweb.Basic.verified/aichatweb/aichatweb.csproj @@ -1,7 +1,7 @@  - net9.0 + net10.0 enable enable secret @@ -10,10 +10,12 @@ - + + - - + + + diff --git a/test/ProjectTemplates/Microsoft.Extensions.AI.Templates.IntegrationTests/Snapshots/aichatweb.Basic.verified/aichatweb/wwwroot/Data/Example_GPS_Watch.md b/test/ProjectTemplates/Microsoft.Extensions.AI.Templates.IntegrationTests/Snapshots/aichatweb.Basic.verified/aichatweb/wwwroot/Data/Example_GPS_Watch.md new file mode 100644 index 00000000000..f7d042edf83 --- /dev/null +++ b/test/ProjectTemplates/Microsoft.Extensions.AI.Templates.IntegrationTests/Snapshots/aichatweb.Basic.verified/aichatweb/wwwroot/Data/Example_GPS_Watch.md @@ -0,0 +1,193 @@ +# TrailMaster GPS Watch + +## 1. Introduction + +ExpeditionTech is proud to introduce the TrailMaster GPS Watch, a state-of-the-art outdoor electronics device designed for the most demanding outdoor adventurers. This watch is meticulously engineered to provide accurate location information, real-time sharing, and reliable mapping capabilities. The TrailMaster GPS Watch is built to withstand the harshest environmental conditions while providing users with the critical data they need to navigate through challenging terrain and optimize their outdoor experiences. + +### 1.1 Product Overview + +The TrailMaster GPS Watch is a high-performance outdoor electronics device that combines advanced GPS technology with rugged design. It features a durable, shock-resistant casing, a high-contrast display for optimal visibility in bright sunlight, and a built-in rechargeable battery for extended use in remote areas. The TrailMaster GPS Watch is equipped with a comprehensive suite of navigation tools, including topographic maps, trail tracking, and waypoint management. Additionally, it offers real-time location sharing for enhanced safety and group coordination during outdoor activities. + +### 1.2 Intended Use + +The TrailMaster GPS Watch is intended for use by experienced outdoor enthusiasts, including hikers, backpackers, trail runners, and mountaineers. This device is designed to provide essential navigation information and location tracking in remote, off-grid environments. Users can rely on the TrailMaster GPS Watch to plan and execute their outdoor adventures with confidence, knowing they have access to accurate maps, location data, and real-time sharing capabilities. Although the TrailMaster GPS Watch is engineered for extreme durability, users should always exercise caution and take appropriate safety measures when engaging in outdoor activities. + +#### 1.2.1 Safety Precautions + +Before using the TrailMaster GPS Watch, users must ensure that the device is fully charged and properly calibrated according to the manufacturer's specifications. It is essential to familiarize oneself with the watch's features, controls, and navigation functions before venturing into remote outdoor areas. Users should also be aware of potential environmental hazards, such as extreme weather conditions, rugged terrain, and limited access to emergency services. Proper planning, preparation, and adherence to best practices for outdoor safety are critical when using the TrailMaster GPS Watch. + +## 2. Technical Specifications + +### 2.1 Hardware + +#### 2.1.1 Processor and Memory + +The TrailMaster GPS Watch is equipped with a high-performance ARM Cortex processor, ensuring fast and efficient operation for all your outdoor activities. The device also comes with 4GB of internal memory, providing ample storage for maps, routes, and waypoints. The processor operates at 1.2GHz, allowing for quick map rendering and location updates. + +#### 2.1.2 GPS Module + +The GPS module in the TrailMaster GPS Watch utilizes a state-of-the-art multi-constellation receiver, supporting GPS, GLONASS, and Galileo satellite systems. This enables precise location tracking and navigation, even in challenging outdoor environments. The module also features advanced signal processing algorithms, ensuring reliable performance in remote areas with limited satellite visibility. + +#### 2.1.3 Sensors + +Equipped with a comprehensive set of sensors, the TrailMaster GPS Watch offers an array of valuable data for outdoor enthusiasts. The built-in altimeter provides accurate altitude readings, while the barometer monitors changes in air pressure to forecast weather conditions. Additionally, the watch includes a digital compass for reliable orientation, ensuring a seamless navigation experience in the great outdoors. + +### 2.2 Software + +#### 2.2.1 Operating System + +The TrailMaster GPS Watch runs on a proprietary operating system optimized for outdoor navigation and tracking. This custom OS combines robustness and efficiency, allowing for seamless integration with the device's hardware and sensors. The interface is designed for intuitive interaction, enabling users to access maps, location sharing, and other features with ease, even in challenging outdoor conditions. + +#### 2.2.2 Map Data + +The TrailMaster GPS Watch comes preloaded with detailed topographic maps, providing comprehensive coverage of trails, terrain, and points of interest. These maps are stored locally on the device, ensuring rapid access and smooth navigation without relying on cellular or data network connectivity. Users can also import additional map data via the dedicated USB port, expanding the watch's mapping capabilities for customized adventures. + +## 3. Setup and Installation + +### 3.1 Charging + +Before using your TrailMaster GPS Watch for the first time, it is essential to ensure that the device is fully charged. To charge your GPS watch, follow these steps: + +1. Locate the charging port cover on the back of the watch. +2. Gently lift the cover to expose the charging port. +3. Connect the provided USB charging cable to the port, ensuring a secure connection. +4. Plug the other end of the cable into a power source, such as a computer or USB wall adapter. +5. Allow the watch to charge for at least 2 hours, or until the battery indicator on the display shows it is fully charged. + +For optimal performance, it is recommended to fully charge the device before each use and to avoid overcharging. Please refer to the TrailMaster GPS Watch technical specifications for detailed battery charging information. + +### 3.2 Initial Configuration + +Once your TrailMaster GPS Watch is fully charged, you can proceed with the initial configuration by following these steps: + +1. Press and hold the power button located on the side of the watch to turn it on. +2. Follow the on-screen instructions to select your language, set the date and time, and calibrate the GPS. +3. Connect the watch to your smartphone using the TrailMaster companion app to enable real-time location sharing and receive notifications. +4. Customize the watch settings, such as display preferences and map views, to suit your outdoor activities. + +Before using the GPS functionality, it is crucial to ensure that the watch has a clear view of the sky to acquire GPS signals. Please refer to the TrailMaster GPS Watch user guide for detailed instructions on GPS calibration and satellite acquisition. + +## 4. Operation + +### 4.1 Basic Functions + +The TrailMaster GPS Watch is designed for outdoor use and offers a variety of basic functions to assist users in navigating and staying connected during their adventures. + +#### 4.1.1 Powering On and Off + +To power on the TrailMaster GPS Watch, press and hold the power button (located on the right side of the watch) for 3 seconds. The watch will display the ExpeditionTech logo and then proceed to the main navigation screen. To power off the watch, press and hold the power button and select "Power Off" from the menu. + +#### 4.1.2 Accessing Built-in Maps + +The TrailMaster GPS Watch comes pre-loaded with detailed maps of various outdoor locations. To access the maps, press the map button (located on the left side of the watch) to bring up the map interface. From here, you can view your current location, set waypoints, and plan routes. + +#### 4.1.3 Real-time Location Sharing + +Utilize the real-time location sharing feature to transmit your current location to designated contacts. Press the share button (located on the top of the watch) and select the specific contacts you wish to share your location with. This feature requires a stable GPS signal and a connected smartphone with the TrailMaster app installed. + +### 4.2 Advanced Features + +The TrailMaster GPS Watch offers advanced features to enhance the user experience and provide additional functionality for outdoor enthusiasts. + +#### 4.2.1 Rugged Design + +The TrailMaster GPS Watch is built to withstand rugged outdoor conditions, including extreme temperatures, water exposure, and impact. The durable casing and reinforced strap ensure that the watch remains operational in challenging environments. + +#### 4.2.2 Navigation Tools + +In addition to basic map access, the TrailMaster GPS Watch includes advanced navigation tools such as compass, altimeter, and barometer. These tools provide vital information for navigation and weather monitoring while in the field. + +#### 4.2.3 Customizing Data Screens + +Users can customize the data screens on the TrailMaster GPS Watch to display the specific information they require during their outdoor activities. From the main menu, navigate to the settings and select "Data Screens" to adjust the layout and content of the screens. + +#### 4.2.4 Tracking Performance Metrics + +The TrailMaster GPS Watch is equipped with sensors to track performance metrics such as distance traveled, speed, elevation gain, and heart rate. Use the tracking mode to monitor these metrics in real-time or review them after completing an activity. + +## 5. Troubleshooting + +### 5.1 Diagnostic Tools and Equipment + +When troubleshooting the TrailMaster GPS Watch, it is essential to use specialized industrial diagnostic tools and equipment to perform accurate diagnostic tests. These tools and equipment include: + +- **GPS Signal Analyzer**: Use a GPS signal analyzer to check the strength and quality of the satellite signals received by the watch. +- **RF Spectrum Analyzer**: An RF spectrum analyzer is required to analyze the radio frequency spectrum and identify any interference affecting the GPS reception. +- **Ruggedness Test Equipment**: Perform ruggedness tests using shock and vibration equipment to ensure the watch can withstand outdoor adventures without performance issues. + +It is essential to use these specialized tools and equipment to accurately diagnose any issues with the TrailMaster GPS Watch and ensure optimal performance. + +### 5.2 Common Issues + +#### 5.2.1 GPS Signal Loss + +**Symptoms:** + +The watch displays "No GPS Signal" or intermittently loses GPS signal during use. + +**Potential Causes:** + +- Obstruction of satellite signals due to dense foliage, tall buildings, or natural terrain features. +- Radio frequency interference affecting GPS reception. +- Wear and tear on the GPS antenna or receiver. + +**Troubleshooting Steps:** + +1. Check the surroundings for any obstructions blocking satellite signals. +2. Use an RF spectrum analyzer to identify any potential sources of interference. +3. Perform a diagnostics test using a GPS signal analyzer to assess the strength and quality of the GPS signal received by the watch. +4. If the issue persists, contact ExpeditionTech customer support for further assistance. + +#### 5.2.2 Connectivity Issues + +**Symptoms:** + +- Inability to share real-time location or connect to other devices. +- Unreliable Bluetooth connectivity. + +**Potential Causes:** + +- Bluetooth interference from other electronic devices. +- Signal obstruction due to environmental factors. +- Software or firmware issues. + +**Troubleshooting Steps:** + +1. Ensure the watch is within the recommended Bluetooth range of the connected device. +2. Identify and eliminate potential sources of Bluetooth interference in the vicinity. +3. Update the watch's firmware to the latest version to address any software-related connectivity issues. +4. If connectivity problems persist, perform a comprehensive diagnostics test using a specialized Bluetooth signal analyzer. + +By following these troubleshooting steps and using specialized diagnostic tools and equipment, users can effectively identify and address common issues with the TrailMaster GPS Watch. + +## 6. Maintenance and Care + +### 6.1 Cleaning + +It is important to regularly clean your TrailMaster GPS Watch to ensure optimal performance. Use a soft, damp cloth to gently wipe the watch face and straps. Do not use harsh chemicals or solvents, as these may damage the watch's rugged design and built-in maps. + +### 6.2 Battery Maintenance + +The TrailMaster GPS Watch is equipped with a rechargeable lithium-ion battery. To optimize battery life, it is recommended to fully charge the watch before each outdoor adventure. Additionally, it is important to avoid exposing the watch to extreme temperatures, as this may affect battery performance. + +### 6.3 Storage + +When not in use, store your TrailMaster GPS Watch in a cool, dry place. Avoid prolonged exposure to direct sunlight or extreme temperatures, as this may cause damage to the device. + +### 6.4 Software Updates + +To ensure that your TrailMaster GPS Watch operates efficiently, it is important to regularly check for and install software updates. These updates may include improvements to the built-in maps, real-time location sharing, and overall performance of the watch. + +### 6.5 Technical Diagnostics + +For advanced maintenance and care, it is recommended to perform technical diagnostics using specialized industrial and scientific equipment. Refer to formal industry specification codes and standards bodies for detailed instructions on performing these diagnostics. + +## 7. Regulatory Compliance + +### 7.1 FCC Compliance + +The ExpeditionTech TrailMaster GPS Watch complies with Part 15 of the FCC rules. Operation is subject to the following two conditions: (1) this device may not cause harmful interference, and (2) this device must accept any interference received, including interference that may cause undesired operation. Any changes or modifications not expressly approved by the party responsible for compliance could void the user's authority to operate the equipment. The user is cautioned that any changes or modifications made to this device that are not expressly approved by the manufacturer could void the user's authority to operate the equipment. + +### 7.2 CE Marking + +The CE marking on the ExpeditionTech TrailMaster GPS Watch indicates that it complies with the essential requirements of the relevant European health, safety, and environmental protection legislation. The device is in conformity with the essential requirements and other relevant provisions of Directive 1999/5/EC. The CE marking is affixed to the device to demonstrate that it meets the essential requirements for safety, health, and environmental protection. The user should only use the device in accordance with the instructions provided in the user manual. diff --git a/test/ProjectTemplates/Microsoft.Extensions.AI.Templates.IntegrationTests/Snapshots/aichatweb.Basic.verified/aichatweb/wwwroot/Data/Example_GPS_Watch.pdf b/test/ProjectTemplates/Microsoft.Extensions.AI.Templates.IntegrationTests/Snapshots/aichatweb.Basic.verified/aichatweb/wwwroot/Data/Example_GPS_Watch.pdf deleted file mode 100644 index c87df644c58..00000000000 Binary files a/test/ProjectTemplates/Microsoft.Extensions.AI.Templates.IntegrationTests/Snapshots/aichatweb.Basic.verified/aichatweb/wwwroot/Data/Example_GPS_Watch.pdf and /dev/null differ diff --git a/test/ProjectTemplates/Microsoft.Extensions.AI.Templates.IntegrationTests/Snapshots/aichatweb.Basic.verified/aichatweb/wwwroot/lib/markdown_viewer/viewer.html b/test/ProjectTemplates/Microsoft.Extensions.AI.Templates.IntegrationTests/Snapshots/aichatweb.Basic.verified/aichatweb/wwwroot/lib/markdown_viewer/viewer.html new file mode 100644 index 00000000000..94447ffc47e --- /dev/null +++ b/test/ProjectTemplates/Microsoft.Extensions.AI.Templates.IntegrationTests/Snapshots/aichatweb.Basic.verified/aichatweb/wwwroot/lib/markdown_viewer/viewer.html @@ -0,0 +1,32 @@ + + + + + Markdown viewer + + + + +
+ + + diff --git a/test/ProjectTemplates/Microsoft.Extensions.AI.Templates.IntegrationTests/Snapshots/aichatweb.Basic.verified/aichatweb/wwwroot/lib/markdown_viewer/viewer.mjs b/test/ProjectTemplates/Microsoft.Extensions.AI.Templates.IntegrationTests/Snapshots/aichatweb.Basic.verified/aichatweb/wwwroot/lib/markdown_viewer/viewer.mjs new file mode 100644 index 00000000000..78eb819c9a8 --- /dev/null +++ b/test/ProjectTemplates/Microsoft.Extensions.AI.Templates.IntegrationTests/Snapshots/aichatweb.Basic.verified/aichatweb/wwwroot/lib/markdown_viewer/viewer.mjs @@ -0,0 +1,13 @@ +import { parse } from '../marked/dist/marked.esm.js'; +import purify from '../dompurify/dist/purify.es.mjs'; + +const url = new URL(window.location); +const fileUrl = url.searchParams.get('file'); +if (!fileUrl) { + throw new Error('File not specified in the URL query string'); +} + +var response = await fetch(fileUrl); +var text = await response.text(); + +document.getElementById('content').innerHTML = purify.sanitize(parse(text)); diff --git a/test/ProjectTemplates/Microsoft.Extensions.AI.Templates.IntegrationTests/Snapshots/aichatweb.BasicAspire.verified/aichatweb/aichatweb.AppHost/AppHost.cs b/test/ProjectTemplates/Microsoft.Extensions.AI.Templates.IntegrationTests/Snapshots/aichatweb.BasicAspire.verified/aichatweb/aichatweb.AppHost/AppHost.cs index d41eea07e40..bf116a0c47e 100644 --- a/test/ProjectTemplates/Microsoft.Extensions.AI.Templates.IntegrationTests/Snapshots/aichatweb.BasicAspire.verified/aichatweb/aichatweb.AppHost/AppHost.cs +++ b/test/ProjectTemplates/Microsoft.Extensions.AI.Templates.IntegrationTests/Snapshots/aichatweb.BasicAspire.verified/aichatweb/aichatweb.AppHost/AppHost.cs @@ -6,7 +6,13 @@ // dotnet user-secrets set ConnectionStrings:openai "Endpoint=https://models.inference.ai.azure.com;Key=YOUR-API-KEY" var openai = builder.AddConnectionString("openai"); +var markitdown = builder.AddContainer("markitdown", "mcp/markitdown") + .WithArgs("--http", "--host", "0.0.0.0", "--port", "3001") + .WithHttpEndpoint(targetPort: 3001, name: "http"); + var webApp = builder.AddProject("aichatweb-app"); webApp.WithReference(openai); +webApp + .WithEnvironment("MARKITDOWN_MCP_URL", markitdown.GetEndpoint("http")); builder.Build().Run(); diff --git a/test/ProjectTemplates/Microsoft.Extensions.AI.Templates.IntegrationTests/Snapshots/aichatweb.BasicAspire.verified/aichatweb/aichatweb.AppHost/aichatweb.AppHost.csproj b/test/ProjectTemplates/Microsoft.Extensions.AI.Templates.IntegrationTests/Snapshots/aichatweb.BasicAspire.verified/aichatweb/aichatweb.AppHost/aichatweb.AppHost.csproj index fa6140a8751..436f2241582 100644 --- a/test/ProjectTemplates/Microsoft.Extensions.AI.Templates.IntegrationTests/Snapshots/aichatweb.BasicAspire.verified/aichatweb/aichatweb.AppHost/aichatweb.AppHost.csproj +++ b/test/ProjectTemplates/Microsoft.Extensions.AI.Templates.IntegrationTests/Snapshots/aichatweb.BasicAspire.verified/aichatweb/aichatweb.AppHost/aichatweb.AppHost.csproj @@ -4,7 +4,7 @@ Exe - net9.0 + net10.0 enable enable secret diff --git a/test/ProjectTemplates/Microsoft.Extensions.AI.Templates.IntegrationTests/Snapshots/aichatweb.BasicAspire.verified/aichatweb/aichatweb.ServiceDefaults/Extensions.cs b/test/ProjectTemplates/Microsoft.Extensions.AI.Templates.IntegrationTests/Snapshots/aichatweb.BasicAspire.verified/aichatweb/aichatweb.ServiceDefaults/Extensions.cs index b44d60b604b..8d0b0cd5d67 100644 --- a/test/ProjectTemplates/Microsoft.Extensions.AI.Templates.IntegrationTests/Snapshots/aichatweb.BasicAspire.verified/aichatweb/aichatweb.ServiceDefaults/Extensions.cs +++ b/test/ProjectTemplates/Microsoft.Extensions.AI.Templates.IntegrationTests/Snapshots/aichatweb.BasicAspire.verified/aichatweb/aichatweb.ServiceDefaults/Extensions.cs @@ -76,7 +76,8 @@ public static TBuilder ConfigureOpenTelemetry(this TBuilder builder) w // Uncomment the following line to enable gRPC instrumentation (requires the OpenTelemetry.Instrumentation.GrpcNetClient package) //.AddGrpcClientInstrumentation() .AddHttpClientInstrumentation() - .AddSource("Experimental.Microsoft.Extensions.AI"); + .AddSource("Experimental.Microsoft.Extensions.AI") + .AddSource("Experimental.Microsoft.Extensions.DataIngestion"); }); builder.AddOpenTelemetryExporters(); diff --git a/test/ProjectTemplates/Microsoft.Extensions.AI.Templates.IntegrationTests/Snapshots/aichatweb.BasicAspire.verified/aichatweb/aichatweb.ServiceDefaults/aichatweb.ServiceDefaults.csproj b/test/ProjectTemplates/Microsoft.Extensions.AI.Templates.IntegrationTests/Snapshots/aichatweb.BasicAspire.verified/aichatweb/aichatweb.ServiceDefaults/aichatweb.ServiceDefaults.csproj index 474dd445fae..a70a3ca8cd4 100644 --- a/test/ProjectTemplates/Microsoft.Extensions.AI.Templates.IntegrationTests/Snapshots/aichatweb.BasicAspire.verified/aichatweb/aichatweb.ServiceDefaults/aichatweb.ServiceDefaults.csproj +++ b/test/ProjectTemplates/Microsoft.Extensions.AI.Templates.IntegrationTests/Snapshots/aichatweb.BasicAspire.verified/aichatweb/aichatweb.ServiceDefaults/aichatweb.ServiceDefaults.csproj @@ -1,7 +1,7 @@  - net9.0 + net10.0 enable enable true diff --git a/test/ProjectTemplates/Microsoft.Extensions.AI.Templates.IntegrationTests/Snapshots/aichatweb.BasicAspire.verified/aichatweb/aichatweb.Web/Components/Pages/Chat/Chat.razor b/test/ProjectTemplates/Microsoft.Extensions.AI.Templates.IntegrationTests/Snapshots/aichatweb.BasicAspire.verified/aichatweb/aichatweb.Web/Components/Pages/Chat/Chat.razor index 8aa0ec9fd28..6fc5881c18f 100644 --- a/test/ProjectTemplates/Microsoft.Extensions.AI.Templates.IntegrationTests/Snapshots/aichatweb.BasicAspire.verified/aichatweb/aichatweb.Web/Components/Pages/Chat/Chat.razor +++ b/test/ProjectTemplates/Microsoft.Extensions.AI.Templates.IntegrationTests/Snapshots/aichatweb.BasicAspire.verified/aichatweb/aichatweb.Web/Components/Pages/Chat/Chat.razor @@ -13,7 +13,7 @@
To get started, try asking about these example documents. You can replace these with your own data and replace this message.
- + @@ -29,10 +29,12 @@ Do not answer questions about anything else. Use only simple markdown to format your responses. - Use the search tool to find relevant information. When you do this, end your + Use the LoadDocuments tool to prepare for searches before answering any questions. + + Use the Search tool to find relevant information. When you do this, end your reply with citations in the special XML format: - exact quote here + exact quote here Always include the citation in your response if there are results. @@ -52,7 +54,10 @@ { statefulMessageCount = 0; messages.Add(new(ChatRole.System, SystemPrompt)); - chatOptions.Tools = [AIFunctionFactory.Create(SearchAsync)]; + chatOptions.Tools = [ + AIFunctionFactory.Create(LoadDocumentsAsync), + AIFunctionFactory.Create(SearchAsync) + ]; } private async Task AddUserMessageAsync(ChatMessage userMessage) @@ -106,7 +111,14 @@ await chatInput!.FocusAsync(); } - [Description("Searches for information using a phrase or keyword")] + [Description("Loads the documents needed for performing searches. Must be completed before a search can be executed, but only needs to be completed once.")] + private async Task LoadDocumentsAsync() + { + await InvokeAsync(StateHasChanged); + await Search.LoadDocumentsAsync(); + } + + [Description("Searches for information using a phrase or keyword. Relies on documents already being loaded.")] private async Task> SearchAsync( [Description("The phrase to search for.")] string searchPhrase, [Description("If possible, specify the filename to search that file only. If not provided or empty, the search includes all files.")] string? filenameFilter = null) @@ -114,7 +126,7 @@ await InvokeAsync(StateHasChanged); var results = await Search.SearchAsync(searchPhrase, filenameFilter, maxResults: 5); return results.Select(result => - $"{result.Text}"); + $"{result.Text}"); } public void Dispose() diff --git a/test/ProjectTemplates/Microsoft.Extensions.AI.Templates.IntegrationTests/Snapshots/aichatweb.BasicAspire.verified/aichatweb/aichatweb.Web/Components/Pages/Chat/ChatCitation.razor b/test/ProjectTemplates/Microsoft.Extensions.AI.Templates.IntegrationTests/Snapshots/aichatweb.BasicAspire.verified/aichatweb/aichatweb.Web/Components/Pages/Chat/ChatCitation.razor index ccb5853cec4..667189beabd 100644 --- a/test/ProjectTemplates/Microsoft.Extensions.AI.Templates.IntegrationTests/Snapshots/aichatweb.BasicAspire.verified/aichatweb/aichatweb.Web/Components/Pages/Chat/ChatCitation.razor +++ b/test/ProjectTemplates/Microsoft.Extensions.AI.Templates.IntegrationTests/Snapshots/aichatweb.BasicAspire.verified/aichatweb/aichatweb.Web/Components/Pages/Chat/ChatCitation.razor @@ -17,10 +17,7 @@ public required string File { get; set; } [Parameter] - public int? PageNumber { get; set; } - - [Parameter] - public required string Quote { get; set; } + public string? Quote { get; set; } private string? viewerUrl; @@ -28,11 +25,15 @@ { viewerUrl = null; - // If you ingest other types of content besides PDF files, construct a URL to an appropriate viewer here - if (File.EndsWith(".pdf")) + // If you ingest other types of content besides Markdown or PDF files, construct a URL to an appropriate viewer here + if (File.EndsWith(".md")) + { + viewerUrl = $"lib/markdown_viewer/viewer.html?file=/Data/{HttpUtility.UrlEncode(File)}#:~:text={Uri.EscapeDataString(Quote ?? "")}"; + } + else if (File.EndsWith(".pdf")) { var search = Quote?.Trim('.', ',', ' ', '\n', '\r', '\t', '"', '\''); - viewerUrl = $"lib/pdf_viewer/viewer.html?file=/Data/{HttpUtility.UrlEncode(File)}#page={PageNumber}&search={HttpUtility.UrlEncode(search)}&phrase=true"; + viewerUrl = $"lib/pdf_viewer/viewer.html?file=/Data/{HttpUtility.UrlEncode(File)}#search={HttpUtility.UrlEncode(search)}&phrase=true"; } } } diff --git a/test/ProjectTemplates/Microsoft.Extensions.AI.Templates.IntegrationTests/Snapshots/aichatweb.BasicAspire.verified/aichatweb/aichatweb.Web/Components/Pages/Chat/ChatMessageItem.razor b/test/ProjectTemplates/Microsoft.Extensions.AI.Templates.IntegrationTests/Snapshots/aichatweb.BasicAspire.verified/aichatweb/aichatweb.Web/Components/Pages/Chat/ChatMessageItem.razor index 92c20c70667..e45d92ab5f9 100644 --- a/test/ProjectTemplates/Microsoft.Extensions.AI.Templates.IntegrationTests/Snapshots/aichatweb.BasicAspire.verified/aichatweb/aichatweb.Web/Components/Pages/Chat/ChatMessageItem.razor +++ b/test/ProjectTemplates/Microsoft.Extensions.AI.Templates.IntegrationTests/Snapshots/aichatweb.BasicAspire.verified/aichatweb/aichatweb.Web/Components/Pages/Chat/ChatMessageItem.razor @@ -28,11 +28,24 @@ else if (Message.Role == ChatRole.Assistant) @foreach (var citation in citations ?? []) { - + }
} + else if (content is FunctionCallContent { Name: "LoadDocuments" }) + { +
+
+ + + +
+
+ Loading relevant documents (this will take a minute)... +
+
+ } else if (content is FunctionCallContent { Name: "Search" } fcc && fcc.Arguments?.TryGetValue("searchPhrase", out var searchPhrase) is true) {
@@ -56,9 +69,9 @@ else if (Message.Role == ChatRole.Assistant) @code { private static readonly ConditionalWeakTable SubscribersLookup = new(); - private static readonly Regex CitationRegex = new(@"(?.*?)", RegexOptions.NonBacktracking); + private static readonly Regex CitationRegex = new(@"(?.*?)", RegexOptions.NonBacktracking); - private List<(string File, int? Page, string Quote)>? citations; + private List<(string File, string Quote)>? citations; [Parameter, EditorRequired] public required ChatMessage Message { get; set; } @@ -88,7 +101,7 @@ else if (Message.Role == ChatRole.Assistant) { var matches = CitationRegex.Matches(text); citations = matches.Any() - ? matches.Select(m => (m.Groups["file"].Value, int.TryParse(m.Groups["page"].Value, out var page) ? page : (int?)null, m.Groups["quote"].Value)).ToList() + ? matches.Select(m => (m.Groups["file"].Value, m.Groups["quote"].Value)).ToList() : null; } } diff --git a/test/ProjectTemplates/Microsoft.Extensions.AI.Templates.IntegrationTests/Snapshots/aichatweb.BasicAspire.verified/aichatweb/aichatweb.Web/Program.cs b/test/ProjectTemplates/Microsoft.Extensions.AI.Templates.IntegrationTests/Snapshots/aichatweb.BasicAspire.verified/aichatweb/aichatweb.Web/Program.cs index 6d23308d93a..e47bad71cc8 100644 --- a/test/ProjectTemplates/Microsoft.Extensions.AI.Templates.IntegrationTests/Snapshots/aichatweb.BasicAspire.verified/aichatweb/aichatweb.Web/Program.cs +++ b/test/ProjectTemplates/Microsoft.Extensions.AI.Templates.IntegrationTests/Snapshots/aichatweb.BasicAspire.verified/aichatweb/aichatweb.Web/Program.cs @@ -17,10 +17,11 @@ var vectorStorePath = Path.Combine(AppContext.BaseDirectory, "vector-store.db"); var vectorStoreConnectionString = $"Data Source={vectorStorePath}"; -builder.Services.AddSqliteCollection("data-aichatweb-chunks", vectorStoreConnectionString); -builder.Services.AddSqliteCollection("data-aichatweb-documents", vectorStoreConnectionString); -builder.Services.AddScoped(); +builder.Services.AddSqliteVectorStore(_ => vectorStoreConnectionString); +builder.Services.AddSqliteCollection(IngestedChunk.CollectionName, vectorStoreConnectionString); +builder.Services.AddSingleton(); builder.Services.AddSingleton(); +builder.Services.AddKeyedSingleton("ingestion_directory", new DirectoryInfo(Path.Combine(builder.Environment.WebRootPath, "Data"))); var app = builder.Build(); @@ -41,12 +42,4 @@ app.MapRazorComponents() .AddInteractiveServerRenderMode(); -// By default, we ingest PDF files from the /wwwroot/Data directory. You can ingest from -// other sources by implementing IIngestionSource. -// Important: ensure that any content you ingest is trusted, as it may be reflected back -// to users or could be a source of prompt injection risk. -await DataIngestor.IngestDataAsync( - app.Services, - new PDFDirectorySource(Path.Combine(builder.Environment.WebRootPath, "Data"))); - app.Run(); diff --git a/test/ProjectTemplates/Microsoft.Extensions.AI.Templates.IntegrationTests/Snapshots/aichatweb.BasicAspire.verified/aichatweb/aichatweb.Web/Services/IngestedChunk.cs b/test/ProjectTemplates/Microsoft.Extensions.AI.Templates.IntegrationTests/Snapshots/aichatweb.BasicAspire.verified/aichatweb/aichatweb.Web/Services/IngestedChunk.cs index 92e50e61414..af609ea239e 100644 --- a/test/ProjectTemplates/Microsoft.Extensions.AI.Templates.IntegrationTests/Snapshots/aichatweb.BasicAspire.verified/aichatweb/aichatweb.Web/Services/IngestedChunk.cs +++ b/test/ProjectTemplates/Microsoft.Extensions.AI.Templates.IntegrationTests/Snapshots/aichatweb.BasicAspire.verified/aichatweb/aichatweb.Web/Services/IngestedChunk.cs @@ -1,24 +1,31 @@ -using Microsoft.Extensions.VectorData; +using System.Text.Json.Serialization; +using Microsoft.Extensions.VectorData; namespace aichatweb.Web.Services; public class IngestedChunk { - private const int VectorDimensions = 1536; // 1536 is the default vector size for the OpenAI text-embedding-3-small model - private const string VectorDistanceFunction = DistanceFunction.CosineDistance; + public const int VectorDimensions = 1536; // 1536 is the default vector size for the OpenAI text-embedding-3-small model + public const string VectorDistanceFunction = DistanceFunction.CosineDistance; + public const string CollectionName = "data-aichatweb-chunks"; - [VectorStoreKey] - public required string Key { get; set; } + [VectorStoreKey(StorageName = "key")] + [JsonPropertyName("key")] + public required Guid Key { get; set; } - [VectorStoreData(IsIndexed = true)] + [VectorStoreData(StorageName = "documentid")] + [JsonPropertyName("documentid")] public required string DocumentId { get; set; } - [VectorStoreData] - public int PageNumber { get; set; } - - [VectorStoreData] + [VectorStoreData(StorageName = "content")] + [JsonPropertyName("content")] public required string Text { get; set; } - [VectorStoreVector(VectorDimensions, DistanceFunction = VectorDistanceFunction)] + [VectorStoreData(StorageName = "context")] + [JsonPropertyName("context")] + public string? Context { get; set; } + + [VectorStoreVector(VectorDimensions, DistanceFunction = VectorDistanceFunction, StorageName = "embedding")] + [JsonPropertyName("embedding")] public string? Vector => Text; } diff --git a/test/ProjectTemplates/Microsoft.Extensions.AI.Templates.IntegrationTests/Snapshots/aichatweb.BasicAspire.verified/aichatweb/aichatweb.Web/Services/IngestedDocument.cs b/test/ProjectTemplates/Microsoft.Extensions.AI.Templates.IntegrationTests/Snapshots/aichatweb.BasicAspire.verified/aichatweb/aichatweb.Web/Services/IngestedDocument.cs deleted file mode 100644 index 49a8143005e..00000000000 --- a/test/ProjectTemplates/Microsoft.Extensions.AI.Templates.IntegrationTests/Snapshots/aichatweb.BasicAspire.verified/aichatweb/aichatweb.Web/Services/IngestedDocument.cs +++ /dev/null @@ -1,25 +0,0 @@ -using Microsoft.Extensions.VectorData; - -namespace aichatweb.Web.Services; - -public class IngestedDocument -{ - private const int VectorDimensions = 2; - private const string VectorDistanceFunction = DistanceFunction.CosineDistance; - - [VectorStoreKey] - public required string Key { get; set; } - - [VectorStoreData(IsIndexed = true)] - public required string SourceId { get; set; } - - [VectorStoreData] - public required string DocumentId { get; set; } - - [VectorStoreData] - public required string DocumentVersion { get; set; } - - // The vector is not used but required for some vector databases - [VectorStoreVector(VectorDimensions, DistanceFunction = VectorDistanceFunction)] - public ReadOnlyMemory Vector { get; set; } = new ReadOnlyMemory([0, 0]); -} diff --git a/test/ProjectTemplates/Microsoft.Extensions.AI.Templates.IntegrationTests/Snapshots/aichatweb.BasicAspire.verified/aichatweb/aichatweb.Web/Services/Ingestion/DataIngestor.cs b/test/ProjectTemplates/Microsoft.Extensions.AI.Templates.IntegrationTests/Snapshots/aichatweb.BasicAspire.verified/aichatweb/aichatweb.Web/Services/Ingestion/DataIngestor.cs index 2fe43370071..9dd366a03a5 100644 --- a/test/ProjectTemplates/Microsoft.Extensions.AI.Templates.IntegrationTests/Snapshots/aichatweb.BasicAspire.verified/aichatweb/aichatweb.Web/Services/Ingestion/DataIngestor.cs +++ b/test/ProjectTemplates/Microsoft.Extensions.AI.Templates.IntegrationTests/Snapshots/aichatweb.BasicAspire.verified/aichatweb/aichatweb.Web/Services/Ingestion/DataIngestor.cs @@ -1,58 +1,35 @@ using Microsoft.Extensions.AI; +using Microsoft.Extensions.DataIngestion; +using Microsoft.Extensions.DataIngestion.Chunkers; using Microsoft.Extensions.VectorData; +using Microsoft.ML.Tokenizers; namespace aichatweb.Web.Services.Ingestion; public class DataIngestor( ILogger logger, - VectorStoreCollection chunksCollection, - VectorStoreCollection documentsCollection) + ILoggerFactory loggerFactory, + VectorStore vectorStore, + IEmbeddingGenerator> embeddingGenerator) { - public static async Task IngestDataAsync(IServiceProvider services, IIngestionSource source) + public async Task IngestDataAsync(DirectoryInfo directory, string searchPattern) { - using var scope = services.CreateScope(); - var ingestor = scope.ServiceProvider.GetRequiredService(); - await ingestor.IngestDataAsync(source); - } - - public async Task IngestDataAsync(IIngestionSource source) - { - await chunksCollection.EnsureCollectionExistsAsync(); - await documentsCollection.EnsureCollectionExistsAsync(); - - var sourceId = source.SourceId; - var documentsForSource = await documentsCollection.GetAsync(doc => doc.SourceId == sourceId, top: int.MaxValue).ToListAsync(); - - var deletedDocuments = await source.GetDeletedDocumentsAsync(documentsForSource); - foreach (var deletedDocument in deletedDocuments) + using var writer = new VectorStoreWriter(vectorStore, dimensionCount: IngestedChunk.VectorDimensions, new() { - logger.LogInformation("Removing ingested data for {DocumentId}", deletedDocument.DocumentId); - await DeleteChunksForDocumentAsync(deletedDocument); - await documentsCollection.DeleteAsync(deletedDocument.Key); - } - - var modifiedDocuments = await source.GetNewOrModifiedDocumentsAsync(documentsForSource); - foreach (var modifiedDocument in modifiedDocuments) - { - logger.LogInformation("Processing {DocumentId}", modifiedDocument.DocumentId); - await DeleteChunksForDocumentAsync(modifiedDocument); - - await documentsCollection.UpsertAsync(modifiedDocument); - - var newRecords = await source.CreateChunksForDocumentAsync(modifiedDocument); - await chunksCollection.UpsertAsync(newRecords); - } - - logger.LogInformation("Ingestion is up-to-date"); - - async Task DeleteChunksForDocumentAsync(IngestedDocument document) + CollectionName = IngestedChunk.CollectionName, + DistanceFunction = IngestedChunk.VectorDistanceFunction, + IncrementalIngestion = false, + }); + + using var pipeline = new IngestionPipeline( + reader: new DocumentReader(directory), + chunker: new SemanticSimilarityChunker(embeddingGenerator, new(TiktokenTokenizer.CreateForModel("gpt-4o"))), + writer: writer, + loggerFactory: loggerFactory); + + await foreach (var result in pipeline.ProcessAsync(directory, searchPattern)) { - var documentId = document.DocumentId; - var chunksToDelete = await chunksCollection.GetAsync(record => record.DocumentId == documentId, int.MaxValue).ToListAsync(); - if (chunksToDelete.Count != 0) - { - await chunksCollection.DeleteAsync(chunksToDelete.Select(r => r.Key)); - } + logger.LogInformation("Completed processing '{id}'. Succeeded: '{succeeded}'.", result.DocumentId, result.Succeeded); } } } diff --git a/test/ProjectTemplates/Microsoft.Extensions.AI.Templates.IntegrationTests/Snapshots/aichatweb.BasicAspire.verified/aichatweb/aichatweb.Web/Services/Ingestion/DocumentReader.cs b/test/ProjectTemplates/Microsoft.Extensions.AI.Templates.IntegrationTests/Snapshots/aichatweb.BasicAspire.verified/aichatweb/aichatweb.Web/Services/Ingestion/DocumentReader.cs new file mode 100644 index 00000000000..60fcdbdc128 --- /dev/null +++ b/test/ProjectTemplates/Microsoft.Extensions.AI.Templates.IntegrationTests/Snapshots/aichatweb.BasicAspire.verified/aichatweb/aichatweb.Web/Services/Ingestion/DocumentReader.cs @@ -0,0 +1,42 @@ +using Microsoft.Extensions.DataIngestion; + +namespace aichatweb.Web.Services.Ingestion; + +internal sealed class DocumentReader(DirectoryInfo rootDirectory) : IngestionDocumentReader +{ + private readonly MarkdownReader _markdownReader = new(); + private readonly MarkItDownMcpReader _pdfReader = new(mcpServerUri: GetMarkItDownMcpServerUrl()); + + public override Task ReadAsync(FileInfo source, string identifier, string? mediaType = null, CancellationToken cancellationToken = default) + { + if (Path.IsPathFullyQualified(identifier)) + { + // Normalize the identifier to its relative path + identifier = Path.GetRelativePath(rootDirectory.FullName, identifier); + } + + mediaType = GetCustomMediaType(source) ?? mediaType; + return base.ReadAsync(source, identifier, mediaType, cancellationToken); + } + + public override Task ReadAsync(Stream source, string identifier, string mediaType, CancellationToken cancellationToken = default) + => mediaType switch + { + "application/pdf" => _pdfReader.ReadAsync(source, identifier, mediaType, cancellationToken), + "text/markdown" => _markdownReader.ReadAsync(source, identifier, mediaType, cancellationToken), + _ => throw new InvalidOperationException($"Unsupported media type '{mediaType}'"), + }; + + private static string? GetCustomMediaType(FileInfo source) + => source.Extension switch + { + ".md" => "text/markdown", + _ => null + }; + + private static Uri GetMarkItDownMcpServerUrl() + { + var markItDownMcpUrl = $"{Environment.GetEnvironmentVariable("MARKITDOWN_MCP_URL")}/mcp"; + return new Uri(markItDownMcpUrl); + } +} diff --git a/test/ProjectTemplates/Microsoft.Extensions.AI.Templates.IntegrationTests/Snapshots/aichatweb.BasicAspire.verified/aichatweb/aichatweb.Web/Services/Ingestion/IIngestionSource.cs b/test/ProjectTemplates/Microsoft.Extensions.AI.Templates.IntegrationTests/Snapshots/aichatweb.BasicAspire.verified/aichatweb/aichatweb.Web/Services/Ingestion/IIngestionSource.cs deleted file mode 100644 index a1c6b2191d1..00000000000 --- a/test/ProjectTemplates/Microsoft.Extensions.AI.Templates.IntegrationTests/Snapshots/aichatweb.BasicAspire.verified/aichatweb/aichatweb.Web/Services/Ingestion/IIngestionSource.cs +++ /dev/null @@ -1,12 +0,0 @@ -namespace aichatweb.Web.Services.Ingestion; - -public interface IIngestionSource -{ - string SourceId { get; } - - Task> GetNewOrModifiedDocumentsAsync(IReadOnlyList existingDocuments); - - Task> GetDeletedDocumentsAsync(IReadOnlyList existingDocuments); - - Task> CreateChunksForDocumentAsync(IngestedDocument document); -} diff --git a/test/ProjectTemplates/Microsoft.Extensions.AI.Templates.IntegrationTests/Snapshots/aichatweb.BasicAspire.verified/aichatweb/aichatweb.Web/Services/Ingestion/PDFDirectorySource.cs b/test/ProjectTemplates/Microsoft.Extensions.AI.Templates.IntegrationTests/Snapshots/aichatweb.BasicAspire.verified/aichatweb/aichatweb.Web/Services/Ingestion/PDFDirectorySource.cs deleted file mode 100644 index 32e9f225c08..00000000000 --- a/test/ProjectTemplates/Microsoft.Extensions.AI.Templates.IntegrationTests/Snapshots/aichatweb.BasicAspire.verified/aichatweb/aichatweb.Web/Services/Ingestion/PDFDirectorySource.cs +++ /dev/null @@ -1,71 +0,0 @@ -using Microsoft.SemanticKernel.Text; -using UglyToad.PdfPig; -using UglyToad.PdfPig.Content; -using UglyToad.PdfPig.DocumentLayoutAnalysis.PageSegmenter; -using UglyToad.PdfPig.DocumentLayoutAnalysis.WordExtractor; - -namespace aichatweb.Web.Services.Ingestion; - -public class PDFDirectorySource(string sourceDirectory) : IIngestionSource -{ - public static string SourceFileId(string path) => Path.GetFileName(path); - public static string SourceFileVersion(string path) => File.GetLastWriteTimeUtc(path).ToString("o"); - - public string SourceId => $"{nameof(PDFDirectorySource)}:{sourceDirectory}"; - - public Task> GetNewOrModifiedDocumentsAsync(IReadOnlyList existingDocuments) - { - var results = new List(); - var sourceFiles = Directory.GetFiles(sourceDirectory, "*.pdf"); - var existingDocumentsById = existingDocuments.ToDictionary(d => d.DocumentId); - - foreach (var sourceFile in sourceFiles) - { - var sourceFileId = SourceFileId(sourceFile); - var sourceFileVersion = SourceFileVersion(sourceFile); - var existingDocumentVersion = existingDocumentsById.TryGetValue(sourceFileId, out var existingDocument) ? existingDocument.DocumentVersion : null; - if (existingDocumentVersion != sourceFileVersion) - { - results.Add(new() { Key = Guid.CreateVersion7().ToString(), SourceId = SourceId, DocumentId = sourceFileId, DocumentVersion = sourceFileVersion }); - } - } - - return Task.FromResult((IEnumerable)results); - } - - public Task> GetDeletedDocumentsAsync(IReadOnlyList existingDocuments) - { - var currentFiles = Directory.GetFiles(sourceDirectory, "*.pdf"); - var currentFileIds = currentFiles.ToLookup(SourceFileId); - var deletedDocuments = existingDocuments.Where(d => !currentFileIds.Contains(d.DocumentId)); - return Task.FromResult(deletedDocuments); - } - - public Task> CreateChunksForDocumentAsync(IngestedDocument document) - { - using var pdf = PdfDocument.Open(Path.Combine(sourceDirectory, document.DocumentId)); - var paragraphs = pdf.GetPages().SelectMany(GetPageParagraphs).ToList(); - - return Task.FromResult(paragraphs.Select(p => new IngestedChunk - { - Key = Guid.CreateVersion7().ToString(), - DocumentId = document.DocumentId, - PageNumber = p.PageNumber, - Text = p.Text, - })); - } - - private static IEnumerable<(int PageNumber, int IndexOnPage, string Text)> GetPageParagraphs(Page pdfPage) - { - var letters = pdfPage.Letters; - var words = NearestNeighbourWordExtractor.Instance.GetWords(letters); - var textBlocks = DocstrumBoundingBoxes.Instance.GetBlocks(words); - var pageText = string.Join(Environment.NewLine + Environment.NewLine, - textBlocks.Select(t => t.Text.ReplaceLineEndings(" "))); - -#pragma warning disable SKEXP0050 // Type is for evaluation purposes only - return TextChunker.SplitPlainTextParagraphs([pageText], 200) - .Select((text, index) => (pdfPage.Number, index, text)); -#pragma warning restore SKEXP0050 // Type is for evaluation purposes only - } -} diff --git a/test/ProjectTemplates/Microsoft.Extensions.AI.Templates.IntegrationTests/Snapshots/aichatweb.BasicAspire.verified/aichatweb/aichatweb.Web/Services/SemanticSearch.cs b/test/ProjectTemplates/Microsoft.Extensions.AI.Templates.IntegrationTests/Snapshots/aichatweb.BasicAspire.verified/aichatweb/aichatweb.Web/Services/SemanticSearch.cs index 84fb719f6ae..d043c8efb84 100644 --- a/test/ProjectTemplates/Microsoft.Extensions.AI.Templates.IntegrationTests/Snapshots/aichatweb.BasicAspire.verified/aichatweb/aichatweb.Web/Services/SemanticSearch.cs +++ b/test/ProjectTemplates/Microsoft.Extensions.AI.Templates.IntegrationTests/Snapshots/aichatweb.BasicAspire.verified/aichatweb/aichatweb.Web/Services/SemanticSearch.cs @@ -1,12 +1,22 @@ -using Microsoft.Extensions.VectorData; +using aichatweb.Web.Services.Ingestion; +using Microsoft.Extensions.VectorData; namespace aichatweb.Web.Services; public class SemanticSearch( - VectorStoreCollection vectorCollection) + VectorStoreCollection vectorCollection, + [FromKeyedServices("ingestion_directory")] DirectoryInfo ingestionDirectory, + DataIngestor dataIngestor) { + private Task? _ingestionTask; + + public async Task LoadDocumentsAsync() => await ( _ingestionTask ??= dataIngestor.IngestDataAsync(ingestionDirectory, searchPattern: "*.*")); + public async Task> SearchAsync(string text, string? documentIdFilter, int maxResults) { + // Ensure documents have been loaded before searching + await LoadDocumentsAsync(); + var nearest = vectorCollection.SearchAsync(text, maxResults, new VectorSearchOptions { Filter = documentIdFilter is { Length: > 0 } ? record => record.DocumentId == documentIdFilter : null, diff --git a/test/ProjectTemplates/Microsoft.Extensions.AI.Templates.IntegrationTests/Snapshots/aichatweb.BasicAspire.verified/aichatweb/aichatweb.Web/aichatweb.Web.csproj b/test/ProjectTemplates/Microsoft.Extensions.AI.Templates.IntegrationTests/Snapshots/aichatweb.BasicAspire.verified/aichatweb/aichatweb.Web/aichatweb.Web.csproj index 22c00c41978..21a99cc28f2 100644 --- a/test/ProjectTemplates/Microsoft.Extensions.AI.Templates.IntegrationTests/Snapshots/aichatweb.BasicAspire.verified/aichatweb/aichatweb.Web/aichatweb.Web.csproj +++ b/test/ProjectTemplates/Microsoft.Extensions.AI.Templates.IntegrationTests/Snapshots/aichatweb.BasicAspire.verified/aichatweb/aichatweb.Web/aichatweb.Web.csproj @@ -1,7 +1,7 @@  - net9.0 + net10.0 enable enable secret @@ -11,10 +11,12 @@ - - - - + + + + + + diff --git a/test/ProjectTemplates/Microsoft.Extensions.AI.Templates.IntegrationTests/Snapshots/aichatweb.BasicAspire.verified/aichatweb/aichatweb.Web/wwwroot/Data/Example_GPS_Watch.md b/test/ProjectTemplates/Microsoft.Extensions.AI.Templates.IntegrationTests/Snapshots/aichatweb.BasicAspire.verified/aichatweb/aichatweb.Web/wwwroot/Data/Example_GPS_Watch.md new file mode 100644 index 00000000000..f7d042edf83 --- /dev/null +++ b/test/ProjectTemplates/Microsoft.Extensions.AI.Templates.IntegrationTests/Snapshots/aichatweb.BasicAspire.verified/aichatweb/aichatweb.Web/wwwroot/Data/Example_GPS_Watch.md @@ -0,0 +1,193 @@ +# TrailMaster GPS Watch + +## 1. Introduction + +ExpeditionTech is proud to introduce the TrailMaster GPS Watch, a state-of-the-art outdoor electronics device designed for the most demanding outdoor adventurers. This watch is meticulously engineered to provide accurate location information, real-time sharing, and reliable mapping capabilities. The TrailMaster GPS Watch is built to withstand the harshest environmental conditions while providing users with the critical data they need to navigate through challenging terrain and optimize their outdoor experiences. + +### 1.1 Product Overview + +The TrailMaster GPS Watch is a high-performance outdoor electronics device that combines advanced GPS technology with rugged design. It features a durable, shock-resistant casing, a high-contrast display for optimal visibility in bright sunlight, and a built-in rechargeable battery for extended use in remote areas. The TrailMaster GPS Watch is equipped with a comprehensive suite of navigation tools, including topographic maps, trail tracking, and waypoint management. Additionally, it offers real-time location sharing for enhanced safety and group coordination during outdoor activities. + +### 1.2 Intended Use + +The TrailMaster GPS Watch is intended for use by experienced outdoor enthusiasts, including hikers, backpackers, trail runners, and mountaineers. This device is designed to provide essential navigation information and location tracking in remote, off-grid environments. Users can rely on the TrailMaster GPS Watch to plan and execute their outdoor adventures with confidence, knowing they have access to accurate maps, location data, and real-time sharing capabilities. Although the TrailMaster GPS Watch is engineered for extreme durability, users should always exercise caution and take appropriate safety measures when engaging in outdoor activities. + +#### 1.2.1 Safety Precautions + +Before using the TrailMaster GPS Watch, users must ensure that the device is fully charged and properly calibrated according to the manufacturer's specifications. It is essential to familiarize oneself with the watch's features, controls, and navigation functions before venturing into remote outdoor areas. Users should also be aware of potential environmental hazards, such as extreme weather conditions, rugged terrain, and limited access to emergency services. Proper planning, preparation, and adherence to best practices for outdoor safety are critical when using the TrailMaster GPS Watch. + +## 2. Technical Specifications + +### 2.1 Hardware + +#### 2.1.1 Processor and Memory + +The TrailMaster GPS Watch is equipped with a high-performance ARM Cortex processor, ensuring fast and efficient operation for all your outdoor activities. The device also comes with 4GB of internal memory, providing ample storage for maps, routes, and waypoints. The processor operates at 1.2GHz, allowing for quick map rendering and location updates. + +#### 2.1.2 GPS Module + +The GPS module in the TrailMaster GPS Watch utilizes a state-of-the-art multi-constellation receiver, supporting GPS, GLONASS, and Galileo satellite systems. This enables precise location tracking and navigation, even in challenging outdoor environments. The module also features advanced signal processing algorithms, ensuring reliable performance in remote areas with limited satellite visibility. + +#### 2.1.3 Sensors + +Equipped with a comprehensive set of sensors, the TrailMaster GPS Watch offers an array of valuable data for outdoor enthusiasts. The built-in altimeter provides accurate altitude readings, while the barometer monitors changes in air pressure to forecast weather conditions. Additionally, the watch includes a digital compass for reliable orientation, ensuring a seamless navigation experience in the great outdoors. + +### 2.2 Software + +#### 2.2.1 Operating System + +The TrailMaster GPS Watch runs on a proprietary operating system optimized for outdoor navigation and tracking. This custom OS combines robustness and efficiency, allowing for seamless integration with the device's hardware and sensors. The interface is designed for intuitive interaction, enabling users to access maps, location sharing, and other features with ease, even in challenging outdoor conditions. + +#### 2.2.2 Map Data + +The TrailMaster GPS Watch comes preloaded with detailed topographic maps, providing comprehensive coverage of trails, terrain, and points of interest. These maps are stored locally on the device, ensuring rapid access and smooth navigation without relying on cellular or data network connectivity. Users can also import additional map data via the dedicated USB port, expanding the watch's mapping capabilities for customized adventures. + +## 3. Setup and Installation + +### 3.1 Charging + +Before using your TrailMaster GPS Watch for the first time, it is essential to ensure that the device is fully charged. To charge your GPS watch, follow these steps: + +1. Locate the charging port cover on the back of the watch. +2. Gently lift the cover to expose the charging port. +3. Connect the provided USB charging cable to the port, ensuring a secure connection. +4. Plug the other end of the cable into a power source, such as a computer or USB wall adapter. +5. Allow the watch to charge for at least 2 hours, or until the battery indicator on the display shows it is fully charged. + +For optimal performance, it is recommended to fully charge the device before each use and to avoid overcharging. Please refer to the TrailMaster GPS Watch technical specifications for detailed battery charging information. + +### 3.2 Initial Configuration + +Once your TrailMaster GPS Watch is fully charged, you can proceed with the initial configuration by following these steps: + +1. Press and hold the power button located on the side of the watch to turn it on. +2. Follow the on-screen instructions to select your language, set the date and time, and calibrate the GPS. +3. Connect the watch to your smartphone using the TrailMaster companion app to enable real-time location sharing and receive notifications. +4. Customize the watch settings, such as display preferences and map views, to suit your outdoor activities. + +Before using the GPS functionality, it is crucial to ensure that the watch has a clear view of the sky to acquire GPS signals. Please refer to the TrailMaster GPS Watch user guide for detailed instructions on GPS calibration and satellite acquisition. + +## 4. Operation + +### 4.1 Basic Functions + +The TrailMaster GPS Watch is designed for outdoor use and offers a variety of basic functions to assist users in navigating and staying connected during their adventures. + +#### 4.1.1 Powering On and Off + +To power on the TrailMaster GPS Watch, press and hold the power button (located on the right side of the watch) for 3 seconds. The watch will display the ExpeditionTech logo and then proceed to the main navigation screen. To power off the watch, press and hold the power button and select "Power Off" from the menu. + +#### 4.1.2 Accessing Built-in Maps + +The TrailMaster GPS Watch comes pre-loaded with detailed maps of various outdoor locations. To access the maps, press the map button (located on the left side of the watch) to bring up the map interface. From here, you can view your current location, set waypoints, and plan routes. + +#### 4.1.3 Real-time Location Sharing + +Utilize the real-time location sharing feature to transmit your current location to designated contacts. Press the share button (located on the top of the watch) and select the specific contacts you wish to share your location with. This feature requires a stable GPS signal and a connected smartphone with the TrailMaster app installed. + +### 4.2 Advanced Features + +The TrailMaster GPS Watch offers advanced features to enhance the user experience and provide additional functionality for outdoor enthusiasts. + +#### 4.2.1 Rugged Design + +The TrailMaster GPS Watch is built to withstand rugged outdoor conditions, including extreme temperatures, water exposure, and impact. The durable casing and reinforced strap ensure that the watch remains operational in challenging environments. + +#### 4.2.2 Navigation Tools + +In addition to basic map access, the TrailMaster GPS Watch includes advanced navigation tools such as compass, altimeter, and barometer. These tools provide vital information for navigation and weather monitoring while in the field. + +#### 4.2.3 Customizing Data Screens + +Users can customize the data screens on the TrailMaster GPS Watch to display the specific information they require during their outdoor activities. From the main menu, navigate to the settings and select "Data Screens" to adjust the layout and content of the screens. + +#### 4.2.4 Tracking Performance Metrics + +The TrailMaster GPS Watch is equipped with sensors to track performance metrics such as distance traveled, speed, elevation gain, and heart rate. Use the tracking mode to monitor these metrics in real-time or review them after completing an activity. + +## 5. Troubleshooting + +### 5.1 Diagnostic Tools and Equipment + +When troubleshooting the TrailMaster GPS Watch, it is essential to use specialized industrial diagnostic tools and equipment to perform accurate diagnostic tests. These tools and equipment include: + +- **GPS Signal Analyzer**: Use a GPS signal analyzer to check the strength and quality of the satellite signals received by the watch. +- **RF Spectrum Analyzer**: An RF spectrum analyzer is required to analyze the radio frequency spectrum and identify any interference affecting the GPS reception. +- **Ruggedness Test Equipment**: Perform ruggedness tests using shock and vibration equipment to ensure the watch can withstand outdoor adventures without performance issues. + +It is essential to use these specialized tools and equipment to accurately diagnose any issues with the TrailMaster GPS Watch and ensure optimal performance. + +### 5.2 Common Issues + +#### 5.2.1 GPS Signal Loss + +**Symptoms:** + +The watch displays "No GPS Signal" or intermittently loses GPS signal during use. + +**Potential Causes:** + +- Obstruction of satellite signals due to dense foliage, tall buildings, or natural terrain features. +- Radio frequency interference affecting GPS reception. +- Wear and tear on the GPS antenna or receiver. + +**Troubleshooting Steps:** + +1. Check the surroundings for any obstructions blocking satellite signals. +2. Use an RF spectrum analyzer to identify any potential sources of interference. +3. Perform a diagnostics test using a GPS signal analyzer to assess the strength and quality of the GPS signal received by the watch. +4. If the issue persists, contact ExpeditionTech customer support for further assistance. + +#### 5.2.2 Connectivity Issues + +**Symptoms:** + +- Inability to share real-time location or connect to other devices. +- Unreliable Bluetooth connectivity. + +**Potential Causes:** + +- Bluetooth interference from other electronic devices. +- Signal obstruction due to environmental factors. +- Software or firmware issues. + +**Troubleshooting Steps:** + +1. Ensure the watch is within the recommended Bluetooth range of the connected device. +2. Identify and eliminate potential sources of Bluetooth interference in the vicinity. +3. Update the watch's firmware to the latest version to address any software-related connectivity issues. +4. If connectivity problems persist, perform a comprehensive diagnostics test using a specialized Bluetooth signal analyzer. + +By following these troubleshooting steps and using specialized diagnostic tools and equipment, users can effectively identify and address common issues with the TrailMaster GPS Watch. + +## 6. Maintenance and Care + +### 6.1 Cleaning + +It is important to regularly clean your TrailMaster GPS Watch to ensure optimal performance. Use a soft, damp cloth to gently wipe the watch face and straps. Do not use harsh chemicals or solvents, as these may damage the watch's rugged design and built-in maps. + +### 6.2 Battery Maintenance + +The TrailMaster GPS Watch is equipped with a rechargeable lithium-ion battery. To optimize battery life, it is recommended to fully charge the watch before each outdoor adventure. Additionally, it is important to avoid exposing the watch to extreme temperatures, as this may affect battery performance. + +### 6.3 Storage + +When not in use, store your TrailMaster GPS Watch in a cool, dry place. Avoid prolonged exposure to direct sunlight or extreme temperatures, as this may cause damage to the device. + +### 6.4 Software Updates + +To ensure that your TrailMaster GPS Watch operates efficiently, it is important to regularly check for and install software updates. These updates may include improvements to the built-in maps, real-time location sharing, and overall performance of the watch. + +### 6.5 Technical Diagnostics + +For advanced maintenance and care, it is recommended to perform technical diagnostics using specialized industrial and scientific equipment. Refer to formal industry specification codes and standards bodies for detailed instructions on performing these diagnostics. + +## 7. Regulatory Compliance + +### 7.1 FCC Compliance + +The ExpeditionTech TrailMaster GPS Watch complies with Part 15 of the FCC rules. Operation is subject to the following two conditions: (1) this device may not cause harmful interference, and (2) this device must accept any interference received, including interference that may cause undesired operation. Any changes or modifications not expressly approved by the party responsible for compliance could void the user's authority to operate the equipment. The user is cautioned that any changes or modifications made to this device that are not expressly approved by the manufacturer could void the user's authority to operate the equipment. + +### 7.2 CE Marking + +The CE marking on the ExpeditionTech TrailMaster GPS Watch indicates that it complies with the essential requirements of the relevant European health, safety, and environmental protection legislation. The device is in conformity with the essential requirements and other relevant provisions of Directive 1999/5/EC. The CE marking is affixed to the device to demonstrate that it meets the essential requirements for safety, health, and environmental protection. The user should only use the device in accordance with the instructions provided in the user manual. diff --git a/test/ProjectTemplates/Microsoft.Extensions.AI.Templates.IntegrationTests/Snapshots/aichatweb.BasicAspire.verified/aichatweb/aichatweb.Web/wwwroot/Data/Example_GPS_Watch.pdf b/test/ProjectTemplates/Microsoft.Extensions.AI.Templates.IntegrationTests/Snapshots/aichatweb.BasicAspire.verified/aichatweb/aichatweb.Web/wwwroot/Data/Example_GPS_Watch.pdf deleted file mode 100644 index c87df644c58..00000000000 Binary files a/test/ProjectTemplates/Microsoft.Extensions.AI.Templates.IntegrationTests/Snapshots/aichatweb.BasicAspire.verified/aichatweb/aichatweb.Web/wwwroot/Data/Example_GPS_Watch.pdf and /dev/null differ diff --git a/test/ProjectTemplates/Microsoft.Extensions.AI.Templates.IntegrationTests/Snapshots/aichatweb.BasicAspire.verified/aichatweb/aichatweb.Web/wwwroot/lib/markdown_viewer/viewer.html b/test/ProjectTemplates/Microsoft.Extensions.AI.Templates.IntegrationTests/Snapshots/aichatweb.BasicAspire.verified/aichatweb/aichatweb.Web/wwwroot/lib/markdown_viewer/viewer.html new file mode 100644 index 00000000000..94447ffc47e --- /dev/null +++ b/test/ProjectTemplates/Microsoft.Extensions.AI.Templates.IntegrationTests/Snapshots/aichatweb.BasicAspire.verified/aichatweb/aichatweb.Web/wwwroot/lib/markdown_viewer/viewer.html @@ -0,0 +1,32 @@ + + + + + Markdown viewer + + + + +
+ + + diff --git a/test/ProjectTemplates/Microsoft.Extensions.AI.Templates.IntegrationTests/Snapshots/aichatweb.BasicAspire.verified/aichatweb/aichatweb.Web/wwwroot/lib/markdown_viewer/viewer.mjs b/test/ProjectTemplates/Microsoft.Extensions.AI.Templates.IntegrationTests/Snapshots/aichatweb.BasicAspire.verified/aichatweb/aichatweb.Web/wwwroot/lib/markdown_viewer/viewer.mjs new file mode 100644 index 00000000000..78eb819c9a8 --- /dev/null +++ b/test/ProjectTemplates/Microsoft.Extensions.AI.Templates.IntegrationTests/Snapshots/aichatweb.BasicAspire.verified/aichatweb/aichatweb.Web/wwwroot/lib/markdown_viewer/viewer.mjs @@ -0,0 +1,13 @@ +import { parse } from '../marked/dist/marked.esm.js'; +import purify from '../dompurify/dist/purify.es.mjs'; + +const url = new URL(window.location); +const fileUrl = url.searchParams.get('file'); +if (!fileUrl) { + throw new Error('File not specified in the URL query string'); +} + +var response = await fetch(fileUrl); +var text = await response.text(); + +document.getElementById('content').innerHTML = purify.sanitize(parse(text)); diff --git a/test/ProjectTemplates/Microsoft.Extensions.AI.Templates.IntegrationTests/Snapshots/aichatweb.Ollama_Qdrant.verified/aichatweb/aichatweb.AppHost/AppHost.cs b/test/ProjectTemplates/Microsoft.Extensions.AI.Templates.IntegrationTests/Snapshots/aichatweb.Ollama_Qdrant.verified/aichatweb/aichatweb.AppHost/AppHost.cs index 9521e1a0297..9f664334406 100644 --- a/test/ProjectTemplates/Microsoft.Extensions.AI.Templates.IntegrationTests/Snapshots/aichatweb.Ollama_Qdrant.verified/aichatweb/aichatweb.AppHost/AppHost.cs +++ b/test/ProjectTemplates/Microsoft.Extensions.AI.Templates.IntegrationTests/Snapshots/aichatweb.Ollama_Qdrant.verified/aichatweb/aichatweb.AppHost/AppHost.cs @@ -9,6 +9,10 @@ .WithDataVolume() .WithLifetime(ContainerLifetime.Persistent); +var markitdown = builder.AddContainer("markitdown", "mcp/markitdown") + .WithArgs("--http", "--host", "0.0.0.0", "--port", "3001") + .WithHttpEndpoint(targetPort: 3001, name: "http"); + var webApp = builder.AddProject("aichatweb-app"); webApp .WithReference(chat) @@ -18,5 +22,7 @@ webApp .WithReference(vectorDB) .WaitFor(vectorDB); +webApp + .WithEnvironment("MARKITDOWN_MCP_URL", markitdown.GetEndpoint("http")); builder.Build().Run(); diff --git a/test/ProjectTemplates/Microsoft.Extensions.AI.Templates.IntegrationTests/Snapshots/aichatweb.Ollama_Qdrant.verified/aichatweb/aichatweb.AppHost/aichatweb.AppHost.csproj b/test/ProjectTemplates/Microsoft.Extensions.AI.Templates.IntegrationTests/Snapshots/aichatweb.Ollama_Qdrant.verified/aichatweb/aichatweb.AppHost/aichatweb.AppHost.csproj index 70239b97fa8..d29128f7763 100644 --- a/test/ProjectTemplates/Microsoft.Extensions.AI.Templates.IntegrationTests/Snapshots/aichatweb.Ollama_Qdrant.verified/aichatweb/aichatweb.AppHost/aichatweb.AppHost.csproj +++ b/test/ProjectTemplates/Microsoft.Extensions.AI.Templates.IntegrationTests/Snapshots/aichatweb.Ollama_Qdrant.verified/aichatweb/aichatweb.AppHost/aichatweb.AppHost.csproj @@ -4,7 +4,7 @@ Exe - net9.0 + net10.0 enable enable secret diff --git a/test/ProjectTemplates/Microsoft.Extensions.AI.Templates.IntegrationTests/Snapshots/aichatweb.Ollama_Qdrant.verified/aichatweb/aichatweb.ServiceDefaults/Extensions.cs b/test/ProjectTemplates/Microsoft.Extensions.AI.Templates.IntegrationTests/Snapshots/aichatweb.Ollama_Qdrant.verified/aichatweb/aichatweb.ServiceDefaults/Extensions.cs index b44d60b604b..8d0b0cd5d67 100644 --- a/test/ProjectTemplates/Microsoft.Extensions.AI.Templates.IntegrationTests/Snapshots/aichatweb.Ollama_Qdrant.verified/aichatweb/aichatweb.ServiceDefaults/Extensions.cs +++ b/test/ProjectTemplates/Microsoft.Extensions.AI.Templates.IntegrationTests/Snapshots/aichatweb.Ollama_Qdrant.verified/aichatweb/aichatweb.ServiceDefaults/Extensions.cs @@ -76,7 +76,8 @@ public static TBuilder ConfigureOpenTelemetry(this TBuilder builder) w // Uncomment the following line to enable gRPC instrumentation (requires the OpenTelemetry.Instrumentation.GrpcNetClient package) //.AddGrpcClientInstrumentation() .AddHttpClientInstrumentation() - .AddSource("Experimental.Microsoft.Extensions.AI"); + .AddSource("Experimental.Microsoft.Extensions.AI") + .AddSource("Experimental.Microsoft.Extensions.DataIngestion"); }); builder.AddOpenTelemetryExporters(); diff --git a/test/ProjectTemplates/Microsoft.Extensions.AI.Templates.IntegrationTests/Snapshots/aichatweb.Ollama_Qdrant.verified/aichatweb/aichatweb.ServiceDefaults/aichatweb.ServiceDefaults.csproj b/test/ProjectTemplates/Microsoft.Extensions.AI.Templates.IntegrationTests/Snapshots/aichatweb.Ollama_Qdrant.verified/aichatweb/aichatweb.ServiceDefaults/aichatweb.ServiceDefaults.csproj index 474dd445fae..a70a3ca8cd4 100644 --- a/test/ProjectTemplates/Microsoft.Extensions.AI.Templates.IntegrationTests/Snapshots/aichatweb.Ollama_Qdrant.verified/aichatweb/aichatweb.ServiceDefaults/aichatweb.ServiceDefaults.csproj +++ b/test/ProjectTemplates/Microsoft.Extensions.AI.Templates.IntegrationTests/Snapshots/aichatweb.Ollama_Qdrant.verified/aichatweb/aichatweb.ServiceDefaults/aichatweb.ServiceDefaults.csproj @@ -1,7 +1,7 @@  - net9.0 + net10.0 enable enable true diff --git a/test/ProjectTemplates/Microsoft.Extensions.AI.Templates.IntegrationTests/Snapshots/aichatweb.Ollama_Qdrant.verified/aichatweb/aichatweb.Web/Components/Pages/Chat/Chat.razor b/test/ProjectTemplates/Microsoft.Extensions.AI.Templates.IntegrationTests/Snapshots/aichatweb.Ollama_Qdrant.verified/aichatweb/aichatweb.Web/Components/Pages/Chat/Chat.razor index 8aa0ec9fd28..6fc5881c18f 100644 --- a/test/ProjectTemplates/Microsoft.Extensions.AI.Templates.IntegrationTests/Snapshots/aichatweb.Ollama_Qdrant.verified/aichatweb/aichatweb.Web/Components/Pages/Chat/Chat.razor +++ b/test/ProjectTemplates/Microsoft.Extensions.AI.Templates.IntegrationTests/Snapshots/aichatweb.Ollama_Qdrant.verified/aichatweb/aichatweb.Web/Components/Pages/Chat/Chat.razor @@ -13,7 +13,7 @@
To get started, try asking about these example documents. You can replace these with your own data and replace this message.
- + @@ -29,10 +29,12 @@ Do not answer questions about anything else. Use only simple markdown to format your responses. - Use the search tool to find relevant information. When you do this, end your + Use the LoadDocuments tool to prepare for searches before answering any questions. + + Use the Search tool to find relevant information. When you do this, end your reply with citations in the special XML format: - exact quote here + exact quote here Always include the citation in your response if there are results. @@ -52,7 +54,10 @@ { statefulMessageCount = 0; messages.Add(new(ChatRole.System, SystemPrompt)); - chatOptions.Tools = [AIFunctionFactory.Create(SearchAsync)]; + chatOptions.Tools = [ + AIFunctionFactory.Create(LoadDocumentsAsync), + AIFunctionFactory.Create(SearchAsync) + ]; } private async Task AddUserMessageAsync(ChatMessage userMessage) @@ -106,7 +111,14 @@ await chatInput!.FocusAsync(); } - [Description("Searches for information using a phrase or keyword")] + [Description("Loads the documents needed for performing searches. Must be completed before a search can be executed, but only needs to be completed once.")] + private async Task LoadDocumentsAsync() + { + await InvokeAsync(StateHasChanged); + await Search.LoadDocumentsAsync(); + } + + [Description("Searches for information using a phrase or keyword. Relies on documents already being loaded.")] private async Task> SearchAsync( [Description("The phrase to search for.")] string searchPhrase, [Description("If possible, specify the filename to search that file only. If not provided or empty, the search includes all files.")] string? filenameFilter = null) @@ -114,7 +126,7 @@ await InvokeAsync(StateHasChanged); var results = await Search.SearchAsync(searchPhrase, filenameFilter, maxResults: 5); return results.Select(result => - $"{result.Text}"); + $"{result.Text}"); } public void Dispose() diff --git a/test/ProjectTemplates/Microsoft.Extensions.AI.Templates.IntegrationTests/Snapshots/aichatweb.Ollama_Qdrant.verified/aichatweb/aichatweb.Web/Components/Pages/Chat/ChatCitation.razor b/test/ProjectTemplates/Microsoft.Extensions.AI.Templates.IntegrationTests/Snapshots/aichatweb.Ollama_Qdrant.verified/aichatweb/aichatweb.Web/Components/Pages/Chat/ChatCitation.razor index ccb5853cec4..667189beabd 100644 --- a/test/ProjectTemplates/Microsoft.Extensions.AI.Templates.IntegrationTests/Snapshots/aichatweb.Ollama_Qdrant.verified/aichatweb/aichatweb.Web/Components/Pages/Chat/ChatCitation.razor +++ b/test/ProjectTemplates/Microsoft.Extensions.AI.Templates.IntegrationTests/Snapshots/aichatweb.Ollama_Qdrant.verified/aichatweb/aichatweb.Web/Components/Pages/Chat/ChatCitation.razor @@ -17,10 +17,7 @@ public required string File { get; set; } [Parameter] - public int? PageNumber { get; set; } - - [Parameter] - public required string Quote { get; set; } + public string? Quote { get; set; } private string? viewerUrl; @@ -28,11 +25,15 @@ { viewerUrl = null; - // If you ingest other types of content besides PDF files, construct a URL to an appropriate viewer here - if (File.EndsWith(".pdf")) + // If you ingest other types of content besides Markdown or PDF files, construct a URL to an appropriate viewer here + if (File.EndsWith(".md")) + { + viewerUrl = $"lib/markdown_viewer/viewer.html?file=/Data/{HttpUtility.UrlEncode(File)}#:~:text={Uri.EscapeDataString(Quote ?? "")}"; + } + else if (File.EndsWith(".pdf")) { var search = Quote?.Trim('.', ',', ' ', '\n', '\r', '\t', '"', '\''); - viewerUrl = $"lib/pdf_viewer/viewer.html?file=/Data/{HttpUtility.UrlEncode(File)}#page={PageNumber}&search={HttpUtility.UrlEncode(search)}&phrase=true"; + viewerUrl = $"lib/pdf_viewer/viewer.html?file=/Data/{HttpUtility.UrlEncode(File)}#search={HttpUtility.UrlEncode(search)}&phrase=true"; } } } diff --git a/test/ProjectTemplates/Microsoft.Extensions.AI.Templates.IntegrationTests/Snapshots/aichatweb.Ollama_Qdrant.verified/aichatweb/aichatweb.Web/Components/Pages/Chat/ChatMessageItem.razor b/test/ProjectTemplates/Microsoft.Extensions.AI.Templates.IntegrationTests/Snapshots/aichatweb.Ollama_Qdrant.verified/aichatweb/aichatweb.Web/Components/Pages/Chat/ChatMessageItem.razor index 92c20c70667..e45d92ab5f9 100644 --- a/test/ProjectTemplates/Microsoft.Extensions.AI.Templates.IntegrationTests/Snapshots/aichatweb.Ollama_Qdrant.verified/aichatweb/aichatweb.Web/Components/Pages/Chat/ChatMessageItem.razor +++ b/test/ProjectTemplates/Microsoft.Extensions.AI.Templates.IntegrationTests/Snapshots/aichatweb.Ollama_Qdrant.verified/aichatweb/aichatweb.Web/Components/Pages/Chat/ChatMessageItem.razor @@ -28,11 +28,24 @@ else if (Message.Role == ChatRole.Assistant) @foreach (var citation in citations ?? []) { - + }
} + else if (content is FunctionCallContent { Name: "LoadDocuments" }) + { +
+
+ + + +
+
+ Loading relevant documents (this will take a minute)... +
+
+ } else if (content is FunctionCallContent { Name: "Search" } fcc && fcc.Arguments?.TryGetValue("searchPhrase", out var searchPhrase) is true) {
@@ -56,9 +69,9 @@ else if (Message.Role == ChatRole.Assistant) @code { private static readonly ConditionalWeakTable SubscribersLookup = new(); - private static readonly Regex CitationRegex = new(@"(?.*?)", RegexOptions.NonBacktracking); + private static readonly Regex CitationRegex = new(@"(?.*?)", RegexOptions.NonBacktracking); - private List<(string File, int? Page, string Quote)>? citations; + private List<(string File, string Quote)>? citations; [Parameter, EditorRequired] public required ChatMessage Message { get; set; } @@ -88,7 +101,7 @@ else if (Message.Role == ChatRole.Assistant) { var matches = CitationRegex.Matches(text); citations = matches.Any() - ? matches.Select(m => (m.Groups["file"].Value, int.TryParse(m.Groups["page"].Value, out var page) ? page : (int?)null, m.Groups["quote"].Value)).ToList() + ? matches.Select(m => (m.Groups["file"].Value, m.Groups["quote"].Value)).ToList() : null; } } diff --git a/test/ProjectTemplates/Microsoft.Extensions.AI.Templates.IntegrationTests/Snapshots/aichatweb.Ollama_Qdrant.verified/aichatweb/aichatweb.Web/Program.cs b/test/ProjectTemplates/Microsoft.Extensions.AI.Templates.IntegrationTests/Snapshots/aichatweb.Ollama_Qdrant.verified/aichatweb/aichatweb.Web/Program.cs index c67c70db5d6..0a20a05d52b 100644 --- a/test/ProjectTemplates/Microsoft.Extensions.AI.Templates.IntegrationTests/Snapshots/aichatweb.Ollama_Qdrant.verified/aichatweb/aichatweb.Web/Program.cs +++ b/test/ProjectTemplates/Microsoft.Extensions.AI.Templates.IntegrationTests/Snapshots/aichatweb.Ollama_Qdrant.verified/aichatweb/aichatweb.Web/Program.cs @@ -16,10 +16,11 @@ .AddEmbeddingGenerator(); builder.AddQdrantClient("vectordb"); -builder.Services.AddQdrantCollection("data-aichatweb-chunks"); -builder.Services.AddQdrantCollection("data-aichatweb-documents"); -builder.Services.AddScoped(); +builder.Services.AddQdrantVectorStore(); +builder.Services.AddQdrantCollection(IngestedChunk.CollectionName); +builder.Services.AddSingleton(); builder.Services.AddSingleton(); +builder.Services.AddKeyedSingleton("ingestion_directory", new DirectoryInfo(Path.Combine(builder.Environment.WebRootPath, "Data"))); // Applies robust HTTP resilience settings for all HttpClients in the Web project, // not across the entire solution. It's aimed at supporting Ollama scenarios due // to its self-hosted nature and potentially slow responses. @@ -45,12 +46,4 @@ app.MapRazorComponents() .AddInteractiveServerRenderMode(); -// By default, we ingest PDF files from the /wwwroot/Data directory. You can ingest from -// other sources by implementing IIngestionSource. -// Important: ensure that any content you ingest is trusted, as it may be reflected back -// to users or could be a source of prompt injection risk. -await DataIngestor.IngestDataAsync( - app.Services, - new PDFDirectorySource(Path.Combine(builder.Environment.WebRootPath, "Data"))); - app.Run(); diff --git a/test/ProjectTemplates/Microsoft.Extensions.AI.Templates.IntegrationTests/Snapshots/aichatweb.Ollama_Qdrant.verified/aichatweb/aichatweb.Web/Services/IngestedChunk.cs b/test/ProjectTemplates/Microsoft.Extensions.AI.Templates.IntegrationTests/Snapshots/aichatweb.Ollama_Qdrant.verified/aichatweb/aichatweb.Web/Services/IngestedChunk.cs index 0e161a6278b..b55a8b3c817 100644 --- a/test/ProjectTemplates/Microsoft.Extensions.AI.Templates.IntegrationTests/Snapshots/aichatweb.Ollama_Qdrant.verified/aichatweb/aichatweb.Web/Services/IngestedChunk.cs +++ b/test/ProjectTemplates/Microsoft.Extensions.AI.Templates.IntegrationTests/Snapshots/aichatweb.Ollama_Qdrant.verified/aichatweb/aichatweb.Web/Services/IngestedChunk.cs @@ -1,24 +1,31 @@ -using Microsoft.Extensions.VectorData; +using System.Text.Json.Serialization; +using Microsoft.Extensions.VectorData; namespace aichatweb.Web.Services; public class IngestedChunk { - private const int VectorDimensions = 384; // 384 is the default vector size for the all-minilm embedding model - private const string VectorDistanceFunction = DistanceFunction.CosineSimilarity; + public const int VectorDimensions = 384; // 384 is the default vector size for the all-minilm embedding model + public const string VectorDistanceFunction = DistanceFunction.CosineSimilarity; + public const string CollectionName = "data-aichatweb-chunks"; - [VectorStoreKey] + [VectorStoreKey(StorageName = "key")] + [JsonPropertyName("key")] public required Guid Key { get; set; } - [VectorStoreData(IsIndexed = true)] + [VectorStoreData(StorageName = "documentid")] + [JsonPropertyName("documentid")] public required string DocumentId { get; set; } - [VectorStoreData] - public int PageNumber { get; set; } - - [VectorStoreData] + [VectorStoreData(StorageName = "content")] + [JsonPropertyName("content")] public required string Text { get; set; } - [VectorStoreVector(VectorDimensions, DistanceFunction = VectorDistanceFunction)] + [VectorStoreData(StorageName = "context")] + [JsonPropertyName("context")] + public string? Context { get; set; } + + [VectorStoreVector(VectorDimensions, DistanceFunction = VectorDistanceFunction, StorageName = "embedding")] + [JsonPropertyName("embedding")] public string? Vector => Text; } diff --git a/test/ProjectTemplates/Microsoft.Extensions.AI.Templates.IntegrationTests/Snapshots/aichatweb.Ollama_Qdrant.verified/aichatweb/aichatweb.Web/Services/IngestedDocument.cs b/test/ProjectTemplates/Microsoft.Extensions.AI.Templates.IntegrationTests/Snapshots/aichatweb.Ollama_Qdrant.verified/aichatweb/aichatweb.Web/Services/IngestedDocument.cs deleted file mode 100644 index 8a6ec320251..00000000000 --- a/test/ProjectTemplates/Microsoft.Extensions.AI.Templates.IntegrationTests/Snapshots/aichatweb.Ollama_Qdrant.verified/aichatweb/aichatweb.Web/Services/IngestedDocument.cs +++ /dev/null @@ -1,25 +0,0 @@ -using Microsoft.Extensions.VectorData; - -namespace aichatweb.Web.Services; - -public class IngestedDocument -{ - private const int VectorDimensions = 2; - private const string VectorDistanceFunction = DistanceFunction.CosineSimilarity; - - [VectorStoreKey] - public required Guid Key { get; set; } - - [VectorStoreData(IsIndexed = true)] - public required string SourceId { get; set; } - - [VectorStoreData] - public required string DocumentId { get; set; } - - [VectorStoreData] - public required string DocumentVersion { get; set; } - - // The vector is not used but required for some vector databases - [VectorStoreVector(VectorDimensions, DistanceFunction = VectorDistanceFunction)] - public ReadOnlyMemory Vector { get; set; } = new ReadOnlyMemory([0, 0]); -} diff --git a/test/ProjectTemplates/Microsoft.Extensions.AI.Templates.IntegrationTests/Snapshots/aichatweb.Ollama_Qdrant.verified/aichatweb/aichatweb.Web/Services/Ingestion/DataIngestor.cs b/test/ProjectTemplates/Microsoft.Extensions.AI.Templates.IntegrationTests/Snapshots/aichatweb.Ollama_Qdrant.verified/aichatweb/aichatweb.Web/Services/Ingestion/DataIngestor.cs index 894b85c10de..9dd366a03a5 100644 --- a/test/ProjectTemplates/Microsoft.Extensions.AI.Templates.IntegrationTests/Snapshots/aichatweb.Ollama_Qdrant.verified/aichatweb/aichatweb.Web/Services/Ingestion/DataIngestor.cs +++ b/test/ProjectTemplates/Microsoft.Extensions.AI.Templates.IntegrationTests/Snapshots/aichatweb.Ollama_Qdrant.verified/aichatweb/aichatweb.Web/Services/Ingestion/DataIngestor.cs @@ -1,58 +1,35 @@ using Microsoft.Extensions.AI; +using Microsoft.Extensions.DataIngestion; +using Microsoft.Extensions.DataIngestion.Chunkers; using Microsoft.Extensions.VectorData; +using Microsoft.ML.Tokenizers; namespace aichatweb.Web.Services.Ingestion; public class DataIngestor( ILogger logger, - VectorStoreCollection chunksCollection, - VectorStoreCollection documentsCollection) + ILoggerFactory loggerFactory, + VectorStore vectorStore, + IEmbeddingGenerator> embeddingGenerator) { - public static async Task IngestDataAsync(IServiceProvider services, IIngestionSource source) + public async Task IngestDataAsync(DirectoryInfo directory, string searchPattern) { - using var scope = services.CreateScope(); - var ingestor = scope.ServiceProvider.GetRequiredService(); - await ingestor.IngestDataAsync(source); - } - - public async Task IngestDataAsync(IIngestionSource source) - { - await chunksCollection.EnsureCollectionExistsAsync(); - await documentsCollection.EnsureCollectionExistsAsync(); - - var sourceId = source.SourceId; - var documentsForSource = await documentsCollection.GetAsync(doc => doc.SourceId == sourceId, top: int.MaxValue).ToListAsync(); - - var deletedDocuments = await source.GetDeletedDocumentsAsync(documentsForSource); - foreach (var deletedDocument in deletedDocuments) + using var writer = new VectorStoreWriter(vectorStore, dimensionCount: IngestedChunk.VectorDimensions, new() { - logger.LogInformation("Removing ingested data for {DocumentId}", deletedDocument.DocumentId); - await DeleteChunksForDocumentAsync(deletedDocument); - await documentsCollection.DeleteAsync(deletedDocument.Key); - } - - var modifiedDocuments = await source.GetNewOrModifiedDocumentsAsync(documentsForSource); - foreach (var modifiedDocument in modifiedDocuments) - { - logger.LogInformation("Processing {DocumentId}", modifiedDocument.DocumentId); - await DeleteChunksForDocumentAsync(modifiedDocument); - - await documentsCollection.UpsertAsync(modifiedDocument); - - var newRecords = await source.CreateChunksForDocumentAsync(modifiedDocument); - await chunksCollection.UpsertAsync(newRecords); - } - - logger.LogInformation("Ingestion is up-to-date"); - - async Task DeleteChunksForDocumentAsync(IngestedDocument document) + CollectionName = IngestedChunk.CollectionName, + DistanceFunction = IngestedChunk.VectorDistanceFunction, + IncrementalIngestion = false, + }); + + using var pipeline = new IngestionPipeline( + reader: new DocumentReader(directory), + chunker: new SemanticSimilarityChunker(embeddingGenerator, new(TiktokenTokenizer.CreateForModel("gpt-4o"))), + writer: writer, + loggerFactory: loggerFactory); + + await foreach (var result in pipeline.ProcessAsync(directory, searchPattern)) { - var documentId = document.DocumentId; - var chunksToDelete = await chunksCollection.GetAsync(record => record.DocumentId == documentId, int.MaxValue).ToListAsync(); - if (chunksToDelete.Count != 0) - { - await chunksCollection.DeleteAsync(chunksToDelete.Select(r => r.Key)); - } + logger.LogInformation("Completed processing '{id}'. Succeeded: '{succeeded}'.", result.DocumentId, result.Succeeded); } } } diff --git a/test/ProjectTemplates/Microsoft.Extensions.AI.Templates.IntegrationTests/Snapshots/aichatweb.Ollama_Qdrant.verified/aichatweb/aichatweb.Web/Services/Ingestion/DocumentReader.cs b/test/ProjectTemplates/Microsoft.Extensions.AI.Templates.IntegrationTests/Snapshots/aichatweb.Ollama_Qdrant.verified/aichatweb/aichatweb.Web/Services/Ingestion/DocumentReader.cs new file mode 100644 index 00000000000..60fcdbdc128 --- /dev/null +++ b/test/ProjectTemplates/Microsoft.Extensions.AI.Templates.IntegrationTests/Snapshots/aichatweb.Ollama_Qdrant.verified/aichatweb/aichatweb.Web/Services/Ingestion/DocumentReader.cs @@ -0,0 +1,42 @@ +using Microsoft.Extensions.DataIngestion; + +namespace aichatweb.Web.Services.Ingestion; + +internal sealed class DocumentReader(DirectoryInfo rootDirectory) : IngestionDocumentReader +{ + private readonly MarkdownReader _markdownReader = new(); + private readonly MarkItDownMcpReader _pdfReader = new(mcpServerUri: GetMarkItDownMcpServerUrl()); + + public override Task ReadAsync(FileInfo source, string identifier, string? mediaType = null, CancellationToken cancellationToken = default) + { + if (Path.IsPathFullyQualified(identifier)) + { + // Normalize the identifier to its relative path + identifier = Path.GetRelativePath(rootDirectory.FullName, identifier); + } + + mediaType = GetCustomMediaType(source) ?? mediaType; + return base.ReadAsync(source, identifier, mediaType, cancellationToken); + } + + public override Task ReadAsync(Stream source, string identifier, string mediaType, CancellationToken cancellationToken = default) + => mediaType switch + { + "application/pdf" => _pdfReader.ReadAsync(source, identifier, mediaType, cancellationToken), + "text/markdown" => _markdownReader.ReadAsync(source, identifier, mediaType, cancellationToken), + _ => throw new InvalidOperationException($"Unsupported media type '{mediaType}'"), + }; + + private static string? GetCustomMediaType(FileInfo source) + => source.Extension switch + { + ".md" => "text/markdown", + _ => null + }; + + private static Uri GetMarkItDownMcpServerUrl() + { + var markItDownMcpUrl = $"{Environment.GetEnvironmentVariable("MARKITDOWN_MCP_URL")}/mcp"; + return new Uri(markItDownMcpUrl); + } +} diff --git a/test/ProjectTemplates/Microsoft.Extensions.AI.Templates.IntegrationTests/Snapshots/aichatweb.Ollama_Qdrant.verified/aichatweb/aichatweb.Web/Services/Ingestion/IIngestionSource.cs b/test/ProjectTemplates/Microsoft.Extensions.AI.Templates.IntegrationTests/Snapshots/aichatweb.Ollama_Qdrant.verified/aichatweb/aichatweb.Web/Services/Ingestion/IIngestionSource.cs deleted file mode 100644 index a1c6b2191d1..00000000000 --- a/test/ProjectTemplates/Microsoft.Extensions.AI.Templates.IntegrationTests/Snapshots/aichatweb.Ollama_Qdrant.verified/aichatweb/aichatweb.Web/Services/Ingestion/IIngestionSource.cs +++ /dev/null @@ -1,12 +0,0 @@ -namespace aichatweb.Web.Services.Ingestion; - -public interface IIngestionSource -{ - string SourceId { get; } - - Task> GetNewOrModifiedDocumentsAsync(IReadOnlyList existingDocuments); - - Task> GetDeletedDocumentsAsync(IReadOnlyList existingDocuments); - - Task> CreateChunksForDocumentAsync(IngestedDocument document); -} diff --git a/test/ProjectTemplates/Microsoft.Extensions.AI.Templates.IntegrationTests/Snapshots/aichatweb.Ollama_Qdrant.verified/aichatweb/aichatweb.Web/Services/Ingestion/PDFDirectorySource.cs b/test/ProjectTemplates/Microsoft.Extensions.AI.Templates.IntegrationTests/Snapshots/aichatweb.Ollama_Qdrant.verified/aichatweb/aichatweb.Web/Services/Ingestion/PDFDirectorySource.cs deleted file mode 100644 index da043feb526..00000000000 --- a/test/ProjectTemplates/Microsoft.Extensions.AI.Templates.IntegrationTests/Snapshots/aichatweb.Ollama_Qdrant.verified/aichatweb/aichatweb.Web/Services/Ingestion/PDFDirectorySource.cs +++ /dev/null @@ -1,71 +0,0 @@ -using Microsoft.SemanticKernel.Text; -using UglyToad.PdfPig; -using UglyToad.PdfPig.Content; -using UglyToad.PdfPig.DocumentLayoutAnalysis.PageSegmenter; -using UglyToad.PdfPig.DocumentLayoutAnalysis.WordExtractor; - -namespace aichatweb.Web.Services.Ingestion; - -public class PDFDirectorySource(string sourceDirectory) : IIngestionSource -{ - public static string SourceFileId(string path) => Path.GetFileName(path); - public static string SourceFileVersion(string path) => File.GetLastWriteTimeUtc(path).ToString("o"); - - public string SourceId => $"{nameof(PDFDirectorySource)}:{sourceDirectory}"; - - public Task> GetNewOrModifiedDocumentsAsync(IReadOnlyList existingDocuments) - { - var results = new List(); - var sourceFiles = Directory.GetFiles(sourceDirectory, "*.pdf"); - var existingDocumentsById = existingDocuments.ToDictionary(d => d.DocumentId); - - foreach (var sourceFile in sourceFiles) - { - var sourceFileId = SourceFileId(sourceFile); - var sourceFileVersion = SourceFileVersion(sourceFile); - var existingDocumentVersion = existingDocumentsById.TryGetValue(sourceFileId, out var existingDocument) ? existingDocument.DocumentVersion : null; - if (existingDocumentVersion != sourceFileVersion) - { - results.Add(new() { Key = Guid.CreateVersion7(), SourceId = SourceId, DocumentId = sourceFileId, DocumentVersion = sourceFileVersion }); - } - } - - return Task.FromResult((IEnumerable)results); - } - - public Task> GetDeletedDocumentsAsync(IReadOnlyList existingDocuments) - { - var currentFiles = Directory.GetFiles(sourceDirectory, "*.pdf"); - var currentFileIds = currentFiles.ToLookup(SourceFileId); - var deletedDocuments = existingDocuments.Where(d => !currentFileIds.Contains(d.DocumentId)); - return Task.FromResult(deletedDocuments); - } - - public Task> CreateChunksForDocumentAsync(IngestedDocument document) - { - using var pdf = PdfDocument.Open(Path.Combine(sourceDirectory, document.DocumentId)); - var paragraphs = pdf.GetPages().SelectMany(GetPageParagraphs).ToList(); - - return Task.FromResult(paragraphs.Select(p => new IngestedChunk - { - Key = Guid.CreateVersion7(), - DocumentId = document.DocumentId, - PageNumber = p.PageNumber, - Text = p.Text, - })); - } - - private static IEnumerable<(int PageNumber, int IndexOnPage, string Text)> GetPageParagraphs(Page pdfPage) - { - var letters = pdfPage.Letters; - var words = NearestNeighbourWordExtractor.Instance.GetWords(letters); - var textBlocks = DocstrumBoundingBoxes.Instance.GetBlocks(words); - var pageText = string.Join(Environment.NewLine + Environment.NewLine, - textBlocks.Select(t => t.Text.ReplaceLineEndings(" "))); - -#pragma warning disable SKEXP0050 // Type is for evaluation purposes only - return TextChunker.SplitPlainTextParagraphs([pageText], 200) - .Select((text, index) => (pdfPage.Number, index, text)); -#pragma warning restore SKEXP0050 // Type is for evaluation purposes only - } -} diff --git a/test/ProjectTemplates/Microsoft.Extensions.AI.Templates.IntegrationTests/Snapshots/aichatweb.Ollama_Qdrant.verified/aichatweb/aichatweb.Web/Services/SemanticSearch.cs b/test/ProjectTemplates/Microsoft.Extensions.AI.Templates.IntegrationTests/Snapshots/aichatweb.Ollama_Qdrant.verified/aichatweb/aichatweb.Web/Services/SemanticSearch.cs index 044e8378595..7d8718028bd 100644 --- a/test/ProjectTemplates/Microsoft.Extensions.AI.Templates.IntegrationTests/Snapshots/aichatweb.Ollama_Qdrant.verified/aichatweb/aichatweb.Web/Services/SemanticSearch.cs +++ b/test/ProjectTemplates/Microsoft.Extensions.AI.Templates.IntegrationTests/Snapshots/aichatweb.Ollama_Qdrant.verified/aichatweb/aichatweb.Web/Services/SemanticSearch.cs @@ -1,12 +1,22 @@ -using Microsoft.Extensions.VectorData; +using aichatweb.Web.Services.Ingestion; +using Microsoft.Extensions.VectorData; namespace aichatweb.Web.Services; public class SemanticSearch( - VectorStoreCollection vectorCollection) + VectorStoreCollection vectorCollection, + [FromKeyedServices("ingestion_directory")] DirectoryInfo ingestionDirectory, + DataIngestor dataIngestor) { + private Task? _ingestionTask; + + public async Task LoadDocumentsAsync() => await ( _ingestionTask ??= dataIngestor.IngestDataAsync(ingestionDirectory, searchPattern: "*.*")); + public async Task> SearchAsync(string text, string? documentIdFilter, int maxResults) { + // Ensure documents have been loaded before searching + await LoadDocumentsAsync(); + var nearest = vectorCollection.SearchAsync(text, maxResults, new VectorSearchOptions { Filter = documentIdFilter is { Length: > 0 } ? record => record.DocumentId == documentIdFilter : null, diff --git a/test/ProjectTemplates/Microsoft.Extensions.AI.Templates.IntegrationTests/Snapshots/aichatweb.Ollama_Qdrant.verified/aichatweb/aichatweb.Web/aichatweb.Web.csproj b/test/ProjectTemplates/Microsoft.Extensions.AI.Templates.IntegrationTests/Snapshots/aichatweb.Ollama_Qdrant.verified/aichatweb/aichatweb.Web/aichatweb.Web.csproj index 2b573a14d47..a81428f6388 100644 --- a/test/ProjectTemplates/Microsoft.Extensions.AI.Templates.IntegrationTests/Snapshots/aichatweb.Ollama_Qdrant.verified/aichatweb/aichatweb.Web/aichatweb.Web.csproj +++ b/test/ProjectTemplates/Microsoft.Extensions.AI.Templates.IntegrationTests/Snapshots/aichatweb.Ollama_Qdrant.verified/aichatweb/aichatweb.Web/aichatweb.Web.csproj @@ -1,7 +1,7 @@  - net9.0 + net10.0 enable enable secret @@ -11,11 +11,13 @@ - - - + + + + + - + diff --git a/test/ProjectTemplates/Microsoft.Extensions.AI.Templates.IntegrationTests/Snapshots/aichatweb.Ollama_Qdrant.verified/aichatweb/aichatweb.Web/wwwroot/Data/Example_GPS_Watch.md b/test/ProjectTemplates/Microsoft.Extensions.AI.Templates.IntegrationTests/Snapshots/aichatweb.Ollama_Qdrant.verified/aichatweb/aichatweb.Web/wwwroot/Data/Example_GPS_Watch.md new file mode 100644 index 00000000000..f7d042edf83 --- /dev/null +++ b/test/ProjectTemplates/Microsoft.Extensions.AI.Templates.IntegrationTests/Snapshots/aichatweb.Ollama_Qdrant.verified/aichatweb/aichatweb.Web/wwwroot/Data/Example_GPS_Watch.md @@ -0,0 +1,193 @@ +# TrailMaster GPS Watch + +## 1. Introduction + +ExpeditionTech is proud to introduce the TrailMaster GPS Watch, a state-of-the-art outdoor electronics device designed for the most demanding outdoor adventurers. This watch is meticulously engineered to provide accurate location information, real-time sharing, and reliable mapping capabilities. The TrailMaster GPS Watch is built to withstand the harshest environmental conditions while providing users with the critical data they need to navigate through challenging terrain and optimize their outdoor experiences. + +### 1.1 Product Overview + +The TrailMaster GPS Watch is a high-performance outdoor electronics device that combines advanced GPS technology with rugged design. It features a durable, shock-resistant casing, a high-contrast display for optimal visibility in bright sunlight, and a built-in rechargeable battery for extended use in remote areas. The TrailMaster GPS Watch is equipped with a comprehensive suite of navigation tools, including topographic maps, trail tracking, and waypoint management. Additionally, it offers real-time location sharing for enhanced safety and group coordination during outdoor activities. + +### 1.2 Intended Use + +The TrailMaster GPS Watch is intended for use by experienced outdoor enthusiasts, including hikers, backpackers, trail runners, and mountaineers. This device is designed to provide essential navigation information and location tracking in remote, off-grid environments. Users can rely on the TrailMaster GPS Watch to plan and execute their outdoor adventures with confidence, knowing they have access to accurate maps, location data, and real-time sharing capabilities. Although the TrailMaster GPS Watch is engineered for extreme durability, users should always exercise caution and take appropriate safety measures when engaging in outdoor activities. + +#### 1.2.1 Safety Precautions + +Before using the TrailMaster GPS Watch, users must ensure that the device is fully charged and properly calibrated according to the manufacturer's specifications. It is essential to familiarize oneself with the watch's features, controls, and navigation functions before venturing into remote outdoor areas. Users should also be aware of potential environmental hazards, such as extreme weather conditions, rugged terrain, and limited access to emergency services. Proper planning, preparation, and adherence to best practices for outdoor safety are critical when using the TrailMaster GPS Watch. + +## 2. Technical Specifications + +### 2.1 Hardware + +#### 2.1.1 Processor and Memory + +The TrailMaster GPS Watch is equipped with a high-performance ARM Cortex processor, ensuring fast and efficient operation for all your outdoor activities. The device also comes with 4GB of internal memory, providing ample storage for maps, routes, and waypoints. The processor operates at 1.2GHz, allowing for quick map rendering and location updates. + +#### 2.1.2 GPS Module + +The GPS module in the TrailMaster GPS Watch utilizes a state-of-the-art multi-constellation receiver, supporting GPS, GLONASS, and Galileo satellite systems. This enables precise location tracking and navigation, even in challenging outdoor environments. The module also features advanced signal processing algorithms, ensuring reliable performance in remote areas with limited satellite visibility. + +#### 2.1.3 Sensors + +Equipped with a comprehensive set of sensors, the TrailMaster GPS Watch offers an array of valuable data for outdoor enthusiasts. The built-in altimeter provides accurate altitude readings, while the barometer monitors changes in air pressure to forecast weather conditions. Additionally, the watch includes a digital compass for reliable orientation, ensuring a seamless navigation experience in the great outdoors. + +### 2.2 Software + +#### 2.2.1 Operating System + +The TrailMaster GPS Watch runs on a proprietary operating system optimized for outdoor navigation and tracking. This custom OS combines robustness and efficiency, allowing for seamless integration with the device's hardware and sensors. The interface is designed for intuitive interaction, enabling users to access maps, location sharing, and other features with ease, even in challenging outdoor conditions. + +#### 2.2.2 Map Data + +The TrailMaster GPS Watch comes preloaded with detailed topographic maps, providing comprehensive coverage of trails, terrain, and points of interest. These maps are stored locally on the device, ensuring rapid access and smooth navigation without relying on cellular or data network connectivity. Users can also import additional map data via the dedicated USB port, expanding the watch's mapping capabilities for customized adventures. + +## 3. Setup and Installation + +### 3.1 Charging + +Before using your TrailMaster GPS Watch for the first time, it is essential to ensure that the device is fully charged. To charge your GPS watch, follow these steps: + +1. Locate the charging port cover on the back of the watch. +2. Gently lift the cover to expose the charging port. +3. Connect the provided USB charging cable to the port, ensuring a secure connection. +4. Plug the other end of the cable into a power source, such as a computer or USB wall adapter. +5. Allow the watch to charge for at least 2 hours, or until the battery indicator on the display shows it is fully charged. + +For optimal performance, it is recommended to fully charge the device before each use and to avoid overcharging. Please refer to the TrailMaster GPS Watch technical specifications for detailed battery charging information. + +### 3.2 Initial Configuration + +Once your TrailMaster GPS Watch is fully charged, you can proceed with the initial configuration by following these steps: + +1. Press and hold the power button located on the side of the watch to turn it on. +2. Follow the on-screen instructions to select your language, set the date and time, and calibrate the GPS. +3. Connect the watch to your smartphone using the TrailMaster companion app to enable real-time location sharing and receive notifications. +4. Customize the watch settings, such as display preferences and map views, to suit your outdoor activities. + +Before using the GPS functionality, it is crucial to ensure that the watch has a clear view of the sky to acquire GPS signals. Please refer to the TrailMaster GPS Watch user guide for detailed instructions on GPS calibration and satellite acquisition. + +## 4. Operation + +### 4.1 Basic Functions + +The TrailMaster GPS Watch is designed for outdoor use and offers a variety of basic functions to assist users in navigating and staying connected during their adventures. + +#### 4.1.1 Powering On and Off + +To power on the TrailMaster GPS Watch, press and hold the power button (located on the right side of the watch) for 3 seconds. The watch will display the ExpeditionTech logo and then proceed to the main navigation screen. To power off the watch, press and hold the power button and select "Power Off" from the menu. + +#### 4.1.2 Accessing Built-in Maps + +The TrailMaster GPS Watch comes pre-loaded with detailed maps of various outdoor locations. To access the maps, press the map button (located on the left side of the watch) to bring up the map interface. From here, you can view your current location, set waypoints, and plan routes. + +#### 4.1.3 Real-time Location Sharing + +Utilize the real-time location sharing feature to transmit your current location to designated contacts. Press the share button (located on the top of the watch) and select the specific contacts you wish to share your location with. This feature requires a stable GPS signal and a connected smartphone with the TrailMaster app installed. + +### 4.2 Advanced Features + +The TrailMaster GPS Watch offers advanced features to enhance the user experience and provide additional functionality for outdoor enthusiasts. + +#### 4.2.1 Rugged Design + +The TrailMaster GPS Watch is built to withstand rugged outdoor conditions, including extreme temperatures, water exposure, and impact. The durable casing and reinforced strap ensure that the watch remains operational in challenging environments. + +#### 4.2.2 Navigation Tools + +In addition to basic map access, the TrailMaster GPS Watch includes advanced navigation tools such as compass, altimeter, and barometer. These tools provide vital information for navigation and weather monitoring while in the field. + +#### 4.2.3 Customizing Data Screens + +Users can customize the data screens on the TrailMaster GPS Watch to display the specific information they require during their outdoor activities. From the main menu, navigate to the settings and select "Data Screens" to adjust the layout and content of the screens. + +#### 4.2.4 Tracking Performance Metrics + +The TrailMaster GPS Watch is equipped with sensors to track performance metrics such as distance traveled, speed, elevation gain, and heart rate. Use the tracking mode to monitor these metrics in real-time or review them after completing an activity. + +## 5. Troubleshooting + +### 5.1 Diagnostic Tools and Equipment + +When troubleshooting the TrailMaster GPS Watch, it is essential to use specialized industrial diagnostic tools and equipment to perform accurate diagnostic tests. These tools and equipment include: + +- **GPS Signal Analyzer**: Use a GPS signal analyzer to check the strength and quality of the satellite signals received by the watch. +- **RF Spectrum Analyzer**: An RF spectrum analyzer is required to analyze the radio frequency spectrum and identify any interference affecting the GPS reception. +- **Ruggedness Test Equipment**: Perform ruggedness tests using shock and vibration equipment to ensure the watch can withstand outdoor adventures without performance issues. + +It is essential to use these specialized tools and equipment to accurately diagnose any issues with the TrailMaster GPS Watch and ensure optimal performance. + +### 5.2 Common Issues + +#### 5.2.1 GPS Signal Loss + +**Symptoms:** + +The watch displays "No GPS Signal" or intermittently loses GPS signal during use. + +**Potential Causes:** + +- Obstruction of satellite signals due to dense foliage, tall buildings, or natural terrain features. +- Radio frequency interference affecting GPS reception. +- Wear and tear on the GPS antenna or receiver. + +**Troubleshooting Steps:** + +1. Check the surroundings for any obstructions blocking satellite signals. +2. Use an RF spectrum analyzer to identify any potential sources of interference. +3. Perform a diagnostics test using a GPS signal analyzer to assess the strength and quality of the GPS signal received by the watch. +4. If the issue persists, contact ExpeditionTech customer support for further assistance. + +#### 5.2.2 Connectivity Issues + +**Symptoms:** + +- Inability to share real-time location or connect to other devices. +- Unreliable Bluetooth connectivity. + +**Potential Causes:** + +- Bluetooth interference from other electronic devices. +- Signal obstruction due to environmental factors. +- Software or firmware issues. + +**Troubleshooting Steps:** + +1. Ensure the watch is within the recommended Bluetooth range of the connected device. +2. Identify and eliminate potential sources of Bluetooth interference in the vicinity. +3. Update the watch's firmware to the latest version to address any software-related connectivity issues. +4. If connectivity problems persist, perform a comprehensive diagnostics test using a specialized Bluetooth signal analyzer. + +By following these troubleshooting steps and using specialized diagnostic tools and equipment, users can effectively identify and address common issues with the TrailMaster GPS Watch. + +## 6. Maintenance and Care + +### 6.1 Cleaning + +It is important to regularly clean your TrailMaster GPS Watch to ensure optimal performance. Use a soft, damp cloth to gently wipe the watch face and straps. Do not use harsh chemicals or solvents, as these may damage the watch's rugged design and built-in maps. + +### 6.2 Battery Maintenance + +The TrailMaster GPS Watch is equipped with a rechargeable lithium-ion battery. To optimize battery life, it is recommended to fully charge the watch before each outdoor adventure. Additionally, it is important to avoid exposing the watch to extreme temperatures, as this may affect battery performance. + +### 6.3 Storage + +When not in use, store your TrailMaster GPS Watch in a cool, dry place. Avoid prolonged exposure to direct sunlight or extreme temperatures, as this may cause damage to the device. + +### 6.4 Software Updates + +To ensure that your TrailMaster GPS Watch operates efficiently, it is important to regularly check for and install software updates. These updates may include improvements to the built-in maps, real-time location sharing, and overall performance of the watch. + +### 6.5 Technical Diagnostics + +For advanced maintenance and care, it is recommended to perform technical diagnostics using specialized industrial and scientific equipment. Refer to formal industry specification codes and standards bodies for detailed instructions on performing these diagnostics. + +## 7. Regulatory Compliance + +### 7.1 FCC Compliance + +The ExpeditionTech TrailMaster GPS Watch complies with Part 15 of the FCC rules. Operation is subject to the following two conditions: (1) this device may not cause harmful interference, and (2) this device must accept any interference received, including interference that may cause undesired operation. Any changes or modifications not expressly approved by the party responsible for compliance could void the user's authority to operate the equipment. The user is cautioned that any changes or modifications made to this device that are not expressly approved by the manufacturer could void the user's authority to operate the equipment. + +### 7.2 CE Marking + +The CE marking on the ExpeditionTech TrailMaster GPS Watch indicates that it complies with the essential requirements of the relevant European health, safety, and environmental protection legislation. The device is in conformity with the essential requirements and other relevant provisions of Directive 1999/5/EC. The CE marking is affixed to the device to demonstrate that it meets the essential requirements for safety, health, and environmental protection. The user should only use the device in accordance with the instructions provided in the user manual. diff --git a/test/ProjectTemplates/Microsoft.Extensions.AI.Templates.IntegrationTests/Snapshots/aichatweb.Ollama_Qdrant.verified/aichatweb/aichatweb.Web/wwwroot/Data/Example_GPS_Watch.pdf b/test/ProjectTemplates/Microsoft.Extensions.AI.Templates.IntegrationTests/Snapshots/aichatweb.Ollama_Qdrant.verified/aichatweb/aichatweb.Web/wwwroot/Data/Example_GPS_Watch.pdf deleted file mode 100644 index c87df644c58..00000000000 Binary files a/test/ProjectTemplates/Microsoft.Extensions.AI.Templates.IntegrationTests/Snapshots/aichatweb.Ollama_Qdrant.verified/aichatweb/aichatweb.Web/wwwroot/Data/Example_GPS_Watch.pdf and /dev/null differ diff --git a/test/ProjectTemplates/Microsoft.Extensions.AI.Templates.IntegrationTests/Snapshots/aichatweb.Ollama_Qdrant.verified/aichatweb/aichatweb.Web/wwwroot/lib/markdown_viewer/viewer.html b/test/ProjectTemplates/Microsoft.Extensions.AI.Templates.IntegrationTests/Snapshots/aichatweb.Ollama_Qdrant.verified/aichatweb/aichatweb.Web/wwwroot/lib/markdown_viewer/viewer.html new file mode 100644 index 00000000000..94447ffc47e --- /dev/null +++ b/test/ProjectTemplates/Microsoft.Extensions.AI.Templates.IntegrationTests/Snapshots/aichatweb.Ollama_Qdrant.verified/aichatweb/aichatweb.Web/wwwroot/lib/markdown_viewer/viewer.html @@ -0,0 +1,32 @@ + + + + + Markdown viewer + + + + +
+ + + diff --git a/test/ProjectTemplates/Microsoft.Extensions.AI.Templates.IntegrationTests/Snapshots/aichatweb.Ollama_Qdrant.verified/aichatweb/aichatweb.Web/wwwroot/lib/markdown_viewer/viewer.mjs b/test/ProjectTemplates/Microsoft.Extensions.AI.Templates.IntegrationTests/Snapshots/aichatweb.Ollama_Qdrant.verified/aichatweb/aichatweb.Web/wwwroot/lib/markdown_viewer/viewer.mjs new file mode 100644 index 00000000000..78eb819c9a8 --- /dev/null +++ b/test/ProjectTemplates/Microsoft.Extensions.AI.Templates.IntegrationTests/Snapshots/aichatweb.Ollama_Qdrant.verified/aichatweb/aichatweb.Web/wwwroot/lib/markdown_viewer/viewer.mjs @@ -0,0 +1,13 @@ +import { parse } from '../marked/dist/marked.esm.js'; +import purify from '../dompurify/dist/purify.es.mjs'; + +const url = new URL(window.location); +const fileUrl = url.searchParams.get('file'); +if (!fileUrl) { + throw new Error('File not specified in the URL query string'); +} + +var response = await fetch(fileUrl); +var text = await response.text(); + +document.getElementById('content').innerHTML = purify.sanitize(parse(text)); diff --git a/test/ProjectTemplates/Microsoft.Extensions.AI.Templates.IntegrationTests/Snapshots/aichatweb.OpenAI_AzureAISearch.verified/aichatweb/Components/Pages/Chat/Chat.razor b/test/ProjectTemplates/Microsoft.Extensions.AI.Templates.IntegrationTests/Snapshots/aichatweb.OpenAI_AzureAISearch.verified/aichatweb/Components/Pages/Chat/Chat.razor index 8aa0ec9fd28..6fc5881c18f 100644 --- a/test/ProjectTemplates/Microsoft.Extensions.AI.Templates.IntegrationTests/Snapshots/aichatweb.OpenAI_AzureAISearch.verified/aichatweb/Components/Pages/Chat/Chat.razor +++ b/test/ProjectTemplates/Microsoft.Extensions.AI.Templates.IntegrationTests/Snapshots/aichatweb.OpenAI_AzureAISearch.verified/aichatweb/Components/Pages/Chat/Chat.razor @@ -13,7 +13,7 @@
To get started, try asking about these example documents. You can replace these with your own data and replace this message.
- + @@ -29,10 +29,12 @@ Do not answer questions about anything else. Use only simple markdown to format your responses. - Use the search tool to find relevant information. When you do this, end your + Use the LoadDocuments tool to prepare for searches before answering any questions. + + Use the Search tool to find relevant information. When you do this, end your reply with citations in the special XML format: - exact quote here + exact quote here Always include the citation in your response if there are results. @@ -52,7 +54,10 @@ { statefulMessageCount = 0; messages.Add(new(ChatRole.System, SystemPrompt)); - chatOptions.Tools = [AIFunctionFactory.Create(SearchAsync)]; + chatOptions.Tools = [ + AIFunctionFactory.Create(LoadDocumentsAsync), + AIFunctionFactory.Create(SearchAsync) + ]; } private async Task AddUserMessageAsync(ChatMessage userMessage) @@ -106,7 +111,14 @@ await chatInput!.FocusAsync(); } - [Description("Searches for information using a phrase or keyword")] + [Description("Loads the documents needed for performing searches. Must be completed before a search can be executed, but only needs to be completed once.")] + private async Task LoadDocumentsAsync() + { + await InvokeAsync(StateHasChanged); + await Search.LoadDocumentsAsync(); + } + + [Description("Searches for information using a phrase or keyword. Relies on documents already being loaded.")] private async Task> SearchAsync( [Description("The phrase to search for.")] string searchPhrase, [Description("If possible, specify the filename to search that file only. If not provided or empty, the search includes all files.")] string? filenameFilter = null) @@ -114,7 +126,7 @@ await InvokeAsync(StateHasChanged); var results = await Search.SearchAsync(searchPhrase, filenameFilter, maxResults: 5); return results.Select(result => - $"{result.Text}"); + $"{result.Text}"); } public void Dispose() diff --git a/test/ProjectTemplates/Microsoft.Extensions.AI.Templates.IntegrationTests/Snapshots/aichatweb.OpenAI_AzureAISearch.verified/aichatweb/Components/Pages/Chat/ChatCitation.razor b/test/ProjectTemplates/Microsoft.Extensions.AI.Templates.IntegrationTests/Snapshots/aichatweb.OpenAI_AzureAISearch.verified/aichatweb/Components/Pages/Chat/ChatCitation.razor index ccb5853cec4..667189beabd 100644 --- a/test/ProjectTemplates/Microsoft.Extensions.AI.Templates.IntegrationTests/Snapshots/aichatweb.OpenAI_AzureAISearch.verified/aichatweb/Components/Pages/Chat/ChatCitation.razor +++ b/test/ProjectTemplates/Microsoft.Extensions.AI.Templates.IntegrationTests/Snapshots/aichatweb.OpenAI_AzureAISearch.verified/aichatweb/Components/Pages/Chat/ChatCitation.razor @@ -17,10 +17,7 @@ public required string File { get; set; } [Parameter] - public int? PageNumber { get; set; } - - [Parameter] - public required string Quote { get; set; } + public string? Quote { get; set; } private string? viewerUrl; @@ -28,11 +25,15 @@ { viewerUrl = null; - // If you ingest other types of content besides PDF files, construct a URL to an appropriate viewer here - if (File.EndsWith(".pdf")) + // If you ingest other types of content besides Markdown or PDF files, construct a URL to an appropriate viewer here + if (File.EndsWith(".md")) + { + viewerUrl = $"lib/markdown_viewer/viewer.html?file=/Data/{HttpUtility.UrlEncode(File)}#:~:text={Uri.EscapeDataString(Quote ?? "")}"; + } + else if (File.EndsWith(".pdf")) { var search = Quote?.Trim('.', ',', ' ', '\n', '\r', '\t', '"', '\''); - viewerUrl = $"lib/pdf_viewer/viewer.html?file=/Data/{HttpUtility.UrlEncode(File)}#page={PageNumber}&search={HttpUtility.UrlEncode(search)}&phrase=true"; + viewerUrl = $"lib/pdf_viewer/viewer.html?file=/Data/{HttpUtility.UrlEncode(File)}#search={HttpUtility.UrlEncode(search)}&phrase=true"; } } } diff --git a/test/ProjectTemplates/Microsoft.Extensions.AI.Templates.IntegrationTests/Snapshots/aichatweb.OpenAI_AzureAISearch.verified/aichatweb/Components/Pages/Chat/ChatMessageItem.razor b/test/ProjectTemplates/Microsoft.Extensions.AI.Templates.IntegrationTests/Snapshots/aichatweb.OpenAI_AzureAISearch.verified/aichatweb/Components/Pages/Chat/ChatMessageItem.razor index 92c20c70667..e45d92ab5f9 100644 --- a/test/ProjectTemplates/Microsoft.Extensions.AI.Templates.IntegrationTests/Snapshots/aichatweb.OpenAI_AzureAISearch.verified/aichatweb/Components/Pages/Chat/ChatMessageItem.razor +++ b/test/ProjectTemplates/Microsoft.Extensions.AI.Templates.IntegrationTests/Snapshots/aichatweb.OpenAI_AzureAISearch.verified/aichatweb/Components/Pages/Chat/ChatMessageItem.razor @@ -28,11 +28,24 @@ else if (Message.Role == ChatRole.Assistant) @foreach (var citation in citations ?? []) { - + }
} + else if (content is FunctionCallContent { Name: "LoadDocuments" }) + { +
+
+ + + +
+
+ Loading relevant documents (this will take a minute)... +
+
+ } else if (content is FunctionCallContent { Name: "Search" } fcc && fcc.Arguments?.TryGetValue("searchPhrase", out var searchPhrase) is true) {
@@ -56,9 +69,9 @@ else if (Message.Role == ChatRole.Assistant) @code { private static readonly ConditionalWeakTable SubscribersLookup = new(); - private static readonly Regex CitationRegex = new(@"(?.*?)", RegexOptions.NonBacktracking); + private static readonly Regex CitationRegex = new(@"(?.*?)", RegexOptions.NonBacktracking); - private List<(string File, int? Page, string Quote)>? citations; + private List<(string File, string Quote)>? citations; [Parameter, EditorRequired] public required ChatMessage Message { get; set; } @@ -88,7 +101,7 @@ else if (Message.Role == ChatRole.Assistant) { var matches = CitationRegex.Matches(text); citations = matches.Any() - ? matches.Select(m => (m.Groups["file"].Value, int.TryParse(m.Groups["page"].Value, out var page) ? page : (int?)null, m.Groups["quote"].Value)).ToList() + ? matches.Select(m => (m.Groups["file"].Value, m.Groups["quote"].Value)).ToList() : null; } } diff --git a/test/ProjectTemplates/Microsoft.Extensions.AI.Templates.IntegrationTests/Snapshots/aichatweb.OpenAI_AzureAISearch.verified/aichatweb/Program.cs b/test/ProjectTemplates/Microsoft.Extensions.AI.Templates.IntegrationTests/Snapshots/aichatweb.OpenAI_AzureAISearch.verified/aichatweb/Program.cs index 434e5662d6d..d7e25135462 100644 --- a/test/ProjectTemplates/Microsoft.Extensions.AI.Templates.IntegrationTests/Snapshots/aichatweb.OpenAI_AzureAISearch.verified/aichatweb/Program.cs +++ b/test/ProjectTemplates/Microsoft.Extensions.AI.Templates.IntegrationTests/Snapshots/aichatweb.OpenAI_AzureAISearch.verified/aichatweb/Program.cs @@ -30,11 +30,12 @@ var azureAISearchEndpoint = new Uri(builder.Configuration["AzureAISearch:Endpoint"] ?? throw new InvalidOperationException("Missing configuration: AzureAISearch:Endpoint. See the README for details.")); var azureAISearchCredential = new DefaultAzureCredential(); -builder.Services.AddAzureAISearchCollection("data-aichatweb-chunks", azureAISearchEndpoint, azureAISearchCredential); -builder.Services.AddAzureAISearchCollection("data-aichatweb-documents", azureAISearchEndpoint, azureAISearchCredential); +builder.Services.AddAzureAISearchVectorStore(azureAISearchEndpoint, azureAISearchCredential); +builder.Services.AddAzureAISearchCollection(IngestedChunk.CollectionName, azureAISearchEndpoint, azureAISearchCredential); -builder.Services.AddScoped(); +builder.Services.AddSingleton(); builder.Services.AddSingleton(); +builder.Services.AddKeyedSingleton("ingestion_directory", new DirectoryInfo(Path.Combine(builder.Environment.WebRootPath, "Data"))); builder.Services.AddChatClient(chatClient).UseFunctionInvocation().UseLogging(); builder.Services.AddEmbeddingGenerator(embeddingGenerator); @@ -55,12 +56,4 @@ app.MapRazorComponents() .AddInteractiveServerRenderMode(); -// By default, we ingest PDF files from the /wwwroot/Data directory. You can ingest from -// other sources by implementing IIngestionSource. -// Important: ensure that any content you ingest is trusted, as it may be reflected back -// to users or could be a source of prompt injection risk. -await DataIngestor.IngestDataAsync( - app.Services, - new PDFDirectorySource(Path.Combine(builder.Environment.WebRootPath, "Data"))); - app.Run(); diff --git a/test/ProjectTemplates/Microsoft.Extensions.AI.Templates.IntegrationTests/Snapshots/aichatweb.OpenAI_AzureAISearch.verified/aichatweb/Services/IngestedChunk.cs b/test/ProjectTemplates/Microsoft.Extensions.AI.Templates.IntegrationTests/Snapshots/aichatweb.OpenAI_AzureAISearch.verified/aichatweb/Services/IngestedChunk.cs index 46270588cde..348bb5d942f 100644 --- a/test/ProjectTemplates/Microsoft.Extensions.AI.Templates.IntegrationTests/Snapshots/aichatweb.OpenAI_AzureAISearch.verified/aichatweb/Services/IngestedChunk.cs +++ b/test/ProjectTemplates/Microsoft.Extensions.AI.Templates.IntegrationTests/Snapshots/aichatweb.OpenAI_AzureAISearch.verified/aichatweb/Services/IngestedChunk.cs @@ -1,24 +1,31 @@ -using Microsoft.Extensions.VectorData; +using System.Text.Json.Serialization; +using Microsoft.Extensions.VectorData; namespace aichatweb.Services; public class IngestedChunk { - private const int VectorDimensions = 1536; // 1536 is the default vector size for the OpenAI text-embedding-3-small model - private const string VectorDistanceFunction = DistanceFunction.CosineSimilarity; + public const int VectorDimensions = 1536; // 1536 is the default vector size for the OpenAI text-embedding-3-small model + public const string VectorDistanceFunction = DistanceFunction.CosineSimilarity; + public const string CollectionName = "data-aichatweb-chunks"; - [VectorStoreKey] - public required string Key { get; set; } + [VectorStoreKey(StorageName = "key")] + [JsonPropertyName("key")] + public required Guid Key { get; set; } - [VectorStoreData(IsIndexed = true)] + [VectorStoreData(StorageName = "documentid")] + [JsonPropertyName("documentid")] public required string DocumentId { get; set; } - [VectorStoreData] - public int PageNumber { get; set; } - - [VectorStoreData] + [VectorStoreData(StorageName = "content")] + [JsonPropertyName("content")] public required string Text { get; set; } - [VectorStoreVector(VectorDimensions, DistanceFunction = VectorDistanceFunction)] + [VectorStoreData(StorageName = "context")] + [JsonPropertyName("context")] + public string? Context { get; set; } + + [VectorStoreVector(VectorDimensions, DistanceFunction = VectorDistanceFunction, StorageName = "embedding")] + [JsonPropertyName("embedding")] public string? Vector => Text; } diff --git a/test/ProjectTemplates/Microsoft.Extensions.AI.Templates.IntegrationTests/Snapshots/aichatweb.OpenAI_AzureAISearch.verified/aichatweb/Services/IngestedDocument.cs b/test/ProjectTemplates/Microsoft.Extensions.AI.Templates.IntegrationTests/Snapshots/aichatweb.OpenAI_AzureAISearch.verified/aichatweb/Services/IngestedDocument.cs deleted file mode 100644 index 9b3da6058c9..00000000000 --- a/test/ProjectTemplates/Microsoft.Extensions.AI.Templates.IntegrationTests/Snapshots/aichatweb.OpenAI_AzureAISearch.verified/aichatweb/Services/IngestedDocument.cs +++ /dev/null @@ -1,25 +0,0 @@ -using Microsoft.Extensions.VectorData; - -namespace aichatweb.Services; - -public class IngestedDocument -{ - private const int VectorDimensions = 2; - private const string VectorDistanceFunction = DistanceFunction.CosineSimilarity; - - [VectorStoreKey] - public required string Key { get; set; } - - [VectorStoreData(IsIndexed = true)] - public required string SourceId { get; set; } - - [VectorStoreData] - public required string DocumentId { get; set; } - - [VectorStoreData] - public required string DocumentVersion { get; set; } - - // The vector is not used but required for some vector databases - [VectorStoreVector(VectorDimensions, DistanceFunction = VectorDistanceFunction)] - public ReadOnlyMemory Vector { get; set; } = new ReadOnlyMemory([0, 0]); -} diff --git a/test/ProjectTemplates/Microsoft.Extensions.AI.Templates.IntegrationTests/Snapshots/aichatweb.OpenAI_AzureAISearch.verified/aichatweb/Services/Ingestion/DataIngestor.cs b/test/ProjectTemplates/Microsoft.Extensions.AI.Templates.IntegrationTests/Snapshots/aichatweb.OpenAI_AzureAISearch.verified/aichatweb/Services/Ingestion/DataIngestor.cs index 89fe287ebed..d97b986b694 100644 --- a/test/ProjectTemplates/Microsoft.Extensions.AI.Templates.IntegrationTests/Snapshots/aichatweb.OpenAI_AzureAISearch.verified/aichatweb/Services/Ingestion/DataIngestor.cs +++ b/test/ProjectTemplates/Microsoft.Extensions.AI.Templates.IntegrationTests/Snapshots/aichatweb.OpenAI_AzureAISearch.verified/aichatweb/Services/Ingestion/DataIngestor.cs @@ -1,58 +1,35 @@ using Microsoft.Extensions.AI; +using Microsoft.Extensions.DataIngestion; +using Microsoft.Extensions.DataIngestion.Chunkers; using Microsoft.Extensions.VectorData; +using Microsoft.ML.Tokenizers; namespace aichatweb.Services.Ingestion; public class DataIngestor( ILogger logger, - VectorStoreCollection chunksCollection, - VectorStoreCollection documentsCollection) + ILoggerFactory loggerFactory, + VectorStore vectorStore, + IEmbeddingGenerator> embeddingGenerator) { - public static async Task IngestDataAsync(IServiceProvider services, IIngestionSource source) + public async Task IngestDataAsync(DirectoryInfo directory, string searchPattern) { - using var scope = services.CreateScope(); - var ingestor = scope.ServiceProvider.GetRequiredService(); - await ingestor.IngestDataAsync(source); - } - - public async Task IngestDataAsync(IIngestionSource source) - { - await chunksCollection.EnsureCollectionExistsAsync(); - await documentsCollection.EnsureCollectionExistsAsync(); - - var sourceId = source.SourceId; - var documentsForSource = await documentsCollection.GetAsync(doc => doc.SourceId == sourceId, top: int.MaxValue).ToListAsync(); - - var deletedDocuments = await source.GetDeletedDocumentsAsync(documentsForSource); - foreach (var deletedDocument in deletedDocuments) + using var writer = new VectorStoreWriter(vectorStore, dimensionCount: IngestedChunk.VectorDimensions, new() { - logger.LogInformation("Removing ingested data for {DocumentId}", deletedDocument.DocumentId); - await DeleteChunksForDocumentAsync(deletedDocument); - await documentsCollection.DeleteAsync(deletedDocument.Key); - } - - var modifiedDocuments = await source.GetNewOrModifiedDocumentsAsync(documentsForSource); - foreach (var modifiedDocument in modifiedDocuments) - { - logger.LogInformation("Processing {DocumentId}", modifiedDocument.DocumentId); - await DeleteChunksForDocumentAsync(modifiedDocument); - - await documentsCollection.UpsertAsync(modifiedDocument); - - var newRecords = await source.CreateChunksForDocumentAsync(modifiedDocument); - await chunksCollection.UpsertAsync(newRecords); - } - - logger.LogInformation("Ingestion is up-to-date"); - - async Task DeleteChunksForDocumentAsync(IngestedDocument document) + CollectionName = IngestedChunk.CollectionName, + DistanceFunction = IngestedChunk.VectorDistanceFunction, + IncrementalIngestion = false, + }); + + using var pipeline = new IngestionPipeline( + reader: new DocumentReader(directory), + chunker: new SemanticSimilarityChunker(embeddingGenerator, new(TiktokenTokenizer.CreateForModel("gpt-4o"))), + writer: writer, + loggerFactory: loggerFactory); + + await foreach (var result in pipeline.ProcessAsync(directory, searchPattern)) { - var documentId = document.DocumentId; - var chunksToDelete = await chunksCollection.GetAsync(record => record.DocumentId == documentId, int.MaxValue).ToListAsync(); - if (chunksToDelete.Count != 0) - { - await chunksCollection.DeleteAsync(chunksToDelete.Select(r => r.Key)); - } + logger.LogInformation("Completed processing '{id}'. Succeeded: '{succeeded}'.", result.DocumentId, result.Succeeded); } } } diff --git a/test/ProjectTemplates/Microsoft.Extensions.AI.Templates.IntegrationTests/Snapshots/aichatweb.OpenAI_AzureAISearch.verified/aichatweb/Services/Ingestion/DocumentReader.cs b/test/ProjectTemplates/Microsoft.Extensions.AI.Templates.IntegrationTests/Snapshots/aichatweb.OpenAI_AzureAISearch.verified/aichatweb/Services/Ingestion/DocumentReader.cs new file mode 100644 index 00000000000..315a6ad3d53 --- /dev/null +++ b/test/ProjectTemplates/Microsoft.Extensions.AI.Templates.IntegrationTests/Snapshots/aichatweb.OpenAI_AzureAISearch.verified/aichatweb/Services/Ingestion/DocumentReader.cs @@ -0,0 +1,36 @@ +using Microsoft.Extensions.DataIngestion; + +namespace aichatweb.Services.Ingestion; + +internal sealed class DocumentReader(DirectoryInfo rootDirectory) : IngestionDocumentReader +{ + private readonly MarkdownReader _markdownReader = new(); + private readonly PdfPigReader _pdfReader = new(); + + public override Task ReadAsync(FileInfo source, string identifier, string? mediaType = null, CancellationToken cancellationToken = default) + { + if (Path.IsPathFullyQualified(identifier)) + { + // Normalize the identifier to its relative path + identifier = Path.GetRelativePath(rootDirectory.FullName, identifier); + } + + mediaType = GetCustomMediaType(source) ?? mediaType; + return base.ReadAsync(source, identifier, mediaType, cancellationToken); + } + + public override Task ReadAsync(Stream source, string identifier, string mediaType, CancellationToken cancellationToken = default) + => mediaType switch + { + "application/pdf" => _pdfReader.ReadAsync(source, identifier, mediaType, cancellationToken), + "text/markdown" => _markdownReader.ReadAsync(source, identifier, mediaType, cancellationToken), + _ => throw new InvalidOperationException($"Unsupported media type '{mediaType}'"), + }; + + private static string? GetCustomMediaType(FileInfo source) + => source.Extension switch + { + ".md" => "text/markdown", + _ => null + }; +} diff --git a/test/ProjectTemplates/Microsoft.Extensions.AI.Templates.IntegrationTests/Snapshots/aichatweb.OpenAI_AzureAISearch.verified/aichatweb/Services/Ingestion/IIngestionSource.cs b/test/ProjectTemplates/Microsoft.Extensions.AI.Templates.IntegrationTests/Snapshots/aichatweb.OpenAI_AzureAISearch.verified/aichatweb/Services/Ingestion/IIngestionSource.cs deleted file mode 100644 index 540cac117e7..00000000000 --- a/test/ProjectTemplates/Microsoft.Extensions.AI.Templates.IntegrationTests/Snapshots/aichatweb.OpenAI_AzureAISearch.verified/aichatweb/Services/Ingestion/IIngestionSource.cs +++ /dev/null @@ -1,12 +0,0 @@ -namespace aichatweb.Services.Ingestion; - -public interface IIngestionSource -{ - string SourceId { get; } - - Task> GetNewOrModifiedDocumentsAsync(IReadOnlyList existingDocuments); - - Task> GetDeletedDocumentsAsync(IReadOnlyList existingDocuments); - - Task> CreateChunksForDocumentAsync(IngestedDocument document); -} diff --git a/test/ProjectTemplates/Microsoft.Extensions.AI.Templates.IntegrationTests/Snapshots/aichatweb.OpenAI_AzureAISearch.verified/aichatweb/Services/Ingestion/PDFDirectorySource.cs b/test/ProjectTemplates/Microsoft.Extensions.AI.Templates.IntegrationTests/Snapshots/aichatweb.OpenAI_AzureAISearch.verified/aichatweb/Services/Ingestion/PDFDirectorySource.cs deleted file mode 100644 index 0be02a9d008..00000000000 --- a/test/ProjectTemplates/Microsoft.Extensions.AI.Templates.IntegrationTests/Snapshots/aichatweb.OpenAI_AzureAISearch.verified/aichatweb/Services/Ingestion/PDFDirectorySource.cs +++ /dev/null @@ -1,71 +0,0 @@ -using Microsoft.SemanticKernel.Text; -using UglyToad.PdfPig; -using UglyToad.PdfPig.Content; -using UglyToad.PdfPig.DocumentLayoutAnalysis.PageSegmenter; -using UglyToad.PdfPig.DocumentLayoutAnalysis.WordExtractor; - -namespace aichatweb.Services.Ingestion; - -public class PDFDirectorySource(string sourceDirectory) : IIngestionSource -{ - public static string SourceFileId(string path) => Path.GetFileName(path); - public static string SourceFileVersion(string path) => File.GetLastWriteTimeUtc(path).ToString("o"); - - public string SourceId => $"{nameof(PDFDirectorySource)}:{sourceDirectory}"; - - public Task> GetNewOrModifiedDocumentsAsync(IReadOnlyList existingDocuments) - { - var results = new List(); - var sourceFiles = Directory.GetFiles(sourceDirectory, "*.pdf"); - var existingDocumentsById = existingDocuments.ToDictionary(d => d.DocumentId); - - foreach (var sourceFile in sourceFiles) - { - var sourceFileId = SourceFileId(sourceFile); - var sourceFileVersion = SourceFileVersion(sourceFile); - var existingDocumentVersion = existingDocumentsById.TryGetValue(sourceFileId, out var existingDocument) ? existingDocument.DocumentVersion : null; - if (existingDocumentVersion != sourceFileVersion) - { - results.Add(new() { Key = Guid.CreateVersion7().ToString(), SourceId = SourceId, DocumentId = sourceFileId, DocumentVersion = sourceFileVersion }); - } - } - - return Task.FromResult((IEnumerable)results); - } - - public Task> GetDeletedDocumentsAsync(IReadOnlyList existingDocuments) - { - var currentFiles = Directory.GetFiles(sourceDirectory, "*.pdf"); - var currentFileIds = currentFiles.ToLookup(SourceFileId); - var deletedDocuments = existingDocuments.Where(d => !currentFileIds.Contains(d.DocumentId)); - return Task.FromResult(deletedDocuments); - } - - public Task> CreateChunksForDocumentAsync(IngestedDocument document) - { - using var pdf = PdfDocument.Open(Path.Combine(sourceDirectory, document.DocumentId)); - var paragraphs = pdf.GetPages().SelectMany(GetPageParagraphs).ToList(); - - return Task.FromResult(paragraphs.Select(p => new IngestedChunk - { - Key = Guid.CreateVersion7().ToString(), - DocumentId = document.DocumentId, - PageNumber = p.PageNumber, - Text = p.Text, - })); - } - - private static IEnumerable<(int PageNumber, int IndexOnPage, string Text)> GetPageParagraphs(Page pdfPage) - { - var letters = pdfPage.Letters; - var words = NearestNeighbourWordExtractor.Instance.GetWords(letters); - var textBlocks = DocstrumBoundingBoxes.Instance.GetBlocks(words); - var pageText = string.Join(Environment.NewLine + Environment.NewLine, - textBlocks.Select(t => t.Text.ReplaceLineEndings(" "))); - -#pragma warning disable SKEXP0050 // Type is for evaluation purposes only - return TextChunker.SplitPlainTextParagraphs([pageText], 200) - .Select((text, index) => (pdfPage.Number, index, text)); -#pragma warning restore SKEXP0050 // Type is for evaluation purposes only - } -} diff --git a/test/ProjectTemplates/Microsoft.Extensions.AI.Templates.IntegrationTests/Snapshots/aichatweb.OpenAI_AzureAISearch.verified/aichatweb/Services/Ingestion/PdfPigReader.cs b/test/ProjectTemplates/Microsoft.Extensions.AI.Templates.IntegrationTests/Snapshots/aichatweb.OpenAI_AzureAISearch.verified/aichatweb/Services/Ingestion/PdfPigReader.cs new file mode 100644 index 00000000000..f6de539eb22 --- /dev/null +++ b/test/ProjectTemplates/Microsoft.Extensions.AI.Templates.IntegrationTests/Snapshots/aichatweb.OpenAI_AzureAISearch.verified/aichatweb/Services/Ingestion/PdfPigReader.cs @@ -0,0 +1,42 @@ +using Microsoft.Extensions.DataIngestion; +using UglyToad.PdfPig; +using UglyToad.PdfPig.Content; +using UglyToad.PdfPig.DocumentLayoutAnalysis.PageSegmenter; +using UglyToad.PdfPig.DocumentLayoutAnalysis.WordExtractor; + +namespace aichatweb.Services.Ingestion; + +internal sealed class PdfPigReader : IngestionDocumentReader +{ + public override Task ReadAsync(Stream source, string identifier, string mediaType, CancellationToken cancellationToken = default) + { + using var pdf = PdfDocument.Open(source); + var document = new IngestionDocument(identifier); + foreach (var page in pdf.GetPages()) + { + document.Sections.Add(GetPageSection(page)); + } + return Task.FromResult(document); + } + + private static IngestionDocumentSection GetPageSection(Page pdfPage) + { + var section = new IngestionDocumentSection + { + PageNumber = pdfPage.Number, + }; + + var letters = pdfPage.Letters; + var words = NearestNeighbourWordExtractor.Instance.GetWords(letters); + + foreach (var textBlock in DocstrumBoundingBoxes.Instance.GetBlocks(words)) + { + section.Elements.Add(new IngestionDocumentParagraph(textBlock.Text) + { + Text = textBlock.Text + }); + } + + return section; + } +} diff --git a/test/ProjectTemplates/Microsoft.Extensions.AI.Templates.IntegrationTests/Snapshots/aichatweb.OpenAI_AzureAISearch.verified/aichatweb/Services/SemanticSearch.cs b/test/ProjectTemplates/Microsoft.Extensions.AI.Templates.IntegrationTests/Snapshots/aichatweb.OpenAI_AzureAISearch.verified/aichatweb/Services/SemanticSearch.cs index 291c6c4b4a9..8072f8bcddb 100644 --- a/test/ProjectTemplates/Microsoft.Extensions.AI.Templates.IntegrationTests/Snapshots/aichatweb.OpenAI_AzureAISearch.verified/aichatweb/Services/SemanticSearch.cs +++ b/test/ProjectTemplates/Microsoft.Extensions.AI.Templates.IntegrationTests/Snapshots/aichatweb.OpenAI_AzureAISearch.verified/aichatweb/Services/SemanticSearch.cs @@ -1,12 +1,22 @@ -using Microsoft.Extensions.VectorData; +using aichatweb.Services.Ingestion; +using Microsoft.Extensions.VectorData; namespace aichatweb.Services; public class SemanticSearch( - VectorStoreCollection vectorCollection) + VectorStoreCollection vectorCollection, + [FromKeyedServices("ingestion_directory")] DirectoryInfo ingestionDirectory, + DataIngestor dataIngestor) { + private Task? _ingestionTask; + + public async Task LoadDocumentsAsync() => await ( _ingestionTask ??= dataIngestor.IngestDataAsync(ingestionDirectory, searchPattern: "*.*")); + public async Task> SearchAsync(string text, string? documentIdFilter, int maxResults) { + // Ensure documents have been loaded before searching + await LoadDocumentsAsync(); + var nearest = vectorCollection.SearchAsync(text, maxResults, new VectorSearchOptions { Filter = documentIdFilter is { Length: > 0 } ? record => record.DocumentId == documentIdFilter : null, diff --git a/test/ProjectTemplates/Microsoft.Extensions.AI.Templates.IntegrationTests/Snapshots/aichatweb.OpenAI_AzureAISearch.verified/aichatweb/aichatweb.csproj b/test/ProjectTemplates/Microsoft.Extensions.AI.Templates.IntegrationTests/Snapshots/aichatweb.OpenAI_AzureAISearch.verified/aichatweb/aichatweb.csproj index da39bf3a4b0..c10763be0ea 100644 --- a/test/ProjectTemplates/Microsoft.Extensions.AI.Templates.IntegrationTests/Snapshots/aichatweb.OpenAI_AzureAISearch.verified/aichatweb/aichatweb.csproj +++ b/test/ProjectTemplates/Microsoft.Extensions.AI.Templates.IntegrationTests/Snapshots/aichatweb.OpenAI_AzureAISearch.verified/aichatweb/aichatweb.csproj @@ -1,7 +1,7 @@  - net9.0 + net10.0 enable enable secret @@ -11,11 +11,13 @@ - + + - + + - + diff --git a/test/ProjectTemplates/Microsoft.Extensions.AI.Templates.IntegrationTests/Snapshots/aichatweb.OpenAI_AzureAISearch.verified/aichatweb/wwwroot/Data/Example_GPS_Watch.md b/test/ProjectTemplates/Microsoft.Extensions.AI.Templates.IntegrationTests/Snapshots/aichatweb.OpenAI_AzureAISearch.verified/aichatweb/wwwroot/Data/Example_GPS_Watch.md new file mode 100644 index 00000000000..f7d042edf83 --- /dev/null +++ b/test/ProjectTemplates/Microsoft.Extensions.AI.Templates.IntegrationTests/Snapshots/aichatweb.OpenAI_AzureAISearch.verified/aichatweb/wwwroot/Data/Example_GPS_Watch.md @@ -0,0 +1,193 @@ +# TrailMaster GPS Watch + +## 1. Introduction + +ExpeditionTech is proud to introduce the TrailMaster GPS Watch, a state-of-the-art outdoor electronics device designed for the most demanding outdoor adventurers. This watch is meticulously engineered to provide accurate location information, real-time sharing, and reliable mapping capabilities. The TrailMaster GPS Watch is built to withstand the harshest environmental conditions while providing users with the critical data they need to navigate through challenging terrain and optimize their outdoor experiences. + +### 1.1 Product Overview + +The TrailMaster GPS Watch is a high-performance outdoor electronics device that combines advanced GPS technology with rugged design. It features a durable, shock-resistant casing, a high-contrast display for optimal visibility in bright sunlight, and a built-in rechargeable battery for extended use in remote areas. The TrailMaster GPS Watch is equipped with a comprehensive suite of navigation tools, including topographic maps, trail tracking, and waypoint management. Additionally, it offers real-time location sharing for enhanced safety and group coordination during outdoor activities. + +### 1.2 Intended Use + +The TrailMaster GPS Watch is intended for use by experienced outdoor enthusiasts, including hikers, backpackers, trail runners, and mountaineers. This device is designed to provide essential navigation information and location tracking in remote, off-grid environments. Users can rely on the TrailMaster GPS Watch to plan and execute their outdoor adventures with confidence, knowing they have access to accurate maps, location data, and real-time sharing capabilities. Although the TrailMaster GPS Watch is engineered for extreme durability, users should always exercise caution and take appropriate safety measures when engaging in outdoor activities. + +#### 1.2.1 Safety Precautions + +Before using the TrailMaster GPS Watch, users must ensure that the device is fully charged and properly calibrated according to the manufacturer's specifications. It is essential to familiarize oneself with the watch's features, controls, and navigation functions before venturing into remote outdoor areas. Users should also be aware of potential environmental hazards, such as extreme weather conditions, rugged terrain, and limited access to emergency services. Proper planning, preparation, and adherence to best practices for outdoor safety are critical when using the TrailMaster GPS Watch. + +## 2. Technical Specifications + +### 2.1 Hardware + +#### 2.1.1 Processor and Memory + +The TrailMaster GPS Watch is equipped with a high-performance ARM Cortex processor, ensuring fast and efficient operation for all your outdoor activities. The device also comes with 4GB of internal memory, providing ample storage for maps, routes, and waypoints. The processor operates at 1.2GHz, allowing for quick map rendering and location updates. + +#### 2.1.2 GPS Module + +The GPS module in the TrailMaster GPS Watch utilizes a state-of-the-art multi-constellation receiver, supporting GPS, GLONASS, and Galileo satellite systems. This enables precise location tracking and navigation, even in challenging outdoor environments. The module also features advanced signal processing algorithms, ensuring reliable performance in remote areas with limited satellite visibility. + +#### 2.1.3 Sensors + +Equipped with a comprehensive set of sensors, the TrailMaster GPS Watch offers an array of valuable data for outdoor enthusiasts. The built-in altimeter provides accurate altitude readings, while the barometer monitors changes in air pressure to forecast weather conditions. Additionally, the watch includes a digital compass for reliable orientation, ensuring a seamless navigation experience in the great outdoors. + +### 2.2 Software + +#### 2.2.1 Operating System + +The TrailMaster GPS Watch runs on a proprietary operating system optimized for outdoor navigation and tracking. This custom OS combines robustness and efficiency, allowing for seamless integration with the device's hardware and sensors. The interface is designed for intuitive interaction, enabling users to access maps, location sharing, and other features with ease, even in challenging outdoor conditions. + +#### 2.2.2 Map Data + +The TrailMaster GPS Watch comes preloaded with detailed topographic maps, providing comprehensive coverage of trails, terrain, and points of interest. These maps are stored locally on the device, ensuring rapid access and smooth navigation without relying on cellular or data network connectivity. Users can also import additional map data via the dedicated USB port, expanding the watch's mapping capabilities for customized adventures. + +## 3. Setup and Installation + +### 3.1 Charging + +Before using your TrailMaster GPS Watch for the first time, it is essential to ensure that the device is fully charged. To charge your GPS watch, follow these steps: + +1. Locate the charging port cover on the back of the watch. +2. Gently lift the cover to expose the charging port. +3. Connect the provided USB charging cable to the port, ensuring a secure connection. +4. Plug the other end of the cable into a power source, such as a computer or USB wall adapter. +5. Allow the watch to charge for at least 2 hours, or until the battery indicator on the display shows it is fully charged. + +For optimal performance, it is recommended to fully charge the device before each use and to avoid overcharging. Please refer to the TrailMaster GPS Watch technical specifications for detailed battery charging information. + +### 3.2 Initial Configuration + +Once your TrailMaster GPS Watch is fully charged, you can proceed with the initial configuration by following these steps: + +1. Press and hold the power button located on the side of the watch to turn it on. +2. Follow the on-screen instructions to select your language, set the date and time, and calibrate the GPS. +3. Connect the watch to your smartphone using the TrailMaster companion app to enable real-time location sharing and receive notifications. +4. Customize the watch settings, such as display preferences and map views, to suit your outdoor activities. + +Before using the GPS functionality, it is crucial to ensure that the watch has a clear view of the sky to acquire GPS signals. Please refer to the TrailMaster GPS Watch user guide for detailed instructions on GPS calibration and satellite acquisition. + +## 4. Operation + +### 4.1 Basic Functions + +The TrailMaster GPS Watch is designed for outdoor use and offers a variety of basic functions to assist users in navigating and staying connected during their adventures. + +#### 4.1.1 Powering On and Off + +To power on the TrailMaster GPS Watch, press and hold the power button (located on the right side of the watch) for 3 seconds. The watch will display the ExpeditionTech logo and then proceed to the main navigation screen. To power off the watch, press and hold the power button and select "Power Off" from the menu. + +#### 4.1.2 Accessing Built-in Maps + +The TrailMaster GPS Watch comes pre-loaded with detailed maps of various outdoor locations. To access the maps, press the map button (located on the left side of the watch) to bring up the map interface. From here, you can view your current location, set waypoints, and plan routes. + +#### 4.1.3 Real-time Location Sharing + +Utilize the real-time location sharing feature to transmit your current location to designated contacts. Press the share button (located on the top of the watch) and select the specific contacts you wish to share your location with. This feature requires a stable GPS signal and a connected smartphone with the TrailMaster app installed. + +### 4.2 Advanced Features + +The TrailMaster GPS Watch offers advanced features to enhance the user experience and provide additional functionality for outdoor enthusiasts. + +#### 4.2.1 Rugged Design + +The TrailMaster GPS Watch is built to withstand rugged outdoor conditions, including extreme temperatures, water exposure, and impact. The durable casing and reinforced strap ensure that the watch remains operational in challenging environments. + +#### 4.2.2 Navigation Tools + +In addition to basic map access, the TrailMaster GPS Watch includes advanced navigation tools such as compass, altimeter, and barometer. These tools provide vital information for navigation and weather monitoring while in the field. + +#### 4.2.3 Customizing Data Screens + +Users can customize the data screens on the TrailMaster GPS Watch to display the specific information they require during their outdoor activities. From the main menu, navigate to the settings and select "Data Screens" to adjust the layout and content of the screens. + +#### 4.2.4 Tracking Performance Metrics + +The TrailMaster GPS Watch is equipped with sensors to track performance metrics such as distance traveled, speed, elevation gain, and heart rate. Use the tracking mode to monitor these metrics in real-time or review them after completing an activity. + +## 5. Troubleshooting + +### 5.1 Diagnostic Tools and Equipment + +When troubleshooting the TrailMaster GPS Watch, it is essential to use specialized industrial diagnostic tools and equipment to perform accurate diagnostic tests. These tools and equipment include: + +- **GPS Signal Analyzer**: Use a GPS signal analyzer to check the strength and quality of the satellite signals received by the watch. +- **RF Spectrum Analyzer**: An RF spectrum analyzer is required to analyze the radio frequency spectrum and identify any interference affecting the GPS reception. +- **Ruggedness Test Equipment**: Perform ruggedness tests using shock and vibration equipment to ensure the watch can withstand outdoor adventures without performance issues. + +It is essential to use these specialized tools and equipment to accurately diagnose any issues with the TrailMaster GPS Watch and ensure optimal performance. + +### 5.2 Common Issues + +#### 5.2.1 GPS Signal Loss + +**Symptoms:** + +The watch displays "No GPS Signal" or intermittently loses GPS signal during use. + +**Potential Causes:** + +- Obstruction of satellite signals due to dense foliage, tall buildings, or natural terrain features. +- Radio frequency interference affecting GPS reception. +- Wear and tear on the GPS antenna or receiver. + +**Troubleshooting Steps:** + +1. Check the surroundings for any obstructions blocking satellite signals. +2. Use an RF spectrum analyzer to identify any potential sources of interference. +3. Perform a diagnostics test using a GPS signal analyzer to assess the strength and quality of the GPS signal received by the watch. +4. If the issue persists, contact ExpeditionTech customer support for further assistance. + +#### 5.2.2 Connectivity Issues + +**Symptoms:** + +- Inability to share real-time location or connect to other devices. +- Unreliable Bluetooth connectivity. + +**Potential Causes:** + +- Bluetooth interference from other electronic devices. +- Signal obstruction due to environmental factors. +- Software or firmware issues. + +**Troubleshooting Steps:** + +1. Ensure the watch is within the recommended Bluetooth range of the connected device. +2. Identify and eliminate potential sources of Bluetooth interference in the vicinity. +3. Update the watch's firmware to the latest version to address any software-related connectivity issues. +4. If connectivity problems persist, perform a comprehensive diagnostics test using a specialized Bluetooth signal analyzer. + +By following these troubleshooting steps and using specialized diagnostic tools and equipment, users can effectively identify and address common issues with the TrailMaster GPS Watch. + +## 6. Maintenance and Care + +### 6.1 Cleaning + +It is important to regularly clean your TrailMaster GPS Watch to ensure optimal performance. Use a soft, damp cloth to gently wipe the watch face and straps. Do not use harsh chemicals or solvents, as these may damage the watch's rugged design and built-in maps. + +### 6.2 Battery Maintenance + +The TrailMaster GPS Watch is equipped with a rechargeable lithium-ion battery. To optimize battery life, it is recommended to fully charge the watch before each outdoor adventure. Additionally, it is important to avoid exposing the watch to extreme temperatures, as this may affect battery performance. + +### 6.3 Storage + +When not in use, store your TrailMaster GPS Watch in a cool, dry place. Avoid prolonged exposure to direct sunlight or extreme temperatures, as this may cause damage to the device. + +### 6.4 Software Updates + +To ensure that your TrailMaster GPS Watch operates efficiently, it is important to regularly check for and install software updates. These updates may include improvements to the built-in maps, real-time location sharing, and overall performance of the watch. + +### 6.5 Technical Diagnostics + +For advanced maintenance and care, it is recommended to perform technical diagnostics using specialized industrial and scientific equipment. Refer to formal industry specification codes and standards bodies for detailed instructions on performing these diagnostics. + +## 7. Regulatory Compliance + +### 7.1 FCC Compliance + +The ExpeditionTech TrailMaster GPS Watch complies with Part 15 of the FCC rules. Operation is subject to the following two conditions: (1) this device may not cause harmful interference, and (2) this device must accept any interference received, including interference that may cause undesired operation. Any changes or modifications not expressly approved by the party responsible for compliance could void the user's authority to operate the equipment. The user is cautioned that any changes or modifications made to this device that are not expressly approved by the manufacturer could void the user's authority to operate the equipment. + +### 7.2 CE Marking + +The CE marking on the ExpeditionTech TrailMaster GPS Watch indicates that it complies with the essential requirements of the relevant European health, safety, and environmental protection legislation. The device is in conformity with the essential requirements and other relevant provisions of Directive 1999/5/EC. The CE marking is affixed to the device to demonstrate that it meets the essential requirements for safety, health, and environmental protection. The user should only use the device in accordance with the instructions provided in the user manual. diff --git a/test/ProjectTemplates/Microsoft.Extensions.AI.Templates.IntegrationTests/Snapshots/aichatweb.OpenAI_AzureAISearch.verified/aichatweb/wwwroot/Data/Example_GPS_Watch.pdf b/test/ProjectTemplates/Microsoft.Extensions.AI.Templates.IntegrationTests/Snapshots/aichatweb.OpenAI_AzureAISearch.verified/aichatweb/wwwroot/Data/Example_GPS_Watch.pdf deleted file mode 100644 index c87df644c58..00000000000 Binary files a/test/ProjectTemplates/Microsoft.Extensions.AI.Templates.IntegrationTests/Snapshots/aichatweb.OpenAI_AzureAISearch.verified/aichatweb/wwwroot/Data/Example_GPS_Watch.pdf and /dev/null differ diff --git a/test/ProjectTemplates/Microsoft.Extensions.AI.Templates.IntegrationTests/Snapshots/aichatweb.OpenAI_AzureAISearch.verified/aichatweb/wwwroot/lib/markdown_viewer/viewer.html b/test/ProjectTemplates/Microsoft.Extensions.AI.Templates.IntegrationTests/Snapshots/aichatweb.OpenAI_AzureAISearch.verified/aichatweb/wwwroot/lib/markdown_viewer/viewer.html new file mode 100644 index 00000000000..94447ffc47e --- /dev/null +++ b/test/ProjectTemplates/Microsoft.Extensions.AI.Templates.IntegrationTests/Snapshots/aichatweb.OpenAI_AzureAISearch.verified/aichatweb/wwwroot/lib/markdown_viewer/viewer.html @@ -0,0 +1,32 @@ + + + + + Markdown viewer + + + + +
+ + + diff --git a/test/ProjectTemplates/Microsoft.Extensions.AI.Templates.IntegrationTests/Snapshots/aichatweb.OpenAI_AzureAISearch.verified/aichatweb/wwwroot/lib/markdown_viewer/viewer.mjs b/test/ProjectTemplates/Microsoft.Extensions.AI.Templates.IntegrationTests/Snapshots/aichatweb.OpenAI_AzureAISearch.verified/aichatweb/wwwroot/lib/markdown_viewer/viewer.mjs new file mode 100644 index 00000000000..78eb819c9a8 --- /dev/null +++ b/test/ProjectTemplates/Microsoft.Extensions.AI.Templates.IntegrationTests/Snapshots/aichatweb.OpenAI_AzureAISearch.verified/aichatweb/wwwroot/lib/markdown_viewer/viewer.mjs @@ -0,0 +1,13 @@ +import { parse } from '../marked/dist/marked.esm.js'; +import purify from '../dompurify/dist/purify.es.mjs'; + +const url = new URL(window.location); +const fileUrl = url.searchParams.get('file'); +if (!fileUrl) { + throw new Error('File not specified in the URL query string'); +} + +var response = await fetch(fileUrl); +var text = await response.text(); + +document.getElementById('content').innerHTML = purify.sanitize(parse(text)); diff --git a/test/ProjectTemplates/Microsoft.Extensions.AI.Templates.IntegrationTests/Snapshots/mcpserver.AotTrue.verified/mcpserver/mcpserver.csproj b/test/ProjectTemplates/Microsoft.Extensions.AI.Templates.IntegrationTests/Snapshots/mcpserver.AotTrue.verified/mcpserver/mcpserver.csproj index 1b2dd939947..5325611c198 100644 --- a/test/ProjectTemplates/Microsoft.Extensions.AI.Templates.IntegrationTests/Snapshots/mcpserver.AotTrue.verified/mcpserver/mcpserver.csproj +++ b/test/ProjectTemplates/Microsoft.Extensions.AI.Templates.IntegrationTests/Snapshots/mcpserver.AotTrue.verified/mcpserver/mcpserver.csproj @@ -1,7 +1,7 @@  - net9.0 + net10.0 win-x64;win-arm64;osx-arm64;linux-x64;linux-arm64;linux-musl-x64 Exe enable diff --git a/test/ProjectTemplates/Microsoft.Extensions.AI.Templates.IntegrationTests/Snapshots/mcpserver.Basic.verified/mcpserver/mcpserver.csproj b/test/ProjectTemplates/Microsoft.Extensions.AI.Templates.IntegrationTests/Snapshots/mcpserver.Basic.verified/mcpserver/mcpserver.csproj index f6da2d9485e..393d0558d5e 100644 --- a/test/ProjectTemplates/Microsoft.Extensions.AI.Templates.IntegrationTests/Snapshots/mcpserver.Basic.verified/mcpserver/mcpserver.csproj +++ b/test/ProjectTemplates/Microsoft.Extensions.AI.Templates.IntegrationTests/Snapshots/mcpserver.Basic.verified/mcpserver/mcpserver.csproj @@ -1,7 +1,7 @@  - net9.0 + net10.0 win-x64;win-arm64;osx-arm64;linux-x64;linux-arm64;linux-musl-x64 Exe enable diff --git a/test/ProjectTemplates/Microsoft.Extensions.AI.Templates.IntegrationTests/Snapshots/mcpserver.SelfContainedFalse.verified/mcpserver/mcpserver.csproj b/test/ProjectTemplates/Microsoft.Extensions.AI.Templates.IntegrationTests/Snapshots/mcpserver.SelfContainedFalse.verified/mcpserver/mcpserver.csproj index a25caa73486..21b79a59f81 100644 --- a/test/ProjectTemplates/Microsoft.Extensions.AI.Templates.IntegrationTests/Snapshots/mcpserver.SelfContainedFalse.verified/mcpserver/mcpserver.csproj +++ b/test/ProjectTemplates/Microsoft.Extensions.AI.Templates.IntegrationTests/Snapshots/mcpserver.SelfContainedFalse.verified/mcpserver/mcpserver.csproj @@ -1,7 +1,7 @@  - net9.0 + net10.0 Major Exe enable