Encamina.Enmarcha.AI.OpenAI.Azure
8.1.5-preview-03
This is a prerelease version of Encamina.Enmarcha.AI.OpenAI.Azure.
There is a newer version of this package available.
See the version list below for details.
See the version list below for details.
dotnet add package Encamina.Enmarcha.AI.OpenAI.Azure --version 8.1.5-preview-03
NuGet\Install-Package Encamina.Enmarcha.AI.OpenAI.Azure -Version 8.1.5-preview-03
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="Encamina.Enmarcha.AI.OpenAI.Azure" Version="8.1.5-preview-03" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add Encamina.Enmarcha.AI.OpenAI.Azure --version 8.1.5-preview-03
The NuGet Team does not provide support for this client. Please contact its maintainers for support.
#r "nuget: Encamina.Enmarcha.AI.OpenAI.Azure, 8.1.5-preview-03"
#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.
// Install Encamina.Enmarcha.AI.OpenAI.Azure as a Cake Addin #addin nuget:?package=Encamina.Enmarcha.AI.OpenAI.Azure&version=8.1.5-preview-03&prerelease // Install Encamina.Enmarcha.AI.OpenAI.Azure as a Cake Tool #tool nuget:?package=Encamina.Enmarcha.AI.OpenAI.Azure&version=8.1.5-preview-03&prerelease
The NuGet Team does not provide support for this client. Please contact its maintainers for support.
AI - Azure OpenAI
This project focuses on making it easier to use Azure OpenAI services to utilize the completion service.
Setup
Nuget package
First, install NuGet. Then, install Encamina.Enmarcha.AI.OpenAI.Azure from the package manager console:
PM> Install-Package Encamina.Enmarcha.AI.OpenAI.Azure
.NET CLI:
First, install .NET CLI. Then, install Encamina.Enmarcha.AI.OpenAI.Azure from the .NET CLI:
dotnet add package Encamina.Enmarcha.AI.OpenAI.Azure
How to use
First, you need to add the CompletionServiceOptions to your project configuration. You can achieve this by using any configuration provider. The followng code is an example of how the settings would appear using the appsettings.json file:
{
// ...
"CompletionServiceOptions": {
"DeploymentName": "<YOUR-COMPLETION-MODEL-NAME>", // Name of the deployed model to use with this completion service
"Name": "completion-service-test", // Name of this completion service
"EndpointUrl": "<YOUR-AZURE-OPEN-AI-ENDPOINT>", // /Azure OpenAI endpoint's url
"KeyCredential": "<YOUR-AZURE-API-KEY>" // Azure OpenAI (security) key
}
// ...
}
Next, in Program.cs or a similar entry point file in your project, add the following code.
// Entry point
var builder = WebApplication.CreateBuilder(new WebApplicationOptions
{
// ...
});
// ...
// Or others configuration providers...
builder.Configuration.AddJsonFile(@"appsettings.json", optional: true, reloadOnChange: true);
builder.Services.AddAzureOpenAICompletionService(builder.Configuration);
The AddAzureOpenAICompletionService extension method will add the default implementation of the ICompletionService interface as Transient. The default implementation is CompletionService. With this, we can resolve the ICompletionService with construction injection.
public class MyClass
{
private readonly ICompletionService completionService;
public MyClass(ICompletionService completionService)
{
this.completionService = completionService;
}
public async Task TestCompletionAsync()
{
var completionResult = await completionService.CompleteAsync(new CompletionRequest()
{
DoEcho = null,
BestOf = null,
Prompts = new List<string> { "Console.WriteL" },
StopSequences = Enumerable.Empty<string>(),
NumberOfCompletionsPerPrompt = 1,
Temperature = 0,
MaxTokens = 20
}, CancellationToken.None);
var firstResult = completionResult.Completitions.First().Text;
}
}
Within firstResult, you will find texts that say something like Ine("Hello World");.
| Product | Versions Compatible and additional computed target framework versions. |
|---|---|
| .NET | net5.0 was computed. net5.0-windows was computed. net6.0 was computed. net6.0-android was computed. net6.0-ios was computed. net6.0-maccatalyst was computed. net6.0-macos was computed. net6.0-tvos was computed. net6.0-windows was computed. net7.0 was computed. net7.0-android was computed. net7.0-ios was computed. net7.0-maccatalyst was computed. net7.0-macos was computed. net7.0-tvos was computed. net7.0-windows was computed. net8.0 was computed. 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. |
| .NET Core | netcoreapp3.0 was computed. netcoreapp3.1 was computed. |
| .NET Standard | netstandard2.1 is compatible. |
| MonoAndroid | monoandroid was computed. |
| MonoMac | monomac was computed. |
| MonoTouch | monotouch was computed. |
| Tizen | tizen60 was computed. |
| Xamarin.iOS | xamarinios was computed. |
| Xamarin.Mac | xamarinmac was computed. |
| Xamarin.TVOS | xamarintvos was computed. |
| Xamarin.WatchOS | xamarinwatchos was computed. |
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.
-
.NETStandard 2.1
- Azure.AI.OpenAI (>= 1.0.0-beta.14)
- CommunityToolkit.Diagnostics (>= 8.2.2)
- Encamina.Enmarcha.AI.OpenAI.Abstractions (>= 8.1.5-preview-03)
- Encamina.Enmarcha.Core (>= 8.1.5-preview-03)
- Encamina.Enmarcha.Entities (>= 8.1.5-preview-03)
- Microsoft.Extensions.Azure (>= 1.7.2)
- Microsoft.Extensions.Hosting (>= 8.0.0)
- Microsoft.Extensions.Options (>= 8.0.2)
- Microsoft.Extensions.Options.DataAnnotations (>= 8.0.0)
- System.ComponentModel.Annotations (>= 5.0.0)
NuGet packages (3)
Showing the top 3 NuGet packages that depend on Encamina.Enmarcha.AI.OpenAI.Azure:
| Package | Downloads |
|---|---|
|
Encamina.Enmarcha.SemanticKernel.Plugins.Chat
Package Description |
|
|
Encamina.Enmarcha.SemanticKernel.Connectors.Memory
Package Description |
|
|
Encamina.Enmarcha.SemanticKernel.Plugins.QuestionAnswering
Package Description |
GitHub repositories
This package is not used by any popular GitHub repositories.
| Version | Downloads | Last updated |
|---|---|---|
| 8.2.0 | 482 | 10/22/2024 |
| 8.2.0-preview-01-m01 | 99 | 9/17/2024 |
| 8.1.9-preview-03 | 57 | 11/19/2024 |
| 8.1.9-preview-02 | 62 | 10/22/2024 |
| 8.1.9-preview-01 | 372 | 10/4/2024 |
| 8.1.8 | 790 | 9/23/2024 |
| 8.1.8-preview-07 | 630 | 9/12/2024 |
| 8.1.8-preview-06 | 286 | 9/11/2024 |
| 8.1.8-preview-05 | 86 | 9/10/2024 |
| 8.1.8-preview-04 | 496 | 8/16/2024 |
| 8.1.8-preview-03 | 189 | 8/13/2024 |
| 8.1.8-preview-02 | 90 | 8/13/2024 |
| 8.1.8-preview-01 | 103 | 8/12/2024 |
| 8.1.7 | 100 | 8/7/2024 |
| 8.1.7-preview-09 | 210 | 7/3/2024 |
| 8.1.7-preview-08 | 84 | 7/2/2024 |
| 8.1.7-preview-07 | 87 | 6/10/2024 |
| 8.1.7-preview-06 | 80 | 6/10/2024 |
| 8.1.7-preview-05 | 102 | 6/6/2024 |
| 8.1.7-preview-04 | 86 | 6/6/2024 |
| 8.1.7-preview-03 | 88 | 5/24/2024 |
| 8.1.7-preview-02 | 84 | 5/10/2024 |
| 8.1.7-preview-01 | 112 | 5/8/2024 |
| 8.1.6 | 1,367 | 5/7/2024 |
| 8.1.6-preview-08 | 66 | 5/2/2024 |
| 8.1.6-preview-07 | 79 | 4/29/2024 |
| 8.1.6-preview-06 | 675 | 4/26/2024 |
| 8.1.6-preview-05 | 89 | 4/24/2024 |
| 8.1.6-preview-04 | 130 | 4/22/2024 |
| 8.1.6-preview-03 | 85 | 4/22/2024 |
| 8.1.6-preview-02 | 167 | 4/17/2024 |
| 8.1.6-preview-01 | 184 | 4/15/2024 |
| 8.1.5 | 125 | 4/15/2024 |
| 8.1.5-preview-15 | 104 | 4/10/2024 |
| 8.1.5-preview-14 | 126 | 3/20/2024 |
| 8.1.5-preview-13 | 77 | 3/18/2024 |
| 8.1.5-preview-12 | 109 | 3/13/2024 |
| 8.1.5-preview-11 | 87 | 3/13/2024 |
| 8.1.5-preview-10 | 121 | 3/13/2024 |
| 8.1.5-preview-09 | 91 | 3/12/2024 |
| 8.1.5-preview-08 | 81 | 3/12/2024 |
| 8.1.5-preview-07 | 92 | 3/8/2024 |
| 8.1.5-preview-06 | 397 | 3/8/2024 |
| 8.1.5-preview-05 | 94 | 3/7/2024 |
| 8.1.5-preview-04 | 93 | 3/7/2024 |
| 8.1.5-preview-03 | 87 | 3/7/2024 |
| 8.1.5-preview-02 | 226 | 2/28/2024 |
| 8.1.5-preview-01 | 181 | 2/19/2024 |
| 8.1.4 | 330 | 2/15/2024 |
| 8.1.3 | 116 | 2/13/2024 |
| 8.1.3-preview-07 | 75 | 2/13/2024 |
| 8.1.3-preview-06 | 96 | 2/12/2024 |
| 8.1.3-preview-05 | 103 | 2/9/2024 |
| 8.1.3-preview-04 | 88 | 2/8/2024 |
| 8.1.3-preview-03 | 84 | 2/7/2024 |
| 8.1.3-preview-02 | 98 | 2/2/2024 |
| 8.1.3-preview-01 | 93 | 2/2/2024 |
| 8.1.2 | 151 | 2/1/2024 |
| 8.1.2-preview-9 | 101 | 1/22/2024 |
| 8.1.2-preview-8 | 91 | 1/19/2024 |
| 8.1.2-preview-7 | 85 | 1/19/2024 |
| 8.1.2-preview-6 | 83 | 1/19/2024 |
| 8.1.2-preview-5 | 89 | 1/19/2024 |
| 8.1.2-preview-4 | 84 | 1/19/2024 |
| 8.1.2-preview-3 | 83 | 1/18/2024 |
| 8.1.2-preview-2 | 99 | 1/18/2024 |
| 8.1.2-preview-16 | 90 | 1/31/2024 |
| 8.1.2-preview-15 | 88 | 1/31/2024 |
| 8.1.2-preview-14 | 230 | 1/25/2024 |
| 8.1.2-preview-13 | 96 | 1/25/2024 |
| 8.1.2-preview-12 | 91 | 1/23/2024 |
| 8.1.2-preview-11 | 89 | 1/23/2024 |
| 8.1.2-preview-10 | 91 | 1/22/2024 |
| 8.1.2-preview-1 | 83 | 1/18/2024 |
| 8.1.1 | 138 | 1/18/2024 |
| 8.1.0 | 99 | 1/18/2024 |
| 8.0.3 | 120 | 12/29/2023 |
| 8.0.1 | 101 | 12/14/2023 |
| 8.0.0 | 93 | 12/7/2023 |
| 6.0.4.3 | 86 | 12/29/2023 |
| 6.0.4.2 | 74 | 12/20/2023 |
| 6.0.4.1 | 81 | 12/19/2023 |
| 6.0.4 | 85 | 12/4/2023 |
| 6.0.3.20 | 85 | 11/27/2023 |
| 6.0.3.19 | 88 | 11/22/2023 |