This project is an AI chat application that demonstrates how to chat with custom data using an AI language model. Please note that this template is currently in an early preview stage. If you have feedback, please take a brief survey.
Note
Before running this project you need to configure the API keys or endpoints for the providers you have chosen. See below for details specific to your choices.
A recent incompatibility was found between Ollama and Docker Desktop. This issue results in runtime errors when connecting to Ollama, and the workaround for that can lead to Docker not working for Aspire projects.
This incompatibility can be addressed by upgrading to Docker Desktop 4.41.1. See ollama/ollama#9509 for more information and a link to install the version of Docker Desktop with the fix.
To call the OpenAI REST API, you will need an API key. To obtain one, first create a new OpenAI account or log in. Next, navigate to the API key page and select "Create new secret key", optionally naming the key. Make sure to save your API key somewhere safe and do not share it with anyone.
From the command line, configure your API key for this project using .NET User Secrets by running the following commands:
cd imageGeneratorSample.AppHost
dotnet user-secrets set ConnectionStrings:openai "Key=YOUR-API-KEY"- Open the
.slnfile in Visual Studio. - Press
Ctrl+F5or click the "Start" button in the toolbar to run the project.
- Open the project folder in Visual Studio Code.
- Install the C# Dev Kit extension for Visual Studio Code.
- Once installed, Open the
Program.csfile in the imageGeneratorSample.AppHost project. - Run the project by clicking the "Run" button in the Debug view.
Several .NET Aspire templates include ASP.NET Core projects that are configured to use HTTPS by default. If this is the first time you're running the project, an exception might occur when loading the Aspire dashboard. This error can be resolved by trusting the self-signed development certificate with the .NET CLI.
See Troubleshoot untrusted localhost certificate in .NET Aspire for more information.
This template leverages JavaScript libraries to provide essential functionality. These libraries are located in the wwwroot/lib folder of the imageGeneratorSample.Web project. For instructions on updating each dependency, please refer to the README.md file in each respective folder.
To learn more about development with .NET and AI, check out the following links: