|
| 1 | +--- |
| 2 | +title: Unified AI building blocks for .NET |
| 3 | +description: Learn how to develop with unified AI building blocks for .NET using Microsoft.Extensions.AI and Microsoft.Extensions.AI.Abstractions libraries |
| 4 | +ms.date: 11/04/2024 |
| 5 | +ms.topic: quickstart |
| 6 | +ms.custom: devx-track-dotnet, devx-track-dotnet-ai |
| 7 | +author: alexwolfmsft |
| 8 | +ms.author: alexwolf |
| 9 | +--- |
| 10 | + |
| 11 | +# Unified AI building blocks for .NET using Microsoft.Extensions.AI |
| 12 | + |
| 13 | +The .NET ecosystem provides abstractions for integrating AI services into .NET applications and libraries using the [`Microsoft.Extensions.AI`](https://www.nuget.org/packages/Microsoft.Extensions.AI) and [`Microsoft.Extensions.AI.Abstractions`](https://www.nuget.org/packages/Microsoft.Extensions.AI.Abstractions) libraries. The .NET team also enhanced the core `Microsoft.Extensions.*` libraries with these abstractions for .NET Generative AI applications and libraries. In the sections ahead, you learn: |
| 14 | + |
| 15 | +- Core concepts and capabilities of the `Microsoft.Extensions.AI` libraries. |
| 16 | +- How to work with AI abstractions in your apps and the benefits they offer. |
| 17 | +- Essential AI middleware concepts. |
| 18 | + |
| 19 | +## What is the Microsoft.Extensions.AI library? |
| 20 | + |
| 21 | +`Microsoft.Extensions.AI` is a set of core .NET libraries created in collaboration with developers across the .NET ecosystem, including Semantic Kernel. These libraries provide a unified layer of C# abstractions for interacting with AI services, such as small and large language models (SLMs and LLMs), embeddings, and middleware. |
| 22 | + |
| 23 | +:::image type="content" source="media/ai-extensions/meai-architecture-diagram.png" alt-text="An architectural diagram of the AI extensions libraries."::: |
| 24 | + |
| 25 | +`Microsoft.Extensions.AI` provides abstractions that can be implemented by various services, all adhering to the same core concepts. This library is not intended to provide APIs tailored to any specific provider's services. The goal of `Microsoft.Extensions.AI` is to act as a unifying layer within the .NET ecosystem, enabling developers to choose their preferred frameworks and libraries while ensuring seamless integration and collaboration across the ecosystem. |
| 26 | + |
| 27 | +## Work with abstractions for common AI services |
| 28 | + |
| 29 | +AI capabilities are rapidly evolving, with patterns emerging for common functionality: |
| 30 | + |
| 31 | +- Chat features to conversationally prompt an AI for information or data analysis. |
| 32 | +- Embedding generation to integrate with vector search capabilities. |
| 33 | +- Tool calling to integrate with other services, platforms, or code. |
| 34 | + |
| 35 | +The `Microsoft.Extensions.AI` library provides abstractions for these types of tasks, so developers can focus on coding against conceptual AI capabilities rather than specific platforms or provider implementations. Unified abstractions are crucial for developers to work effectively across different sources. |
| 36 | + |
| 37 | +For example, the `IChatClient` interface allows consumption of language models from various providers, whether you're connecting to an Azure OpenAI service or running a local Ollama installation. Any .NET package that provides an AI client can implement the `IChatClient` interface, enabling seamless integration with consuming .NET code: |
| 38 | + |
| 39 | +```csharp |
| 40 | +IChatClient client = |
| 41 | + environment.IsDevelopment ? |
| 42 | + new OllamaChatClient(...) : |
| 43 | + new AzureAIInferenceChatClient(...); |
| 44 | +``` |
| 45 | + |
| 46 | +Then, regardless of the provider you're using, you can send requests as follows: |
| 47 | + |
| 48 | +```csharp |
| 49 | +var response = await chatClient.CompleteAsync( |
| 50 | + "Translate the following text into Pig Latin: I love .NET and AI"); |
| 51 | + |
| 52 | +Console.WriteLine(response.Message); |
| 53 | +``` |
| 54 | + |
| 55 | +These abstractions allow for idiomatic C# code for various scenarios with minimal code changes, whether you're using different services for development and production, addressing hybrid scenarios, or exploring other service providers. |
| 56 | + |
| 57 | +Library authors who implement these abstractions make their clients interoperable with the broader `Microsoft.Extensions.AI` ecosystem. Service-specific APIs remain accessible if needed, allowing consumers to code against the standard abstractions and pass through to proprietary APIs only when required. |
| 58 | + |
| 59 | +`Microsoft.Extensions.AI` provides implementations for the following services through additional packages: |
| 60 | + |
| 61 | +- [OpenAI](https://aka.ms/meai-openai-nuget) |
| 62 | +- [Azure OpenAI](https://aka.ms/meai-openai-nuget) |
| 63 | +- [Azure AI Inference](https://aka.ms/meai-azaiinference-nuget) |
| 64 | +- [Ollama](https://aka.ms/meai-ollama-nuget) |
| 65 | + |
| 66 | +In the future, implementations of these `Microsoft.Extensions.AI` abstractions will be part of the respective client libraries rather than requiring installation of additional packages. |
| 67 | + |
| 68 | +## Middleware implementations for AI services |
| 69 | + |
| 70 | +Connecting to and using AI services is just one aspect of building robust applications. Production-ready applications require additional features like telemetry, logging, and tool calling capabilities. The `Microsoft.Extensions.AI` abstractions enable you to easily integrate these components into your applications using familiar patterns. |
| 71 | + |
| 72 | +The following sample demonstrates how to register an OpenAI `IChatClient`. `IChatClient` allows you to attach the capabilities in a consistent way across various providers. |
| 73 | + |
| 74 | +```csharp |
| 75 | +app.Services.AddChatClient(builder => builder |
| 76 | + .UseLogging() |
| 77 | + .UseFunctionInvocation() |
| 78 | + .UseDistributedCache() |
| 79 | + .UseOpenTelemetry() |
| 80 | + .Use(new OpenAIClient(...)).AsChatClient(...)); |
| 81 | +``` |
| 82 | + |
| 83 | +The capabilities demonstrated in this snippet are included in the `Microsoft.Extensions.AI` library, but they are only a small subset of the capabilities that can be layered in with this approach. .NET developers are able to expose many types of middleware to create powerful AI functionality. |
| 84 | + |
| 85 | +## Build with Microsoft.Extensions.AI |
| 86 | + |
| 87 | +You can start building with `Microsoft.Extensions.AI` in the following ways: |
| 88 | + |
| 89 | +- **Library Developers**: If you own libraries that provide clients for AI services, consider implementing the interfaces in your libraries. This allows users to easily integrate your NuGet package via the abstractions. |
| 90 | +- **Service Consumers**: If you're developing libraries that consume AI services, use the abstractions instead of hardcoding to a specific AI service. This approach gives your consumers the flexibility to choose their preferred service. |
| 91 | +- **Application Developers**: Use the abstractions to simplify integration into your apps. This enables portability across models and services, facilitates testing and mocking, leverages middleware provided by the ecosystem, and maintains a consistent API throughout your app, even if you use different services in different parts of your application. |
| 92 | +- **Ecosystem Contributors**: If you're interested in contributing to the ecosystem, consider writing custom middleware components. |
| 93 | +To get started, see the samples in the [dotnet/ai-samples](https://aka.ms/meai-samples) GitHub repository. |
| 94 | + |
| 95 | +For an end-to-end sample using `Microsoft.Extensions.AI`, see [eShopSupport](https://github.com/dotnet/eShopSupport). |
| 96 | + |
| 97 | +## Next steps |
| 98 | + |
| 99 | +- [Build an AI chat app with .NET](./quickstarts/get-started-openai.md) |
| 100 | +- [Quickstart - Summarize text using Azure AI chat app with .NET](./quickstarts/quickstart-openai-summarize-text.md) |
![dotnet-policy-service[bot]](https://avatars.githubusercontent.com/in/285228?v=4&size=40){kind=avatar}
0 commit comments