Encamina.Enmarcha.AI.IntentsPrediction.Azure 8.1.8-preview-05

This is a prerelease version of Encamina.Enmarcha.AI.IntentsPrediction.Azure.
There is a newer version of this package available.
See the version list below for details.
dotnet add package Encamina.Enmarcha.AI.IntentsPrediction.Azure --version 8.1.8-preview-05                
NuGet\Install-Package Encamina.Enmarcha.AI.IntentsPrediction.Azure -Version 8.1.8-preview-05                
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.IntentsPrediction.Azure" Version="8.1.8-preview-05" />                
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add Encamina.Enmarcha.AI.IntentsPrediction.Azure --version 8.1.8-preview-05                
#r "nuget: Encamina.Enmarcha.AI.IntentsPrediction.Azure, 8.1.8-preview-05"                
#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.IntentsPrediction.Azure as a Cake Addin
#addin nuget:?package=Encamina.Enmarcha.AI.IntentsPrediction.Azure&version=8.1.8-preview-05&prerelease

// Install Encamina.Enmarcha.AI.IntentsPrediction.Azure as a Cake Tool
#tool nuget:?package=Encamina.Enmarcha.AI.IntentsPrediction.Azure&version=8.1.8-preview-05&prerelease                

AI - Azure Intent Prediction

Nuget package

Azure Intent Prediction is a wrapper project for Azure Cognitive Language Services Conversations client library. Its main functionality is to simplify and abstract the usage of the library, primarily focused on intention detection.

Setup

Nuget package

First, install NuGet. Then, install Encamina.Enmarcha.AI.IntentsPrediction.Azure from the package manager console:

PM> Install-Package Encamina.Enmarcha.AI.IntentsPrediction.Azure

.NET CLI:

Install .NET CLI. Next, install Encamina.Enmarcha.AI.IntentsPrediction.Azure from the .NET CLI:

dotnet add package Encamina.Enmarcha.AI.IntentsPrediction.Azure

How to use

First, you need to add the IntentPredictionConfigurations to your project configuration. You can achieve this by using any configuration provider. The following code is an example of how the settings should be set up using the appsettings.json file:

  {
    // ...
    "IntentPredictionConfigurations": {    
      "IntentPredictionOptions": [
        {
          "Name": "DefaultIntentPrediction", // Name of this configuration
          "EndpointUrl": "https://example.cognitiveservices.azure.com/", // Language Service endpoint's url
          "KeyCredential": "<API-KEY>", // Language Service (security) key
          "DeploymentSlot": "development", // Deployment type, allowing the 'test' and 'prod' ('production' works as well)
          "OrchestratorName": "<ORCHESTRATOR-NAME>", // The name of the Orchestrator to use as intent prediction service from Azure
          "EnableLogging": true, // A flag to indicate whether logging is enabled
          "EnableVerbose": false, // A flag to indicate whether verbose mode is enabled
          "ConfidenceThreshold": 0.65 // Minimum threshold score for answers, value ranges from 0 to 1
        }
      ]
    },
    // ...
  }

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.AddDefaultCognitiveServiceProvider()
                .AddAzureIntentPredictionServices(builder.Configuration);

The extension methods AddDefaultCognitiveServiceProvider and AddAzureIntentPredictionServices manage the configuration to create instances of ICognitiveServiceProvider. With this, you can retrieve instances of IIntentPredictionService (whose implementation is IntentPredictionService). As seen in the appsettings.json, IntentPredictionConfigurations is an array, which allows you to generate different Intent Prediction configurations and retrieve information based on the Name parameter. You can inject ICognitiveServiceProvider through the constructor.

public class MyClass
{
    private readonly IIntentPredictionService intentPredictionService;

    public MyClass(ICognitiveServiceProvider cognitiveServiceProvider)
    {
        // The value "DefaultIntentPrediction" is the name specified in the JSON from the previous code.
        // This is just an example code; avoid hardcoding strings :)
        intentPredictionService = cognitiveServiceProvider.GetIntentPredictionService("DefaultIntentPrediction");
    }

    public async Task<string> GetIntentAsync(string userInput, CancellationToken cancellationToken)
    {
        var intentPredictionRequest = new IntentPredictionRequest()
        {
            IntentPredictionOptions = new IntentPredictionOptions() { Language = CultureInfo.CurrentCulture },
            Utterance = userInput
        };

        var intentPredictionResult = await intentPredictionService.PredictIntentAsync(intentPredictionRequest, cancellationToken);

        return intentPredictionResult.IntentPrediction?.TopIntentName;
    }
}
Product 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.

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last updated
8.2.0 71 10/22/2024
8.2.0-preview-01-m01 104 9/17/2024
8.1.9-preview-03 56 11/19/2024
8.1.9-preview-02 61 10/22/2024
8.1.9-preview-01 70 10/4/2024
8.1.8 84 9/23/2024
8.1.8-preview-07 82 9/12/2024
8.1.8-preview-06 92 9/11/2024
8.1.8-preview-05 83 9/10/2024
8.1.8-preview-04 96 8/16/2024
8.1.8-preview-03 105 8/13/2024
8.1.8-preview-02 99 8/13/2024
8.1.8-preview-01 100 8/12/2024
8.1.7 100 8/7/2024
8.1.7-preview-09 73 7/3/2024
8.1.7-preview-08 82 7/2/2024
8.1.7-preview-07 80 6/10/2024
8.1.7-preview-06 83 6/10/2024
8.1.7-preview-05 86 6/6/2024
8.1.7-preview-04 86 6/6/2024
8.1.7-preview-03 85 5/24/2024
8.1.7-preview-02 72 5/10/2024
8.1.7-preview-01 81 5/8/2024
8.1.6 1,272 5/7/2024
8.1.6-preview-08 56 5/2/2024
8.1.6-preview-07 101 4/29/2024
8.1.6-preview-06 106 4/26/2024
8.1.6-preview-05 127 4/24/2024
8.1.6-preview-04 88 4/22/2024
8.1.6-preview-03 90 4/22/2024
8.1.6-preview-02 95 4/17/2024
8.1.6-preview-01 176 4/15/2024
8.1.5 123 4/15/2024
8.1.5-preview-15 109 4/10/2024
8.1.5-preview-14 106 3/20/2024
8.1.5-preview-13 90 3/18/2024
8.1.5-preview-12 108 3/13/2024
8.1.5-preview-11 98 3/13/2024
8.1.5-preview-10 102 3/13/2024
8.1.5-preview-09 102 3/12/2024
8.1.5-preview-08 97 3/12/2024
8.1.5-preview-07 98 3/8/2024
8.1.5-preview-06 91 3/8/2024
8.1.5-preview-05 103 3/7/2024
8.1.5-preview-04 93 3/7/2024
8.1.5-preview-03 91 3/7/2024
8.1.5-preview-02 103 2/28/2024
8.1.5-preview-01 92 2/19/2024
8.1.4 163 2/15/2024
8.1.3 119 2/13/2024
8.1.3-preview-07 96 2/13/2024
8.1.3-preview-06 94 2/12/2024
8.1.3-preview-05 94 2/9/2024
8.1.3-preview-04 99 2/8/2024
8.1.3-preview-03 90 2/7/2024
8.1.3-preview-02 91 2/2/2024
8.1.3-preview-01 91 2/2/2024
8.1.2 125 2/1/2024
8.1.2-preview-9 103 1/22/2024
8.1.2-preview-8 91 1/19/2024
8.1.2-preview-7 82 1/19/2024
8.1.2-preview-6 83 1/19/2024
8.1.2-preview-5 90 1/19/2024
8.1.2-preview-4 93 1/19/2024
8.1.2-preview-3 88 1/18/2024
8.1.2-preview-2 88 1/18/2024
8.1.2-preview-16 90 1/31/2024
8.1.2-preview-15 97 1/31/2024
8.1.2-preview-14 89 1/25/2024
8.1.2-preview-13 86 1/25/2024
8.1.2-preview-12 85 1/23/2024
8.1.2-preview-11 85 1/23/2024
8.1.2-preview-10 87 1/22/2024
8.1.2-preview-1 84 1/18/2024
8.1.1 135 1/18/2024
8.1.0 117 1/18/2024
8.0.3 164 12/29/2023
8.0.1 151 12/14/2023
8.0.0 152 12/7/2023
6.0.4.3 144 12/29/2023
6.0.4.2 118 12/20/2023
6.0.4.1 186 12/19/2023
6.0.4 161 12/4/2023
6.0.3.20 141 11/27/2023
6.0.3.19 154 11/22/2023