kvandijk.AI
1.1.0
dotnet add package kvandijk.AI --version 1.1.0
NuGet\Install-Package kvandijk.AI -Version 1.1.0
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="kvandijk.AI" Version="1.1.0" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
<PackageVersion Include="kvandijk.AI" Version="1.1.0" />
<PackageReference Include="kvandijk.AI" />
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 kvandijk.AI --version 1.1.0
The NuGet Team does not provide support for this client. Please contact its maintainers for support.
#r "nuget: kvandijk.AI, 1.1.0"
#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 kvandijk.AI@1.1.0
#: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=kvandijk.AI&version=1.1.0
#tool nuget:?package=kvandijk.AI&version=1.1.0
The NuGet Team does not provide support for this client. Please contact its maintainers for support.
A utilities and services package for OpenAI in .NET (streaming, structured, etc.).
Installing the package
Install the package using the following command:
dotnet add package kvandijk.AI
Setup
Environment variables
Create a deployment in Azure OpenAI and set the following environment variables in your development environment or hosting platform:
OPENAI_ENDPOINT: Your OpenAI endpoint URL.OPENAI_DEPLOYMENT: Your deployment name for the OpenAI model.OPENAI_EMBEDDING_DEPLOYMENT: Your deployment name for the OpenAI embedding model.OPENAI_KEY: Your OpenAI API key.
Program.cs
Add the following line to your Program.cs file to register the completion service:
builder.Services.AddCompletionService();
How to use
Example streaming completion
await foreach (var chunk in service.GetCompletionStreamAsync("Write a short story of 100 words."))
{
Console.Write(chunk);
}
Example structured completion
var typed = await service.GetStructuredCompletionAsync<ClassificationResult>(""""
Categorise: 'Invoice from Contoso for Q3 services'.
Categories: invoice, receipt, contract, other. Include 1-3 short reasons.Return as JSON.
"""");
Console.WriteLine(System.Text.Json.JsonSerializer.Serialize(typed, new System.Text.Json.JsonSerializerOptions { WriteIndented = true }));
| Product | Versions Compatible and additional computed target framework versions. |
|---|---|
| .NET | net8.0 is compatible. net8.0-android was computed. net8.0-browser was computed. net8.0-ios was computed. net8.0-maccatalyst was computed. net8.0-macos was computed. net8.0-tvos was computed. net8.0-windows was computed. net9.0 is compatible. net9.0-android was computed. net9.0-browser was computed. net9.0-ios was computed. net9.0-maccatalyst was computed. net9.0-macos was computed. net9.0-tvos was computed. net9.0-windows was computed. net10.0 is compatible. net10.0-android was computed. net10.0-browser was computed. net10.0-ios was computed. net10.0-maccatalyst was computed. net10.0-macos was computed. net10.0-tvos 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.
-
net10.0
- Azure.Core (>= 1.50.0)
- NJsonSchema (>= 11.5.2)
- OpenAI (>= 2.7.0)
-
net8.0
- Azure.Core (>= 1.50.0)
- NJsonSchema (>= 11.5.2)
- OpenAI (>= 2.7.0)
-
net9.0
- Azure.Core (>= 1.50.0)
- NJsonSchema (>= 11.5.2)
- OpenAI (>= 2.7.0)
NuGet packages
This package is not used by any NuGet packages.
GitHub repositories
This package is not used by any popular GitHub repositories.