Microsoft.AI.Foundry.Local.WinML
0.8.2.1
Prefix Reserved
dotnet add package Microsoft.AI.Foundry.Local.WinML --version 0.8.2.1
NuGet\Install-Package Microsoft.AI.Foundry.Local.WinML -Version 0.8.2.1
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="Microsoft.AI.Foundry.Local.WinML" Version="0.8.2.1" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
<PackageVersion Include="Microsoft.AI.Foundry.Local.WinML" Version="0.8.2.1" />
<PackageReference Include="Microsoft.AI.Foundry.Local.WinML" />
For projects that support Central Package Management (CPM), copy this XML node into the solution Directory.Packages.props file to version the package.
paket add Microsoft.AI.Foundry.Local.WinML --version 0.8.2.1
The NuGet Team does not provide support for this client. Please contact its maintainers for support.
#r "nuget: Microsoft.AI.Foundry.Local.WinML, 0.8.2.1"
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.
#:package Microsoft.AI.Foundry.Local.WinML@0.8.2.1
#:package directive can be used in C# file-based apps starting in .NET 10 preview 4. Copy this into a .cs file before any lines of code to reference the package.
#addin nuget:?package=Microsoft.AI.Foundry.Local.WinML&version=0.8.2.1
#tool nuget:?package=Microsoft.AI.Foundry.Local.WinML&version=0.8.2.1
The NuGet Team does not provide support for this client. Please contact its maintainers for support.
Foundry Local C# SDK
Installation
To use the Foundry Local C# SDK, you need to install the NuGet package:
dotnet add package Microsoft.AI.Foundry.Local
Building from source
To build the SDK, run the following command in your terminal:
cd sdk/cs
dotnet build
You can also load FoundryLocal.sln in Visual Studio 2022 or VSCode. Update your
nuget.config to include the local path to the generated NuGet package:
<configuration>
<packageSources>
<add key="foundry-local" value="C:\path\to\foundry-local\sdk\cs\bin\Debug" />
</packageSources>
</configuration>
Then, install the package using the following command:
dotnet add package FoundryLocal --source foundry-local
Usage
For this example, you'll need the OpenAI Nuget package installed as well:
dotnet add package OpenAI
using Microsoft.AI.Foundry.Local;
using OpenAI;
using OpenAI.Chat;
using System.ClientModel;
using System.Diagnostics.Metrics;
var alias = "phi-3.5-mini";
var manager = await FoundryLocalManager.StartModelAsync(aliasOrModelId: alias);
var model = await manager.GetModelInfoAsync(aliasOrModelId: alias);
ApiKeyCredential key = new ApiKeyCredential(manager.ApiKey);
OpenAIClient client = new OpenAIClient(key, new OpenAIClientOptions
{
Endpoint = manager.Endpoint
});
var chatClient = client.GetChatClient(model?.ModelId);
var completionUpdates = chatClient.CompleteChatStreaming("Why is the sky blue'");
Console.Write($"[ASSISTANT]: ");
foreach (var completionUpdate in completionUpdates)
{
if (completionUpdate.ContentUpdate.Count > 0)
{
Console.Write(completionUpdate.ContentUpdate[0].Text);
}
}
| Product | Versions Compatible and additional computed target framework versions. |
|---|---|
| .NET | net8.0-windows10.0.26100 is compatible. net9.0-windows was computed. net10.0-windows was computed. |
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.
-
net8.0-windows10.0.26100
- Betalgo.Ranul.OpenAI (>= 9.1.0)
- IDisposableAnalyzers (>= 4.0.8)
- Microsoft.AI.Foundry.Local.Core.WinML (>= 0.8.2.2)
- Microsoft.Extensions.Logging (>= 9.0.9)
NuGet packages
This package is not used by any NuGet packages.
GitHub repositories
This package is not used by any popular GitHub repositories.